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