implemented support for GL_ARB_texture_compression - this is controlled
[divverent/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 extern void SHOWLMP_clear(void);
47
48 // render profiling stuff
49 extern char r_speeds_string[1024];
50 extern int r_timereport_active;
51
52 // lighting stuff
53 extern cvar_t r_ambient;
54 extern cvar_t gl_flashblend;
55
56 // vis stuff
57 extern cvar_t r_novis;
58
59 extern cvar_t r_lerpsprites;
60 extern cvar_t r_lerpmodels;
61 extern cvar_t r_waterscroll;
62
63 extern cvar_t developer_texturelogging;
64
65 // shadow volume bsp struct with automatically growing nodes buffer
66 extern svbsp_t r_svbsp;
67
68 typedef struct rmesh_s
69 {
70         // vertices of this mesh
71         int maxvertices;
72         int numvertices;
73         float *vertex3f;
74         float *svector3f;
75         float *tvector3f;
76         float *normal3f;
77         float *texcoord2f;
78         float *texcoordlightmap2f;
79         float *color4f;
80         // triangles of this mesh
81         int maxtriangles;
82         int numtriangles;
83         int *element3i;
84         int *neighbor3i;
85         // snapping epsilon
86         float epsilon2;
87 }
88 rmesh_t;
89
90 // useful functions for rendering
91 void R_ModulateColors(float *in, float *out, int verts, float r, float g, float b);
92 void R_FillColors(float *out, int verts, float r, float g, float b, float a);
93 int R_Mesh_AddVertex3f(rmesh_t *mesh, const float *v);
94 void R_Mesh_AddPolygon3f(rmesh_t *mesh, int numvertices, float *vertex3f);
95 void R_Mesh_AddBrushMeshFromPlanes(rmesh_t *mesh, int numplanes, mplane_t *planes);
96
97 #define TOP_RANGE               16                      // soldier uniform colors
98 #define BOTTOM_RANGE    96
99
100 //=============================================================================
101
102 extern cvar_t r_nearclip;
103
104 // forces all rendering to draw triangle outlines
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_drawviewmodel;
119 extern cvar_t r_speeds;
120 extern cvar_t r_fullbright;
121 extern cvar_t r_wateralpha;
122 extern cvar_t r_dynamic;
123
124 void R_Init(void);
125 void R_UpdateVariables(void); // must call after setting up most of r_refdef, but before calling R_RenderView
126 void R_RenderView(void); // must set r_refdef and call R_UpdateVariables first
127
128
129 void R_InitSky (unsigned char *src, int bytesperpixel); // called at level load
130
131 void R_SkinFrame_PrepareForPurge(void);
132 void R_SkinFrame_MarkUsed(skinframe_t *skinframe);
133 void R_SkinFrame_Purge(void);
134 skinframe_t *R_SkinFrame_Find(const char *name, int textureflags, int comparewidth, int compareheight, int comparecrc, qboolean add);
135 skinframe_t *R_SkinFrame_LoadExternal(const char *name, int textureflags, qboolean complain);
136 skinframe_t *R_SkinFrame_LoadInternal(const char *name, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height, int bitsperpixel, const unsigned int *palette, const unsigned int *alphapalette);
137 skinframe_t *R_SkinFrame_LoadMissing(void);
138
139 void R_View_WorldVisibility();
140 void R_DrawParticles(void);
141 void R_DrawExplosions(void);
142
143 #define gl_solid_format 3
144 #define gl_alpha_format 4
145
146 int R_CullBox(const vec3_t mins, const vec3_t maxs);
147 int R_CullBoxCustomPlanes(const vec3_t mins, const vec3_t maxs, int numplanes, const mplane_t *planes);
148
149 #include "r_modules.h"
150
151 #include "meshqueue.h"
152
153 #include "r_lerpanim.h"
154
155 extern cvar_t r_render;
156 extern cvar_t r_waterwarp;
157
158 extern cvar_t r_textureunits;
159 extern cvar_t r_glsl;
160 extern cvar_t r_glsl_offsetmapping;
161 extern cvar_t r_glsl_offsetmapping_reliefmapping;
162 extern cvar_t r_glsl_offsetmapping_scale;
163 extern cvar_t r_glsl_deluxemapping;
164
165 extern cvar_t gl_polyblend;
166 extern cvar_t gl_dither;
167
168 extern cvar_t r_smoothnormals_areaweighting;
169
170 extern cvar_t r_test;
171
172 #include "gl_backend.h"
173
174 #include "r_light.h"
175
176 extern rtexture_t *r_texture_blanknormalmap;
177 extern rtexture_t *r_texture_white;
178 extern rtexture_t *r_texture_grey128;
179 extern rtexture_t *r_texture_black;
180 extern rtexture_t *r_texture_notexture;
181 extern rtexture_t *r_texture_whitecube;
182 extern rtexture_t *r_texture_normalizationcube;
183 extern rtexture_t *r_texture_fogattenuation;
184 //extern rtexture_t *r_texture_fogintensity;
185
186 void R_TimeReport(char *name);
187
188 // r_stain
189 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);
190
191 void R_CalcBeam_Vertex3f(float *vert, const vec3_t org1, const vec3_t org2, float width);
192 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);
193
194 extern mempool_t *r_main_mempool;
195
196 typedef enum rsurfmode_e
197 {
198         RSURFMODE_NONE,
199         RSURFMODE_SHOWSURFACES,
200         RSURFMODE_SKY,
201         RSURFMODE_MULTIPASS,
202         RSURFMODE_GLSL
203 }
204 rsurfmode_t;
205
206 typedef struct rsurfacestate_s
207 {
208         // processing buffers
209         int array_size;
210         float *array_modelvertex3f;
211         float *array_modelsvector3f;
212         float *array_modeltvector3f;
213         float *array_modelnormal3f;
214         float *array_deformedvertex3f;
215         float *array_deformedsvector3f;
216         float *array_deformedtvector3f;
217         float *array_deformednormal3f;
218         float *array_generatedtexcoordtexture2f;
219         float *array_color4f;
220         float *array_texcoord3f;
221
222         // current model array pointers
223         // these may point to processing buffers if model is animated,
224         // otherwise they point to static data.
225         // these are not directly used for rendering, they are just another level
226         // of processing
227         //
228         // these either point at array_model* buffers (if the model is animated)
229         // or the model->surfmesh.data_* buffers (if the model is not animated)
230         //
231         // these are only set when an entity render begins, they do not change on
232         // a per surface basis.
233         //
234         // this indicates the model* arrays are pointed at array_model* buffers
235         // (in other words, the model has been animated in software)
236         qboolean generatedvertex;
237         float *modelvertex3f;
238         int modelvertex3f_bufferobject;
239         size_t modelvertex3f_bufferoffset;
240         float *modelsvector3f;
241         int modelsvector3f_bufferobject;
242         size_t modelsvector3f_bufferoffset;
243         float *modeltvector3f;
244         int modeltvector3f_bufferobject;
245         size_t modeltvector3f_bufferoffset;
246         float *modelnormal3f;
247         int modelnormal3f_bufferobject;
248         size_t modelnormal3f_bufferoffset;
249         float *modellightmapcolor4f;
250         int modellightmapcolor4f_bufferobject;
251         size_t modellightmapcolor4f_bufferoffset;
252         float *modeltexcoordtexture2f;
253         int modeltexcoordtexture2f_bufferobject;
254         size_t modeltexcoordtexture2f_bufferoffset;
255         float *modeltexcoordlightmap2f;
256         int modeltexcoordlightmap2f_bufferobject;
257         size_t modeltexcoordlightmap2f_bufferoffset;
258         int *modelelement3i;
259         int modelelement3i_bufferobject;
260         int *modellightmapoffsets;
261         int modelnum_vertices;
262         int modelnum_triangles;
263         msurface_t *modelsurfaces;
264         // current rendering array pointers
265         // these may point to any of several different buffers depending on how
266         // much processing was needed to prepare this model for rendering
267         // these usually equal the model* pointers, they only differ if
268         // deformvertexes is used in a q3 shader, and consequently these can
269         // change on a per-surface basis (according to rsurface.texture)
270         //
271         // the exception is the color array which is often generated based on
272         // colormod, alpha fading, and fogging, it may also come from q3bsp vertex
273         // lighting of certain surfaces
274         float *vertex3f;
275         int vertex3f_bufferobject;
276         size_t vertex3f_bufferoffset;
277         float *svector3f;
278         int svector3f_bufferobject;
279         size_t svector3f_bufferoffset;
280         float *tvector3f;
281         int tvector3f_bufferobject;
282         size_t tvector3f_bufferoffset;
283         float *normal3f;
284         int normal3f_bufferobject;
285         size_t normal3f_bufferoffset;
286         float *lightmapcolor4f;
287         int lightmapcolor4f_bufferobject;
288         size_t lightmapcolor4f_bufferoffset;
289         float *texcoordtexture2f;
290         int texcoordtexture2f_bufferobject;
291         size_t texcoordtexture2f_bufferoffset;
292         float *texcoordlightmap2f;
293         int texcoordlightmap2f_bufferobject;
294         size_t texcoordlightmap2f_bufferoffset;
295         // transform matrices to render this entity and effects on this entity
296         matrix4x4_t matrix;
297         matrix4x4_t inversematrix;
298         // animation blending state from entity
299         frameblend_t frameblend[4];
300         // directional model shading state from entity
301         vec3_t modellight_ambient;
302         vec3_t modellight_diffuse;
303         vec3_t modellight_lightdir;
304         // colormapping state from entity (these are black if colormapping is off)
305         vec3_t colormap_pantscolor;
306         vec3_t colormap_shirtcolor;
307         // view location in model space
308         vec3_t modelorg; // TODO: rename this
309         // current texture in batching code
310         texture_t *texture;
311         // whether lightmapping is active on this batch
312         // (otherwise vertex colored)
313         qboolean uselightmaptexture;
314         // one of the RSURFMODE_ values
315         rsurfmode_t mode;
316         // type of vertex lighting being used on this batch
317         int lightmode; // 0 = lightmap or fullbright, 1 = color array from q3bsp, 2 = vertex shaded model
318
319         // rtlight rendering
320         // light currently being rendered
321         rtlight_t *rtlight;
322         // current light's cull box (copied out of an rtlight or calculated by GetLightInfo)
323         vec3_t rtlight_cullmins;
324         vec3_t rtlight_cullmaxs;
325         // current light's culling planes
326         int rtlight_numfrustumplanes;
327         mplane_t rtlight_frustumplanes[12+6+6]; // see R_Shadow_ComputeShadowCasterCullingPlanes
328
329         // this is the location of the light in entity space
330         vec3_t entitylightorigin;
331         // this transforms entity coordinates to light filter cubemap coordinates
332         // (also often used for other purposes)
333         matrix4x4_t entitytolight;
334         // based on entitytolight this transforms -1 to +1 to 0 to 1 for purposes
335         // of attenuation texturing in full 3D (Z result often ignored)
336         matrix4x4_t entitytoattenuationxyz;
337         // this transforms only the Z to S, and T is always 0.5
338         matrix4x4_t entitytoattenuationz;
339 }
340 rsurfacestate_t;
341
342 extern rsurfacestate_t rsurface;
343
344 void RSurf_ActiveWorldEntity(void);
345 void RSurf_ActiveModelEntity(const entity_render_t *ent, qboolean wantnormals, qboolean wanttangents);
346 void RSurf_CleanUp(void);
347
348 void R_Mesh_ResizeArrays(int newvertices);
349
350 struct entity_render_s;
351 struct texture_s;
352 struct msurface_s;
353 void R_UpdateTextureInfo(const entity_render_t *ent, texture_t *t);
354 void R_UpdateAllTextureInfo(entity_render_t *ent);
355 void R_QueueTextureSurfaceList(int texturenumsurfaces, msurface_t **texturesurfacelist);
356 void R_DrawWorldSurfaces(qboolean skysurfaces, qboolean writedepth, qboolean depthonly);
357 void R_DrawModelSurfaces(entity_render_t *ent, qboolean skysurfaces, qboolean writedepth, qboolean depthonly);
358
359 void RSurf_PrepareVerticesForBatch(qboolean generatenormals, qboolean generatetangents, int texturenumsurfaces, msurface_t **texturesurfacelist);
360 void RSurf_DrawBatch_Simple(int texturenumsurfaces, msurface_t **texturesurfacelist);
361
362 #define SHADERPERMUTATION_MODE_LIGHTSOURCE (1<<0) // (lightsource) use directional pixel shading from light source (rtlight)
363 #define SHADERPERMUTATION_MODE_LIGHTDIRECTIONMAP_MODELSPACE (1<<1) // (lightmap) use directional pixel shading from texture containing modelspace light directions (deluxemap)
364 #define SHADERPERMUTATION_MODE_LIGHTDIRECTIONMAP_TANGENTSPACE (1<<2) // (lightmap) use directional pixel shading from texture containing tangentspace light directions (deluxemap)
365 #define SHADERPERMUTATION_MODE_LIGHTDIRECTION (1<<3) // (lightmap) use directional pixel shading from fixed light direction (q3bsp)
366 #define SHADERPERMUTATION_GLOW (1<<4) // (lightmap) blend in an additive glow texture
367 #define SHADERPERMUTATION_FOG (1<<5) // tint the color by fog color or black if using additive blend mode
368 #define SHADERPERMUTATION_COLORMAPPING (1<<6) // indicates this is a colormapped skin
369 #define SHADERPERMUTATION_DIFFUSE (1<<7) // (lightsource) whether to use directional shading
370 #define SHADERPERMUTATION_CONTRASTBOOST (1<<8) // r_glsl_contrastboost boosts the contrast at low color levels (similar to gamma)
371 #define SHADERPERMUTATION_SPECULAR (1<<9) // (lightsource or deluxemapping) render specular effects
372 #define SHADERPERMUTATION_CUBEFILTER (1<<10) // (lightsource) use cubemap light filter
373 #define SHADERPERMUTATION_OFFSETMAPPING (1<<11) // adjust texcoords to roughly simulate a displacement mapped surface
374 #define SHADERPERMUTATION_OFFSETMAPPING_RELIEFMAPPING (1<<12) // adjust texcoords to accurately simulate a displacement mapped surface (requires OFFSETMAPPING to also be set!)
375
376 #define SHADERPERMUTATION_MAX (1<<13) // how many permutations are possible
377 #define SHADERPERMUTATION_MASK (SHADERPERMUTATION_MAX - 1) // mask of valid indexing bits for r_glsl_permutations[] array
378
379 // these are additional flags used only by R_GLSL_CompilePermutation
380 #define SHADERPERMUTATION_USES_VERTEXSHADER (1<<29)
381 #define SHADERPERMUTATION_USES_GEOMETRYSHADER (1<<30)
382 #define SHADERPERMUTATION_USES_FRAGMENTSHADER (1<<31)
383
384 typedef struct r_glsl_permutation_s
385 {
386         // indicates if we have tried compiling this permutation already
387         qboolean compiled;
388         // 0 if compilation failed
389         int program;
390         int loc_Texture_Normal;
391         int loc_Texture_Color;
392         int loc_Texture_Gloss;
393         int loc_Texture_Cube;
394         int loc_Texture_Attenuation;
395         int loc_Texture_FogMask;
396         int loc_Texture_Pants;
397         int loc_Texture_Shirt;
398         int loc_Texture_Lightmap;
399         int loc_Texture_Deluxemap;
400         int loc_Texture_Glow;
401         int loc_FogColor;
402         int loc_LightPosition;
403         int loc_EyePosition;
404         int loc_LightColor;
405         int loc_Color_Pants;
406         int loc_Color_Shirt;
407         int loc_FogRangeRecip;
408         int loc_AmbientScale;
409         int loc_DiffuseScale;
410         int loc_SpecularScale;
411         int loc_SpecularPower;
412         int loc_GlowScale;
413         int loc_SceneBrightness; // or: Scenebrightness * ContrastBoost
414         int loc_OffsetMapping_Scale;
415         int loc_AmbientColor;
416         int loc_DiffuseColor;
417         int loc_SpecularColor;
418         int loc_LightDir;
419         int loc_ContrastBoostCoeff; // 1 - 1/ContrastBoost
420 }
421 r_glsl_permutation_t;
422
423 // information about each possible shader permutation
424 extern r_glsl_permutation_t r_glsl_permutations[SHADERPERMUTATION_MAX];
425 // currently selected permutation
426 extern r_glsl_permutation_t *r_glsl_permutation;
427
428 void R_GLSL_CompilePermutation(const char *shaderfilename, int permutation);
429 int R_SetupSurfaceShader(const vec3_t lightcolorbase, qboolean modellighting, float ambientscale, float diffusescale, float specularscale);
430 void R_SwitchSurfaceShader(int permutation);
431
432 #endif
433