laid groundwork for a new decal system
[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_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 typedef enum r_refdef_scene_type_s {
128         RST_CLIENT,
129         RST_MENU,
130         RST_COUNT
131 } r_refdef_scene_type_t;
132
133 void R_SelectScene( r_refdef_scene_type_t scenetype );
134 r_refdef_scene_t * R_GetScenePointer( r_refdef_scene_type_t scenetype );
135
136 void R_SkinFrame_PrepareForPurge(void);
137 void R_SkinFrame_MarkUsed(skinframe_t *skinframe);
138 void R_SkinFrame_Purge(void);
139 // set last to NULL to start from the beginning
140 skinframe_t *R_SkinFrame_FindNextByName( skinframe_t *last, const char *name );
141 skinframe_t *R_SkinFrame_Find(const char *name, int textureflags, int comparewidth, int compareheight, int comparecrc, qboolean add);
142 skinframe_t *R_SkinFrame_LoadExternal(const char *name, int textureflags, qboolean complain);
143 skinframe_t *R_SkinFrame_LoadExternal_CheckAlpha(const char *name, int textureflags, qboolean complain, qboolean *has_alpha);
144 skinframe_t *R_SkinFrame_LoadInternalBGRA(const char *name, int textureflags, const unsigned char *skindata, int width, int height);
145 skinframe_t *R_SkinFrame_LoadInternalQuake(const char *name, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height);
146 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);
147 skinframe_t *R_SkinFrame_LoadMissing(void);
148
149 void R_View_WorldVisibility(qboolean forcenovis);
150 void R_DrawDecals(void);
151 void R_DrawParticles(void);
152 void R_DrawExplosions(void);
153
154 #define gl_solid_format 3
155 #define gl_alpha_format 4
156
157 int R_CullBox(const vec3_t mins, const vec3_t maxs);
158 int R_CullBoxCustomPlanes(const vec3_t mins, const vec3_t maxs, int numplanes, const mplane_t *planes);
159
160 #include "r_modules.h"
161
162 #include "meshqueue.h"
163
164 #include "r_lerpanim.h"
165
166 extern cvar_t r_render;
167 extern cvar_t r_renderview;
168 extern cvar_t r_waterwarp;
169
170 extern cvar_t r_textureunits;
171 extern cvar_t r_glsl;
172 extern cvar_t r_glsl_offsetmapping;
173 extern cvar_t r_glsl_offsetmapping_reliefmapping;
174 extern cvar_t r_glsl_offsetmapping_scale;
175 extern cvar_t r_glsl_deluxemapping;
176
177 extern cvar_t gl_polyblend;
178 extern cvar_t gl_dither;
179
180 extern cvar_t cl_deathfade;
181
182 extern cvar_t r_smoothnormals_areaweighting;
183
184 extern cvar_t r_test;
185
186 #include "gl_backend.h"
187
188 extern rtexture_t *r_texture_blanknormalmap;
189 extern rtexture_t *r_texture_white;
190 extern rtexture_t *r_texture_grey128;
191 extern rtexture_t *r_texture_black;
192 extern rtexture_t *r_texture_notexture;
193 extern rtexture_t *r_texture_whitecube;
194 extern rtexture_t *r_texture_normalizationcube;
195 extern rtexture_t *r_texture_fogattenuation;
196 //extern rtexture_t *r_texture_fogintensity;
197
198 #define R_MAX_OCCLUSION_QUERIES 4096
199 extern unsigned int r_queries[R_MAX_OCCLUSION_QUERIES];
200 extern unsigned int r_numqueries;
201 extern unsigned int r_maxqueries;
202
203 void R_TimeReport(char *name);
204
205 // r_stain
206 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);
207
208 void R_CalcBeam_Vertex3f(float *vert, const vec3_t org1, const vec3_t org2, float width);
209 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);
210
211 extern mempool_t *r_main_mempool;
212
213 typedef struct rsurfacestate_s
214 {
215         // processing buffers
216         int array_size;
217         float *array_modelvertex3f;
218         float *array_modelsvector3f;
219         float *array_modeltvector3f;
220         float *array_modelnormal3f;
221         float *array_deformedvertex3f;
222         float *array_deformedsvector3f;
223         float *array_deformedtvector3f;
224         float *array_deformednormal3f;
225         float *array_generatedtexcoordtexture2f;
226         float *array_color4f;
227         float *array_texcoord3f;
228
229         // current model array pointers
230         // these may point to processing buffers if model is animated,
231         // otherwise they point to static data.
232         // these are not directly used for rendering, they are just another level
233         // of processing
234         //
235         // these either point at array_model* buffers (if the model is animated)
236         // or the model->surfmesh.data_* buffers (if the model is not animated)
237         //
238         // these are only set when an entity render begins, they do not change on
239         // a per surface basis.
240         //
241         // this indicates the model* arrays are pointed at array_model* buffers
242         // (in other words, the model has been animated in software)
243         qboolean generatedvertex;
244         const float *modelvertex3f;
245         int modelvertex3f_bufferobject;
246         size_t modelvertex3f_bufferoffset;
247         const float *modelsvector3f;
248         int modelsvector3f_bufferobject;
249         size_t modelsvector3f_bufferoffset;
250         const float *modeltvector3f;
251         int modeltvector3f_bufferobject;
252         size_t modeltvector3f_bufferoffset;
253         const float *modelnormal3f;
254         int modelnormal3f_bufferobject;
255         size_t modelnormal3f_bufferoffset;
256         const float *modellightmapcolor4f;
257         int modellightmapcolor4f_bufferobject;
258         size_t modellightmapcolor4f_bufferoffset;
259         const float *modeltexcoordtexture2f;
260         int modeltexcoordtexture2f_bufferobject;
261         size_t modeltexcoordtexture2f_bufferoffset;
262         const float *modeltexcoordlightmap2f;
263         int modeltexcoordlightmap2f_bufferobject;
264         size_t modeltexcoordlightmap2f_bufferoffset;
265         const int *modelelement3i;
266         const unsigned short *modelelement3s;
267         int modelelement3i_bufferobject;
268         int modelelement3s_bufferobject;
269         const int *modellightmapoffsets;
270         int modelnum_vertices;
271         int modelnum_triangles;
272         const msurface_t *modelsurfaces;
273         // current rendering array pointers
274         // these may point to any of several different buffers depending on how
275         // much processing was needed to prepare this model for rendering
276         // these usually equal the model* pointers, they only differ if
277         // deformvertexes is used in a q3 shader, and consequently these can
278         // change on a per-surface basis (according to rsurface.texture)
279         //
280         // the exception is the color array which is often generated based on
281         // colormod, alpha fading, and fogging, it may also come from q3bsp vertex
282         // lighting of certain surfaces
283         const float *vertex3f;
284         int vertex3f_bufferobject;
285         size_t vertex3f_bufferoffset;
286         const float *svector3f;
287         int svector3f_bufferobject;
288         size_t svector3f_bufferoffset;
289         const float *tvector3f;
290         int tvector3f_bufferobject;
291         size_t tvector3f_bufferoffset;
292         const float *normal3f;
293         int normal3f_bufferobject;
294         size_t normal3f_bufferoffset;
295         const float *lightmapcolor4f;
296         int lightmapcolor4f_bufferobject;
297         size_t lightmapcolor4f_bufferoffset;
298         const float *texcoordtexture2f;
299         int texcoordtexture2f_bufferobject;
300         size_t texcoordtexture2f_bufferoffset;
301         const float *texcoordlightmap2f;
302         int texcoordlightmap2f_bufferobject;
303         size_t texcoordlightmap2f_bufferoffset;
304         // some important fields from the entity
305         int ent_skinnum;
306         int ent_qwskin;
307         int ent_flags;
308         float ent_shadertime;
309         float ent_color[4];
310         // transform matrices to render this entity and effects on this entity
311         matrix4x4_t matrix;
312         matrix4x4_t inversematrix;
313         // scale factors for transforming lengths into/out of entity space
314         float matrixscale;
315         float inversematrixscale;
316         // animation blending state from entity
317         frameblend_t frameblend[MAX_FRAMEBLENDS];
318         // directional model shading state from entity
319         vec3_t modellight_ambient;
320         vec3_t modellight_diffuse;
321         vec3_t modellight_lightdir;
322         // colormapping state from entity (these are black if colormapping is off)
323         vec3_t colormap_pantscolor;
324         vec3_t colormap_shirtcolor;
325         // special coloring of glow textures
326         vec3_t glowmod;
327         // view location in model space
328         vec3_t localvieworigin;
329         // polygon offset data for submodels
330         float basepolygonfactor;
331         float basepolygonoffset;
332         // current texture in batching code
333         texture_t *texture;
334         // whether lightmapping is active on this batch
335         // (otherwise vertex colored)
336         qboolean uselightmaptexture;
337         // fog plane in model space for direct application to vertices
338         float fograngerecip;
339         float fogmasktabledistmultiplier;
340         float fogplane[4];
341         float fogheightfade;
342         float fogplaneviewdist;
343
344         // rtlight rendering
345         // light currently being rendered
346         const rtlight_t *rtlight;
347         // current light's cull box (copied out of an rtlight or calculated by GetLightInfo)
348         vec3_t rtlight_cullmins;
349         vec3_t rtlight_cullmaxs;
350         // current light's culling planes
351         int rtlight_numfrustumplanes;
352         mplane_t rtlight_frustumplanes[12+6+6]; // see R_Shadow_ComputeShadowCasterCullingPlanes
353
354         // this is the location of the light in entity space
355         vec3_t entitylightorigin;
356         // this transforms entity coordinates to light filter cubemap coordinates
357         // (also often used for other purposes)
358         matrix4x4_t entitytolight;
359         // based on entitytolight this transforms -1 to +1 to 0 to 1 for purposes
360         // of attenuation texturing in full 3D (Z result often ignored)
361         matrix4x4_t entitytoattenuationxyz;
362         // this transforms only the Z to S, and T is always 0.5
363         matrix4x4_t entitytoattenuationz;
364
365         // pointer to an entity_render_t used only by R_GetCurrentTexture and
366         // RSurf_ActiveWorldEntity/RSurf_ActiveModelEntity as a unique id within
367         // each frame (see r_frame also)
368         entity_render_t *entity;
369 }
370 rsurfacestate_t;
371
372 extern rsurfacestate_t rsurface;
373
374 void RSurf_ActiveWorldEntity(void);
375 void RSurf_ActiveModelEntity(const entity_render_t *ent, qboolean wantnormals, qboolean wanttangents);
376 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);
377 void RSurf_SetupDepthAndCulling(void);
378
379 void R_Mesh_ResizeArrays(int newvertices);
380
381 texture_t *R_GetCurrentTexture(texture_t *t);
382 void R_DrawWorldSurfaces(qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug);
383 void R_DrawModelSurfaces(entity_render_t *ent, qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug);
384 void R_AddWaterPlanes(entity_render_t *ent);
385 void R_DrawCustomSurface(skinframe_t *skinframe, const matrix4x4_t *texmatrix, int materialflags, int firstvertex, int numvertices, int firsttriangle, int numtriangles, qboolean writedepth);
386
387 void RSurf_PrepareVerticesForBatch(qboolean generatenormals, qboolean generatetangents, int texturenumsurfaces, const msurface_t **texturesurfacelist);
388 void RSurf_DrawBatch_Simple(int texturenumsurfaces, const msurface_t **texturesurfacelist);
389
390 typedef enum rsurfacepass_e
391 {
392         RSURFPASS_BASE,
393         RSURFPASS_BACKGROUND,
394         RSURFPASS_RTLIGHT
395 }
396 rsurfacepass_t;
397
398 typedef enum gl20_texunit_e
399 {
400         // postprocess shaders, and generic shaders:
401         GL20TU_FIRST = 0,
402         GL20TU_SECOND = 1,
403         GL20TU_GAMMARAMPS = 2,
404         // standard material properties
405         GL20TU_NORMAL = 0,
406         GL20TU_COLOR = 1,
407         GL20TU_GLOSS = 2,
408         GL20TU_GLOW = 3,
409         // material properties for a second material
410         GL20TU_SECONDARY_NORMAL = 4,
411         GL20TU_SECONDARY_COLOR = 5,
412         GL20TU_SECONDARY_GLOSS = 6,
413         GL20TU_SECONDARY_GLOW = 7,
414         // material properties for a colormapped material
415         // conflicts with secondary material
416         GL20TU_PANTS = 4,
417         GL20TU_SHIRT = 5,
418         // fog fade in the distance
419         GL20TU_FOGMASK = 8,
420         // compiled ambient lightmap and deluxemap
421         GL20TU_LIGHTMAP = 9,
422         GL20TU_DELUXEMAP = 10,
423         // refraction, used by water shaders
424         GL20TU_REFRACTION = 3,
425         // reflection, used by water shaders, also with normal material rendering
426         // conflicts with secondary material
427         GL20TU_REFLECTION = 7,
428         // rtlight attenuation (distance fade) and cubemap filter (projection texturing)
429         // conflicts with lightmap/deluxemap
430         GL20TU_ATTENUATION = 9,
431         GL20TU_CUBE = 10,
432         GL20TU_SHADOWMAPRECT = 11,
433         GL20TU_SHADOWMAPCUBE = 11,
434         GL20TU_SHADOWMAP2D = 11,
435         GL20TU_CUBEPROJECTION = 12
436 }
437 gl20_texunit;
438
439 void R_SetupGenericShader(qboolean usetexture);
440 void R_SetupGenericTwoTextureShader(int texturemode);
441 void R_SetupDepthOrShadowShader(void);
442 void R_SetupShowDepthShader(void);
443 void R_SetupSurfaceShader(const vec3_t lightcolorbase, qboolean modellighting, float ambientscale, float diffusescale, float specularscale, rsurfacepass_t rsurfacepass);
444
445 typedef struct r_waterstate_waterplane_s
446 {
447         rtexture_t *texture_refraction;
448         rtexture_t *texture_reflection;
449         mplane_t plane;
450         int materialflags; // combined flags of all water surfaces on this plane
451         unsigned char pvsbits[(32768+7)>>3]; // FIXME: buffer overflow on huge maps
452         qboolean pvsvalid;
453 }
454 r_waterstate_waterplane_t;
455
456 #define MAX_WATERPLANES 16
457
458 typedef struct r_waterstate_s
459 {
460         qboolean enabled;
461
462         qboolean renderingscene; // true while rendering a refraction or reflection texture, disables water surfaces
463
464         int waterwidth, waterheight;
465         int texturewidth, textureheight;
466
467         int maxwaterplanes; // same as MAX_WATERPLANES
468         int numwaterplanes;
469         r_waterstate_waterplane_t waterplanes[MAX_WATERPLANES];
470
471         float screenscale[2];
472         float screencenter[2];
473 }
474 r_waterstate_t;
475
476 extern r_waterstate_t r_waterstate;
477
478 #endif
479