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