added r_showoverdraw cvar which allows you to see how many draws per
[xonotic/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 skyrenderlater, 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 int r_timereport_active;
49
50 // lighting stuff
51 extern cvar_t r_ambient;
52 extern cvar_t gl_flashblend;
53
54 // vis stuff
55 extern cvar_t r_novis;
56
57 extern cvar_t r_lerpsprites;
58 extern cvar_t r_lerpmodels;
59 extern cvar_t r_lerplightstyles;
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_showoverdraw;
105 extern cvar_t r_showtris;
106 extern cvar_t r_shownormals;
107 extern cvar_t r_showlighting;
108 extern cvar_t r_showshadowvolumes;
109 extern cvar_t r_showcollisionbrushes;
110 extern cvar_t r_showcollisionbrushes_polygonfactor;
111 extern cvar_t r_showcollisionbrushes_polygonoffset;
112 extern cvar_t r_showdisabledepthtest;
113
114 //
115 // view origin
116 //
117 extern cvar_t r_drawentities;
118 extern cvar_t r_draw2d;
119 extern qboolean r_draw2d_force;
120 extern cvar_t r_drawviewmodel;
121 extern cvar_t r_drawworld;
122 extern cvar_t r_speeds;
123 extern cvar_t r_fullbright;
124 extern cvar_t r_wateralpha;
125 extern cvar_t r_dynamic;
126
127 void R_Init(void);
128 void R_UpdateVariables(void); // must call after setting up most of r_refdef, but before calling R_RenderView
129 void R_RenderView(void); // must set r_refdef and call R_UpdateVariables first
130
131 typedef enum r_refdef_scene_type_s {
132         RST_CLIENT,
133         RST_MENU,
134         RST_COUNT
135 } r_refdef_scene_type_t;
136
137 void R_SelectScene( r_refdef_scene_type_t scenetype );
138 r_refdef_scene_t * R_GetScenePointer( r_refdef_scene_type_t scenetype );
139
140 void R_SkinFrame_PrepareForPurge(void);
141 void R_SkinFrame_MarkUsed(skinframe_t *skinframe);
142 void R_SkinFrame_Purge(void);
143 // set last to NULL to start from the beginning
144 skinframe_t *R_SkinFrame_FindNextByName( skinframe_t *last, const char *name );
145 skinframe_t *R_SkinFrame_Find(const char *name, int textureflags, int comparewidth, int compareheight, int comparecrc, qboolean add);
146 skinframe_t *R_SkinFrame_LoadExternal(const char *name, int textureflags, qboolean complain);
147 skinframe_t *R_SkinFrame_LoadInternalBGRA(const char *name, int textureflags, const unsigned char *skindata, int width, int height, qboolean sRGB);
148 skinframe_t *R_SkinFrame_LoadInternalQuake(const char *name, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height);
149 skinframe_t *R_SkinFrame_LoadInternal8bit(const char *name, int textureflags, const unsigned char *skindata, int width, int height, const unsigned int *palette, const unsigned int *alphapalette);
150 skinframe_t *R_SkinFrame_LoadMissing(void);
151
152 rtexture_t *R_GetCubemap(const char *basename);
153
154 void R_View_WorldVisibility(qboolean forcenovis);
155 void R_DrawDecals(void);
156 void R_DrawParticles(void);
157 void R_DrawExplosions(void);
158
159 #define gl_solid_format 3
160 #define gl_alpha_format 4
161
162 int R_CullBox(const vec3_t mins, const vec3_t maxs);
163 int R_CullBoxCustomPlanes(const vec3_t mins, const vec3_t maxs, int numplanes, const mplane_t *planes);
164
165 #include "r_modules.h"
166
167 #include "meshqueue.h"
168
169 void R_FrameData_Reset(void);
170 void R_FrameData_NewFrame(void);
171 void *R_FrameData_Alloc(size_t size);
172 void *R_FrameData_Store(size_t size, void *data);
173 void R_FrameData_SetMark(void);
174 void R_FrameData_ReturnToMark(void);
175
176 void R_AnimCache_Free(void);
177 void R_AnimCache_ClearCache(void);
178 qboolean R_AnimCache_GetEntity(entity_render_t *ent, qboolean wantnormals, qboolean wanttangents);
179 void R_AnimCache_CacheVisibleEntities(void);
180
181 #include "r_lerpanim.h"
182
183 extern cvar_t r_render;
184 extern cvar_t r_renderview;
185 extern cvar_t r_waterwarp;
186
187 extern cvar_t r_textureunits;
188
189 extern cvar_t r_glsl_offsetmapping;
190 extern cvar_t r_glsl_offsetmapping_reliefmapping;
191 extern cvar_t r_glsl_offsetmapping_scale;
192 extern cvar_t r_glsl_deluxemapping;
193
194 extern cvar_t gl_polyblend;
195 extern cvar_t gl_dither;
196
197 extern cvar_t cl_deathfade;
198
199 extern cvar_t r_smoothnormals_areaweighting;
200
201 extern cvar_t r_test;
202
203 extern cvar_t r_texture_sRGB_2d;
204 extern cvar_t r_texture_sRGB_skin_diffuse;
205 extern cvar_t r_texture_sRGB_skin_gloss;
206 extern cvar_t r_texture_sRGB_skin_glow;
207 extern cvar_t r_texture_sRGB_skin_reflect;
208 extern cvar_t r_texture_sRGB_cubemap;
209 extern cvar_t r_texture_sRGB_skybox;
210
211 #include "gl_backend.h"
212
213 extern rtexture_t *r_texture_blanknormalmap;
214 extern rtexture_t *r_texture_white;
215 extern rtexture_t *r_texture_grey128;
216 extern rtexture_t *r_texture_black;
217 extern rtexture_t *r_texture_notexture;
218 extern rtexture_t *r_texture_whitecube;
219 extern rtexture_t *r_texture_normalizationcube;
220 extern rtexture_t *r_texture_fogattenuation;
221 extern rtexture_t *r_texture_fogheighttexture;
222
223 extern unsigned int r_queries[MAX_OCCLUSION_QUERIES];
224 extern unsigned int r_numqueries;
225 extern unsigned int r_maxqueries;
226
227 void R_TimeReport(const char *name);
228
229 // r_stain
230 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);
231
232 void R_CalcBeam_Vertex3f(float *vert, const vec3_t org1, const vec3_t org2, float width);
233 void R_CalcSprite_Vertex3f(float *vertex3f, const vec3_t origin, const vec3_t left, const vec3_t up, float scalex1, float scalex2, float scaley1, float scaley2);
234
235 extern mempool_t *r_main_mempool;
236
237 typedef struct rsurfacestate_s
238 {
239         // current model array pointers
240         // these may point to processing buffers if model is animated,
241         // otherwise they point to static data.
242         // these are not directly used for rendering, they are just another level
243         // of processing
244         //
245         // these either point at array_model* buffers (if the model is animated)
246         // or the model->surfmesh.data_* buffers (if the model is not animated)
247         //
248         // these are only set when an entity render begins, they do not change on
249         // a per surface basis.
250         //
251         // this indicates the model* arrays are pointed at array_model* buffers
252         // (in other words, the model has been animated in software)
253         qboolean                    modelgeneratedvertex;
254         float                      *modelvertex3f;
255         const r_meshbuffer_t       *modelvertex3f_vertexbuffer;
256         size_t                      modelvertex3f_bufferoffset;
257         float                      *modelsvector3f;
258         const r_meshbuffer_t       *modelsvector3f_vertexbuffer;
259         size_t                      modelsvector3f_bufferoffset;
260         float                      *modeltvector3f;
261         const r_meshbuffer_t       *modeltvector3f_vertexbuffer;
262         size_t                      modeltvector3f_bufferoffset;
263         float                      *modelnormal3f;
264         const r_meshbuffer_t       *modelnormal3f_vertexbuffer;
265         size_t                      modelnormal3f_bufferoffset;
266         float                      *modellightmapcolor4f;
267         const r_meshbuffer_t       *modellightmapcolor4f_vertexbuffer;
268         size_t                      modellightmapcolor4f_bufferoffset;
269         float                      *modeltexcoordtexture2f;
270         const r_meshbuffer_t       *modeltexcoordtexture2f_vertexbuffer;
271         size_t                      modeltexcoordtexture2f_bufferoffset;
272         float                      *modeltexcoordlightmap2f;
273         const r_meshbuffer_t       *modeltexcoordlightmap2f_vertexbuffer;
274         size_t                      modeltexcoordlightmap2f_bufferoffset;
275         r_vertexmesh_t             *modelvertexmesh;
276         const r_meshbuffer_t       *modelvertexmeshbuffer;
277         const r_meshbuffer_t       *modelvertex3fbuffer;
278         int                        *modelelement3i;
279         const r_meshbuffer_t       *modelelement3i_indexbuffer;
280         size_t                      modelelement3i_bufferoffset;
281         unsigned short             *modelelement3s;
282         const r_meshbuffer_t       *modelelement3s_indexbuffer;
283         size_t                      modelelement3s_bufferoffset;
284         int                        *modellightmapoffsets;
285         int                         modelnumvertices;
286         int                         modelnumtriangles;
287         const msurface_t           *modelsurfaces;
288         // current rendering array pointers
289         // these may point to any of several different buffers depending on how
290         // much processing was needed to prepare this model for rendering
291         // these usually equal the model* pointers, they only differ if
292         // deformvertexes is used in a q3 shader, and consequently these can
293         // change on a per-surface basis (according to rsurface.texture)
294         qboolean                    batchgeneratedvertex;
295         int                         batchfirstvertex;
296         int                         batchnumvertices;
297         int                         batchfirsttriangle;
298         int                         batchnumtriangles;
299         r_vertexmesh_t             *batchvertexmesh;
300         const r_meshbuffer_t       *batchvertexmeshbuffer;
301         const r_meshbuffer_t       *batchvertex3fbuffer;
302         float                      *batchvertex3f;
303         const r_meshbuffer_t       *batchvertex3f_vertexbuffer;
304         size_t                      batchvertex3f_bufferoffset;
305         float                      *batchsvector3f;
306         const r_meshbuffer_t       *batchsvector3f_vertexbuffer;
307         size_t                      batchsvector3f_bufferoffset;
308         float                      *batchtvector3f;
309         const r_meshbuffer_t       *batchtvector3f_vertexbuffer;
310         size_t                      batchtvector3f_bufferoffset;
311         float                      *batchnormal3f;
312         const r_meshbuffer_t       *batchnormal3f_vertexbuffer;
313         size_t                      batchnormal3f_bufferoffset;
314         float                      *batchlightmapcolor4f;
315         const r_meshbuffer_t       *batchlightmapcolor4f_vertexbuffer;
316         size_t                      batchlightmapcolor4f_bufferoffset;
317         float                      *batchtexcoordtexture2f;
318         const r_meshbuffer_t       *batchtexcoordtexture2f_vertexbuffer;
319         size_t                      batchtexcoordtexture2f_bufferoffset;
320         float                      *batchtexcoordlightmap2f;
321         const r_meshbuffer_t       *batchtexcoordlightmap2f_vertexbuffer;
322         size_t                      batchtexcoordlightmap2f_bufferoffset;
323         int                        *batchelement3i;
324         const r_meshbuffer_t       *batchelement3i_indexbuffer;
325         size_t                      batchelement3i_bufferoffset;
326         unsigned short             *batchelement3s;
327         const r_meshbuffer_t       *batchelement3s_indexbuffer;
328         size_t                      batchelement3s_bufferoffset;
329         // rendering pass processing arrays in GL11 and GL13 paths
330         float                      *passcolor4f;
331         const r_meshbuffer_t       *passcolor4f_vertexbuffer;
332         size_t                      passcolor4f_bufferoffset;
333
334         // some important fields from the entity
335         int ent_skinnum;
336         int ent_qwskin;
337         int ent_flags;
338         float ent_shadertime;
339         int ent_alttextures; // used by q1bsp animated textures (pressed buttons)
340         // transform matrices to render this entity and effects on this entity
341         matrix4x4_t matrix;
342         matrix4x4_t inversematrix;
343         // scale factors for transforming lengths into/out of entity space
344         float matrixscale;
345         float inversematrixscale;
346         // animation blending state from entity
347         frameblend_t frameblend[MAX_FRAMEBLENDS];
348         skeleton_t *skeleton;
349         // directional model shading state from entity
350         vec3_t modellight_ambient;
351         vec3_t modellight_diffuse;
352         vec3_t modellight_lightdir;
353         // colormapping state from entity (these are black if colormapping is off)
354         vec3_t colormap_pantscolor;
355         vec3_t colormap_shirtcolor;
356         // special coloring of ambient/diffuse textures (gloss not affected)
357         // colormod[3] is the alpha of the entity
358         float colormod[4];
359         // special coloring of glow textures
360         float glowmod[3];
361         // view location in model space
362         vec3_t localvieworigin;
363         // polygon offset data for submodels
364         float basepolygonfactor;
365         float basepolygonoffset;
366         // current textures in batching code
367         texture_t *texture;
368         rtexture_t *lightmaptexture;
369         rtexture_t *deluxemaptexture;
370         // whether lightmapping is active on this batch
371         // (otherwise vertex colored)
372         qboolean uselightmaptexture;
373         // fog plane in model space for direct application to vertices
374         float fograngerecip;
375         float fogmasktabledistmultiplier;
376         float fogplane[4];
377         float fogheightfade;
378         float fogplaneviewdist;
379
380         // rtlight rendering
381         // light currently being rendered
382         const rtlight_t *rtlight;
383
384         // this is the location of the light in entity space
385         vec3_t entitylightorigin;
386         // this transforms entity coordinates to light filter cubemap coordinates
387         // (also often used for other purposes)
388         matrix4x4_t entitytolight;
389         // based on entitytolight this transforms -1 to +1 to 0 to 1 for purposes
390         // of attenuation texturing in full 3D (Z result often ignored)
391         matrix4x4_t entitytoattenuationxyz;
392         // this transforms only the Z to S, and T is always 0.5
393         matrix4x4_t entitytoattenuationz;
394
395         // user wavefunc parameters (from csqc)
396         float userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
397
398         // pointer to an entity_render_t used only by R_GetCurrentTexture and
399         // RSurf_ActiveWorldEntity/RSurf_ActiveModelEntity as a unique id within
400         // each frame (see r_frame also)
401         entity_render_t *entity;
402 }
403 rsurfacestate_t;
404
405 extern rsurfacestate_t rsurface;
406
407 void R_HDR_UpdateIrisAdaptation(const vec3_t point);
408
409 void RSurf_ActiveWorldEntity(void);
410 void RSurf_ActiveModelEntity(const entity_render_t *ent, qboolean wantnormals, qboolean wanttangents, qboolean prepass);
411 void RSurf_ActiveCustomEntity(const matrix4x4_t *matrix, const matrix4x4_t *inversematrix, int entflags, double shadertime, float r, float g, float b, float a, int numvertices, const float *vertex3f, const float *texcoord2f, const float *normal3f, const float *svector3f, const float *tvector3f, const float *color4f, int numtriangles, const int *element3i, const unsigned short *element3s, qboolean wantnormals, qboolean wanttangents);
412 void RSurf_SetupDepthAndCulling(void);
413
414 void R_Mesh_ResizeArrays(int newvertices);
415
416 texture_t *R_GetCurrentTexture(texture_t *t);
417 void R_DrawWorldSurfaces(qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug, qboolean prepass);
418 void R_DrawModelSurfaces(entity_render_t *ent, qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug, qboolean prepass);
419 void R_AddWaterPlanes(entity_render_t *ent);
420 void R_DrawCustomSurface(skinframe_t *skinframe, const matrix4x4_t *texmatrix, int materialflags, int firstvertex, int numvertices, int firsttriangle, int numtriangles, qboolean writedepth, qboolean prepass);
421 void R_DrawCustomSurface_Texture(texture_t *texture, const matrix4x4_t *texmatrix, int materialflags, int firstvertex, int numvertices, int firsttriangle, int numtriangles, qboolean writedepth, qboolean prepass);
422
423 #define BATCHNEED_VERTEXMESH_VERTEX      (1<< 1) // set up rsurface.batchvertexmesh
424 #define BATCHNEED_VERTEXMESH_NORMAL      (1<< 2) // set up normals in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchnormal3f if BATCHNEED_ARRAYS
425 #define BATCHNEED_VERTEXMESH_VECTOR      (1<< 3) // set up vectors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchsvector3f and rsurface.batchtvector3f if BATCHNEED_ARRAYS
426 #define BATCHNEED_VERTEXMESH_VERTEXCOLOR (1<< 4) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
427 #define BATCHNEED_VERTEXMESH_TEXCOORD    (1<< 5) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
428 #define BATCHNEED_VERTEXMESH_LIGHTMAP    (1<< 6) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
429 #define BATCHNEED_ARRAY_VERTEX           (1<< 7) // set up rsurface.batchvertex3f and optionally others
430 #define BATCHNEED_ARRAY_NORMAL           (1<< 8) // set up normals in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchnormal3f if BATCHNEED_ARRAYS
431 #define BATCHNEED_ARRAY_VECTOR           (1<< 9) // set up vectors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchsvector3f and rsurface.batchtvector3f if BATCHNEED_ARRAYS
432 #define BATCHNEED_ARRAY_VERTEXCOLOR      (1<<10) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
433 #define BATCHNEED_ARRAY_TEXCOORD         (1<<11) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
434 #define BATCHNEED_ARRAY_LIGHTMAP         (1<<12) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
435 #define BATCHNEED_NOGAPS                 (1<<13) // force vertex copying (no gaps)
436 void RSurf_PrepareVerticesForBatch(int batchneed, int texturenumsurfaces, const msurface_t **texturesurfacelist);
437 void RSurf_DrawBatch(void);
438
439 void R_DecalSystem_SplatEntities(const vec3_t org, const vec3_t normal, float r, float g, float b, float a, float s1, float t1, float s2, float t2, float size);
440
441 typedef enum rsurfacepass_e
442 {
443         RSURFPASS_BASE,
444         RSURFPASS_BACKGROUND,
445         RSURFPASS_RTLIGHT,
446         RSURFPASS_DEFERREDGEOMETRY
447 }
448 rsurfacepass_t;
449
450 void R_SetupShader_Generic(rtexture_t *first, rtexture_t *second, int texturemode, int rgbscale);
451 void R_SetupShader_DepthOrShadow(void);
452 void R_SetupShader_ShowDepth(void);
453 void R_SetupShader_Surface(const vec3_t lightcolorbase, qboolean modellighting, float ambientscale, float diffusescale, float specularscale, rsurfacepass_t rsurfacepass, int texturenumsurfaces, const msurface_t **texturesurfacelist, void *waterplane);
454 void R_SetupShader_DeferredLight(const rtlight_t *rtlight);
455
456 typedef struct r_waterstate_waterplane_s
457 {
458         rtexture_t *texture_refraction;
459         rtexture_t *texture_reflection;
460         rtexture_t *texture_camera;
461         mplane_t plane;
462         int materialflags; // combined flags of all water surfaces on this plane
463         unsigned char pvsbits[(MAX_MAP_LEAFS+7)>>3]; // FIXME: buffer overflow on huge maps
464         qboolean pvsvalid;
465         int camera_entity;
466         vec3_t mins, maxs;
467 }
468 r_waterstate_waterplane_t;
469
470 typedef struct r_waterstate_s
471 {
472         qboolean enabled;
473
474         qboolean renderingscene; // true while rendering a refraction or reflection texture, disables water surfaces
475         qboolean renderingrefraction;
476
477         int waterwidth, waterheight;
478         int texturewidth, textureheight;
479         int camerawidth, cameraheight;
480
481         int maxwaterplanes; // same as MAX_WATERPLANES
482         int numwaterplanes;
483         r_waterstate_waterplane_t waterplanes[MAX_WATERPLANES];
484
485         float screenscale[2];
486         float screencenter[2];
487 }
488 r_waterstate_t;
489
490 extern r_waterstate_t r_waterstate;
491
492 #endif
493