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