optimized SHOWLMP code (only used by Nehahra) to not eat any CPU time
[divverent/darkplaces.git] / render.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20
21 #ifndef RENDER_H
22 #define RENDER_H
23
24 #include "svbsp.h"
25
26 // 1.0f / N table
27 extern float ixtable[4096];
28
29 // fog stuff
30 extern void FOG_clear(void);
31
32 // sky stuff
33 extern cvar_t r_sky;
34 extern cvar_t r_skyscroll1;
35 extern cvar_t r_skyscroll2;
36 extern int skyrendernow, skyrendermasked;
37 extern int R_SetSkyBox(const char *sky);
38 extern void R_SkyStartFrame(void);
39 extern void R_Sky(void);
40 extern void R_ResetSkyBox(void);
41
42 // SHOWLMP stuff (Nehahra)
43 extern void SHOWLMP_decodehide(void);
44 extern void SHOWLMP_decodeshow(void);
45 extern void SHOWLMP_drawall(void);
46
47 // render profiling stuff
48 extern char r_speeds_string[1024];
49 extern int r_timereport_active;
50
51 // lighting stuff
52 extern cvar_t r_ambient;
53 extern cvar_t gl_flashblend;
54
55 // vis stuff
56 extern cvar_t r_novis;
57
58 extern cvar_t r_lerpsprites;
59 extern cvar_t r_lerpmodels;
60 extern cvar_t r_waterscroll;
61
62 extern cvar_t developer_texturelogging;
63
64 // shadow volume bsp struct with automatically growing nodes buffer
65 extern svbsp_t r_svbsp;
66
67 typedef struct rmesh_s
68 {
69         // vertices of this mesh
70         int maxvertices;
71         int numvertices;
72         float *vertex3f;
73         float *svector3f;
74         float *tvector3f;
75         float *normal3f;
76         float *texcoord2f;
77         float *texcoordlightmap2f;
78         float *color4f;
79         // triangles of this mesh
80         int maxtriangles;
81         int numtriangles;
82         int *element3i;
83         int *neighbor3i;
84         // snapping epsilon
85         float epsilon2;
86 }
87 rmesh_t;
88
89 // useful functions for rendering
90 void R_ModulateColors(float *in, float *out, int verts, float r, float g, float b);
91 void R_FillColors(float *out, int verts, float r, float g, float b, float a);
92 int R_Mesh_AddVertex3f(rmesh_t *mesh, const float *v);
93 void R_Mesh_AddPolygon3f(rmesh_t *mesh, int numvertices, float *vertex3f);
94 void R_Mesh_AddBrushMeshFromPlanes(rmesh_t *mesh, int numplanes, mplane_t *planes);
95
96 #define TOP_RANGE               16                      // soldier uniform colors
97 #define BOTTOM_RANGE    96
98
99 //=============================================================================
100
101 extern cvar_t r_nearclip;
102
103 // forces all rendering to draw triangle outlines
104 extern cvar_t r_showtris;
105 extern cvar_t r_shownormals;
106 extern cvar_t r_showlighting;
107 extern cvar_t r_showshadowvolumes;
108 extern cvar_t r_showcollisionbrushes;
109 extern cvar_t r_showcollisionbrushes_polygonfactor;
110 extern cvar_t r_showcollisionbrushes_polygonoffset;
111 extern cvar_t r_showdisabledepthtest;
112
113 //
114 // view origin
115 //
116 extern cvar_t r_drawentities;
117 extern cvar_t r_drawviewmodel;
118 extern cvar_t r_speeds;
119 extern cvar_t r_fullbright;
120 extern cvar_t r_wateralpha;
121 extern cvar_t r_dynamic;
122
123 void R_Init(void);
124 void R_UpdateVariables(void); // must call after setting up most of r_refdef, but before calling R_RenderView
125 void R_RenderView(void); // must set r_refdef and call R_UpdateVariables first
126
127
128 void R_InitSky (unsigned char *src, int bytesperpixel); // called at level load
129
130 void R_SkinFrame_PrepareForPurge(void);
131 void R_SkinFrame_MarkUsed(skinframe_t *skinframe);
132 void R_SkinFrame_Purge(void);
133 skinframe_t *R_SkinFrame_Find(const char *name, int textureflags, int comparewidth, int compareheight, int comparecrc, qboolean add);
134 skinframe_t *R_SkinFrame_LoadExternal(const char *name, int textureflags, qboolean complain);
135 skinframe_t *R_SkinFrame_LoadInternal(const char *name, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height, int bitsperpixel, const unsigned int *palette, const unsigned int *alphapalette);
136 skinframe_t *R_SkinFrame_LoadMissing(void);
137
138 void R_View_WorldVisibility(qboolean forcenovis);
139 void R_DrawParticles(void);
140 void R_DrawExplosions(void);
141
142 #define gl_solid_format 3
143 #define gl_alpha_format 4
144
145 int R_CullBox(const vec3_t mins, const vec3_t maxs);
146 int R_CullBoxCustomPlanes(const vec3_t mins, const vec3_t maxs, int numplanes, const mplane_t *planes);
147
148 #include "r_modules.h"
149
150 #include "meshqueue.h"
151
152 #include "r_lerpanim.h"
153
154 extern cvar_t r_render;
155 extern cvar_t r_waterwarp;
156
157 extern cvar_t r_textureunits;
158 extern cvar_t r_glsl;
159 extern cvar_t r_glsl_offsetmapping;
160 extern cvar_t r_glsl_offsetmapping_reliefmapping;
161 extern cvar_t r_glsl_offsetmapping_scale;
162 extern cvar_t r_glsl_deluxemapping;
163
164 extern cvar_t gl_polyblend;
165 extern cvar_t gl_dither;
166
167 extern cvar_t r_smoothnormals_areaweighting;
168
169 extern cvar_t r_test;
170
171 #include "gl_backend.h"
172
173 #include "r_light.h"
174
175 extern rtexture_t *r_texture_blanknormalmap;
176 extern rtexture_t *r_texture_white;
177 extern rtexture_t *r_texture_grey128;
178 extern rtexture_t *r_texture_black;
179 extern rtexture_t *r_texture_notexture;
180 extern rtexture_t *r_texture_whitecube;
181 extern rtexture_t *r_texture_normalizationcube;
182 extern rtexture_t *r_texture_fogattenuation;
183 //extern rtexture_t *r_texture_fogintensity;
184
185 void R_TimeReport(char *name);
186
187 // r_stain
188 void R_Stain(const vec3_t origin, float radius, int cr1, int cg1, int cb1, int ca1, int cr2, int cg2, int cb2, int ca2);
189
190 void R_CalcBeam_Vertex3f(float *vert, const vec3_t org1, const vec3_t org2, float width);
191 void R_DrawSprite(int blendfunc1, int blendfunc2, rtexture_t *texture, rtexture_t *fogtexture, qboolean depthdisable, qboolean depthshort, const vec3_t origin, const vec3_t left, const vec3_t up, float scalex1, float scalex2, float scaley1, float scaley2, float cr, float cg, float cb, float ca);
192
193 extern mempool_t *r_main_mempool;
194
195 typedef enum rsurfmode_e
196 {
197         RSURFMODE_NONE,
198         RSURFMODE_SHOWSURFACES,
199         RSURFMODE_SKY,
200         RSURFMODE_MULTIPASS,
201         RSURFMODE_GLSL
202 }
203 rsurfmode_t;
204
205 typedef struct rsurfacestate_s
206 {
207         // processing buffers
208         int array_size;
209         float *array_modelvertex3f;
210         float *array_modelsvector3f;
211         float *array_modeltvector3f;
212         float *array_modelnormal3f;
213         float *array_deformedvertex3f;
214         float *array_deformedsvector3f;
215         float *array_deformedtvector3f;
216         float *array_deformednormal3f;
217         float *array_generatedtexcoordtexture2f;
218         float *array_color4f;
219         float *array_texcoord3f;
220
221         // current model array pointers
222         // these may point to processing buffers if model is animated,
223         // otherwise they point to static data.
224         // these are not directly used for rendering, they are just another level
225         // of processing
226         //
227         // these either point at array_model* buffers (if the model is animated)
228         // or the model->surfmesh.data_* buffers (if the model is not animated)
229         //
230         // these are only set when an entity render begins, they do not change on
231         // a per surface basis.
232         //
233         // this indicates the model* arrays are pointed at array_model* buffers
234         // (in other words, the model has been animated in software)
235         qboolean generatedvertex;
236         float *modelvertex3f;
237         int modelvertex3f_bufferobject;
238         size_t modelvertex3f_bufferoffset;
239         float *modelsvector3f;
240         int modelsvector3f_bufferobject;
241         size_t modelsvector3f_bufferoffset;
242         float *modeltvector3f;
243         int modeltvector3f_bufferobject;
244         size_t modeltvector3f_bufferoffset;
245         float *modelnormal3f;
246         int modelnormal3f_bufferobject;
247         size_t modelnormal3f_bufferoffset;
248         float *modellightmapcolor4f;
249         int modellightmapcolor4f_bufferobject;
250         size_t modellightmapcolor4f_bufferoffset;
251         float *modeltexcoordtexture2f;
252         int modeltexcoordtexture2f_bufferobject;
253         size_t modeltexcoordtexture2f_bufferoffset;
254         float *modeltexcoordlightmap2f;
255         int modeltexcoordlightmap2f_bufferobject;
256         size_t modeltexcoordlightmap2f_bufferoffset;
257         int *modelelement3i;
258         int modelelement3i_bufferobject;
259         int *modellightmapoffsets;
260         int modelnum_vertices;
261         int modelnum_triangles;
262         msurface_t *modelsurfaces;
263         // current rendering array pointers
264         // these may point to any of several different buffers depending on how
265         // much processing was needed to prepare this model for rendering
266         // these usually equal the model* pointers, they only differ if
267         // deformvertexes is used in a q3 shader, and consequently these can
268         // change on a per-surface basis (according to rsurface.texture)
269         //
270         // the exception is the color array which is often generated based on
271         // colormod, alpha fading, and fogging, it may also come from q3bsp vertex
272         // lighting of certain surfaces
273         float *vertex3f;
274         int vertex3f_bufferobject;
275         size_t vertex3f_bufferoffset;
276         float *svector3f;
277         int svector3f_bufferobject;
278         size_t svector3f_bufferoffset;
279         float *tvector3f;
280         int tvector3f_bufferobject;
281         size_t tvector3f_bufferoffset;
282         float *normal3f;
283         int normal3f_bufferobject;
284         size_t normal3f_bufferoffset;
285         float *lightmapcolor4f;
286         int lightmapcolor4f_bufferobject;
287         size_t lightmapcolor4f_bufferoffset;
288         float *texcoordtexture2f;
289         int texcoordtexture2f_bufferobject;
290         size_t texcoordtexture2f_bufferoffset;
291         float *texcoordlightmap2f;
292         int texcoordlightmap2f_bufferobject;
293         size_t texcoordlightmap2f_bufferoffset;
294         // transform matrices to render this entity and effects on this entity
295         matrix4x4_t matrix;
296         matrix4x4_t inversematrix;
297         // animation blending state from entity
298         frameblend_t frameblend[4];
299         // directional model shading state from entity
300         vec3_t modellight_ambient;
301         vec3_t modellight_diffuse;
302         vec3_t modellight_lightdir;
303         // colormapping state from entity (these are black if colormapping is off)
304         vec3_t colormap_pantscolor;
305         vec3_t colormap_shirtcolor;
306         // view location in model space
307         vec3_t modelorg; // TODO: rename this
308         // current texture in batching code
309         texture_t *texture;
310         // whether lightmapping is active on this batch
311         // (otherwise vertex colored)
312         qboolean uselightmaptexture;
313         // one of the RSURFMODE_ values
314         rsurfmode_t mode;
315
316         // rtlight rendering
317         // light currently being rendered
318         rtlight_t *rtlight;
319         // current light's cull box (copied out of an rtlight or calculated by GetLightInfo)
320         vec3_t rtlight_cullmins;
321         vec3_t rtlight_cullmaxs;
322         // current light's culling planes
323         int rtlight_numfrustumplanes;
324         mplane_t rtlight_frustumplanes[12+6+6]; // see R_Shadow_ComputeShadowCasterCullingPlanes
325
326         // this is the location of the light in entity space
327         vec3_t entitylightorigin;
328         // this transforms entity coordinates to light filter cubemap coordinates
329         // (also often used for other purposes)
330         matrix4x4_t entitytolight;
331         // based on entitytolight this transforms -1 to +1 to 0 to 1 for purposes
332         // of attenuation texturing in full 3D (Z result often ignored)
333         matrix4x4_t entitytoattenuationxyz;
334         // this transforms only the Z to S, and T is always 0.5
335         matrix4x4_t entitytoattenuationz;
336 }
337 rsurfacestate_t;
338
339 extern rsurfacestate_t rsurface;
340
341 void RSurf_ActiveWorldEntity(void);
342 void RSurf_ActiveModelEntity(const entity_render_t *ent, qboolean wantnormals, qboolean wanttangents);
343 void RSurf_CleanUp(void);
344
345 void R_Mesh_ResizeArrays(int newvertices);
346
347 struct entity_render_s;
348 struct texture_s;
349 struct msurface_s;
350 void R_UpdateTextureInfo(const entity_render_t *ent, texture_t *t);
351 void R_UpdateAllTextureInfo(entity_render_t *ent);
352 void R_QueueTextureSurfaceList(int texturenumsurfaces, msurface_t **texturesurfacelist);
353 void R_DrawWorldSurfaces(qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean addwaterplanes, qboolean debug);
354 void R_DrawModelSurfaces(entity_render_t *ent, qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean addwaterplanes, qboolean debug);
355
356 void RSurf_PrepareVerticesForBatch(qboolean generatenormals, qboolean generatetangents, int texturenumsurfaces, msurface_t **texturesurfacelist);
357 void RSurf_DrawBatch_Simple(int texturenumsurfaces, msurface_t **texturesurfacelist);
358
359 typedef enum rsurfacepass_e
360 {
361         RSURFPASS_BASE,
362         RSURFPASS_BACKGROUND,
363         RSURFPASS_RTLIGHT
364 }
365 rsurfacepass_t;
366
367 int R_SetupSurfaceShader(const vec3_t lightcolorbase, qboolean modellighting, float ambientscale, float diffusescale, float specularscale, rsurfacepass_t pass);
368
369 #endif
370