2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
27 extern float ixtable[4096];
30 extern void FOG_clear(void);
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);
42 // SHOWLMP stuff (Nehahra)
43 extern void SHOWLMP_decodehide(void);
44 extern void SHOWLMP_decodeshow(void);
45 extern void SHOWLMP_drawall(void);
47 // render profiling stuff
48 extern int r_timereport_active;
51 extern cvar_t r_ambient;
52 extern cvar_t gl_flashblend;
55 extern cvar_t r_novis;
57 extern cvar_t r_lerpsprites;
58 extern cvar_t r_lerpmodels;
59 extern cvar_t r_lerplightstyles;
60 extern cvar_t r_waterscroll;
62 extern cvar_t developer_texturelogging;
64 // shadow volume bsp struct with automatically growing nodes buffer
65 extern svbsp_t r_svbsp;
67 typedef struct rmesh_s
69 // vertices of this mesh
77 float *texcoordlightmap2f;
79 // triangles of this mesh
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);
96 #define TOP_RANGE 16 // soldier uniform colors
97 #define BOTTOM_RANGE 96
99 //=============================================================================
101 extern cvar_t r_nearclip;
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;
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;
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
127 typedef enum r_refdef_scene_type_s {
131 } r_refdef_scene_type_t;
133 void R_SelectScene( r_refdef_scene_type_t scenetype );
134 r_refdef_scene_t * R_GetScenePointer( r_refdef_scene_type_t scenetype );
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_LoadInternalBGRA(const char *name, int textureflags, const unsigned char *skindata, int width, int height);
144 skinframe_t *R_SkinFrame_LoadInternalQuake(const char *name, int textureflags, int loadpantsandshirt, int loadglowtexture, const unsigned char *skindata, int width, int height);
145 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);
146 skinframe_t *R_SkinFrame_LoadMissing(void);
148 rtexture_t *R_GetCubemap(const char *basename);
150 void R_View_WorldVisibility(qboolean forcenovis);
151 void R_DrawDecals(void);
152 void R_DrawParticles(void);
153 void R_DrawExplosions(void);
155 #define gl_solid_format 3
156 #define gl_alpha_format 4
158 int R_CullBox(const vec3_t mins, const vec3_t maxs);
159 int R_CullBoxCustomPlanes(const vec3_t mins, const vec3_t maxs, int numplanes, const mplane_t *planes);
161 #include "r_modules.h"
163 #include "meshqueue.h"
165 extern qboolean r_framedata_failed;
166 void R_FrameData_Reset(void);
167 void R_FrameData_NewFrame(void);
168 void *R_FrameData_Alloc(size_t size);
169 void *R_FrameData_Store(size_t size, void *data);
171 void R_AnimCache_Free(void);
172 void R_AnimCache_ClearCache(void);
173 qboolean R_AnimCache_GetEntity(entity_render_t *ent, qboolean wantnormals, qboolean wanttangents);
174 void R_AnimCache_CacheVisibleEntities(void);
176 #include "r_lerpanim.h"
178 extern cvar_t r_render;
179 extern cvar_t r_renderview;
180 extern cvar_t r_waterwarp;
182 extern cvar_t r_textureunits;
184 extern cvar_t r_glsl_offsetmapping;
185 extern cvar_t r_glsl_offsetmapping_reliefmapping;
186 extern cvar_t r_glsl_offsetmapping_scale;
187 extern cvar_t r_glsl_deluxemapping;
189 extern cvar_t gl_polyblend;
190 extern cvar_t gl_dither;
192 extern cvar_t cl_deathfade;
194 extern cvar_t r_smoothnormals_areaweighting;
196 extern cvar_t r_test;
198 extern cvar_t r_texture_convertsRGB_2d;
199 extern cvar_t r_texture_convertsRGB_skin;
200 extern cvar_t r_texture_convertsRGB_cubemap;
201 extern cvar_t r_texture_convertsRGB_skybox;
202 extern cvar_t r_texture_convertsRGB_particles;
204 #include "gl_backend.h"
206 extern rtexture_t *r_texture_blanknormalmap;
207 extern rtexture_t *r_texture_white;
208 extern rtexture_t *r_texture_grey128;
209 extern rtexture_t *r_texture_black;
210 extern rtexture_t *r_texture_notexture;
211 extern rtexture_t *r_texture_whitecube;
212 extern rtexture_t *r_texture_normalizationcube;
213 extern rtexture_t *r_texture_fogattenuation;
214 extern rtexture_t *r_texture_fogheighttexture;
216 extern unsigned int r_queries[MAX_OCCLUSION_QUERIES];
217 extern unsigned int r_numqueries;
218 extern unsigned int r_maxqueries;
220 void R_TimeReport(char *name);
223 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);
225 void R_CalcBeam_Vertex3f(float *vert, const vec3_t org1, const vec3_t org2, float width);
226 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);
228 extern mempool_t *r_main_mempool;
230 typedef struct rsurfacestate_s
232 // software processing buffers
234 unsigned char *array_base;
235 r_vertexmesh_t *array_modelvertexmesh;
236 r_vertexmesh_t *array_batchvertexmesh;
237 r_vertexposition_t *array_modelvertexposition;
238 r_vertexposition_t *array_batchvertexposition;
239 float *array_modelvertex3f;
240 float *array_modelsvector3f;
241 float *array_modeltvector3f;
242 float *array_modelnormal3f;
243 float *array_batchvertex3f;
244 float *array_batchsvector3f;
245 float *array_batchtvector3f;
246 float *array_batchnormal3f;
247 float *array_batchlightmapcolor4f;
248 float *array_batchtexcoordtexture2f;
249 float *array_batchtexcoordlightmap2f;
250 float *array_passcolor4f;
251 int *array_batchelement3i;
252 unsigned short *array_batchelement3s;
254 // current model array pointers
255 // these may point to processing buffers if model is animated,
256 // otherwise they point to static data.
257 // these are not directly used for rendering, they are just another level
260 // these either point at array_model* buffers (if the model is animated)
261 // or the model->surfmesh.data_* buffers (if the model is not animated)
263 // these are only set when an entity render begins, they do not change on
264 // a per surface basis.
266 // this indicates the model* arrays are pointed at array_model* buffers
267 // (in other words, the model has been animated in software)
268 qboolean modelgeneratedvertex;
269 const float *modelvertex3f;
270 const r_meshbuffer_t *modelvertex3f_vertexbuffer;
271 size_t modelvertex3f_bufferoffset;
272 const float *modelsvector3f;
273 const r_meshbuffer_t *modelsvector3f_vertexbuffer;
274 size_t modelsvector3f_bufferoffset;
275 const float *modeltvector3f;
276 const r_meshbuffer_t *modeltvector3f_vertexbuffer;
277 size_t modeltvector3f_bufferoffset;
278 const float *modelnormal3f;
279 const r_meshbuffer_t *modelnormal3f_vertexbuffer;
280 size_t modelnormal3f_bufferoffset;
281 const float *modellightmapcolor4f;
282 const r_meshbuffer_t *modellightmapcolor4f_vertexbuffer;
283 size_t modellightmapcolor4f_bufferoffset;
284 const float *modeltexcoordtexture2f;
285 const r_meshbuffer_t *modeltexcoordtexture2f_vertexbuffer;
286 size_t modeltexcoordtexture2f_bufferoffset;
287 const float *modeltexcoordlightmap2f;
288 const r_meshbuffer_t *modeltexcoordlightmap2f_vertexbuffer;
289 size_t modeltexcoordlightmap2f_bufferoffset;
290 const r_vertexmesh_t *modelvertexmesh;
291 const r_meshbuffer_t *modelvertexmeshbuffer;
292 const r_vertexposition_t *modelvertexposition;
293 const r_meshbuffer_t *modelvertexpositionbuffer;
294 const int *modelelement3i;
295 const r_meshbuffer_t *modelelement3i_indexbuffer;
296 size_t modelelement3i_bufferoffset;
297 const unsigned short *modelelement3s;
298 const r_meshbuffer_t *modelelement3s_indexbuffer;
299 size_t modelelement3s_bufferoffset;
300 const int *modellightmapoffsets;
301 int modelnumvertices;
302 int modelnumtriangles;
303 const msurface_t *modelsurfaces;
304 // current rendering array pointers
305 // these may point to any of several different buffers depending on how
306 // much processing was needed to prepare this model for rendering
307 // these usually equal the model* pointers, they only differ if
308 // deformvertexes is used in a q3 shader, and consequently these can
309 // change on a per-surface basis (according to rsurface.texture)
310 qboolean batchgeneratedvertex;
311 int batchfirstvertex;
312 int batchnumvertices;
313 int batchfirsttriangle;
314 int batchnumtriangles;
315 const r_vertexmesh_t *batchvertexmesh;
316 const r_meshbuffer_t *batchvertexmeshbuffer;
317 const r_vertexposition_t *batchvertexposition;
318 const r_meshbuffer_t *batchvertexpositionbuffer;
319 const float *batchvertex3f;
320 const r_meshbuffer_t *batchvertex3f_vertexbuffer;
321 size_t batchvertex3f_bufferoffset;
322 const float *batchsvector3f;
323 const r_meshbuffer_t *batchsvector3f_vertexbuffer;
324 size_t batchsvector3f_bufferoffset;
325 const float *batchtvector3f;
326 const r_meshbuffer_t *batchtvector3f_vertexbuffer;
327 size_t batchtvector3f_bufferoffset;
328 const float *batchnormal3f;
329 const r_meshbuffer_t *batchnormal3f_vertexbuffer;
330 size_t batchnormal3f_bufferoffset;
331 const float *batchlightmapcolor4f;
332 const r_meshbuffer_t *batchlightmapcolor4f_vertexbuffer;
333 size_t batchlightmapcolor4f_bufferoffset;
334 const float *batchtexcoordtexture2f;
335 const r_meshbuffer_t *batchtexcoordtexture2f_vertexbuffer;
336 size_t batchtexcoordtexture2f_bufferoffset;
337 const float *batchtexcoordlightmap2f;
338 const r_meshbuffer_t *batchtexcoordlightmap2f_vertexbuffer;
339 size_t batchtexcoordlightmap2f_bufferoffset;
340 const int *batchelement3i;
341 const r_meshbuffer_t *batchelement3i_indexbuffer;
342 size_t batchelement3i_bufferoffset;
343 const unsigned short *batchelement3s;
344 const r_meshbuffer_t *batchelement3s_indexbuffer;
345 size_t batchelement3s_bufferoffset;
346 // rendering pass processing arrays in GL11 and GL13 paths
347 const float *passcolor4f;
348 const r_meshbuffer_t *passcolor4f_vertexbuffer;
349 size_t passcolor4f_bufferoffset;
351 // some important fields from the entity
355 float ent_shadertime;
356 int ent_alttextures; // used by q1bsp animated textures (pressed buttons)
357 // transform matrices to render this entity and effects on this entity
359 matrix4x4_t inversematrix;
360 // scale factors for transforming lengths into/out of entity space
362 float inversematrixscale;
363 // animation blending state from entity
364 frameblend_t frameblend[MAX_FRAMEBLENDS];
365 skeleton_t *skeleton;
366 // directional model shading state from entity
367 vec3_t modellight_ambient;
368 vec3_t modellight_diffuse;
369 vec3_t modellight_lightdir;
370 // colormapping state from entity (these are black if colormapping is off)
371 vec3_t colormap_pantscolor;
372 vec3_t colormap_shirtcolor;
373 // special coloring of ambient/diffuse textures (gloss not affected)
374 // colormod[3] is the alpha of the entity
376 // special coloring of glow textures
378 // view location in model space
379 vec3_t localvieworigin;
380 // polygon offset data for submodels
381 float basepolygonfactor;
382 float basepolygonoffset;
383 // current textures in batching code
385 rtexture_t *lightmaptexture;
386 rtexture_t *deluxemaptexture;
387 // whether lightmapping is active on this batch
388 // (otherwise vertex colored)
389 qboolean uselightmaptexture;
390 // fog plane in model space for direct application to vertices
392 float fogmasktabledistmultiplier;
395 float fogplaneviewdist;
398 // light currently being rendered
399 const rtlight_t *rtlight;
401 // this is the location of the light in entity space
402 vec3_t entitylightorigin;
403 // this transforms entity coordinates to light filter cubemap coordinates
404 // (also often used for other purposes)
405 matrix4x4_t entitytolight;
406 // based on entitytolight this transforms -1 to +1 to 0 to 1 for purposes
407 // of attenuation texturing in full 3D (Z result often ignored)
408 matrix4x4_t entitytoattenuationxyz;
409 // this transforms only the Z to S, and T is always 0.5
410 matrix4x4_t entitytoattenuationz;
412 // pointer to an entity_render_t used only by R_GetCurrentTexture and
413 // RSurf_ActiveWorldEntity/RSurf_ActiveModelEntity as a unique id within
414 // each frame (see r_frame also)
415 entity_render_t *entity;
419 extern rsurfacestate_t rsurface;
421 void RSurf_ActiveWorldEntity(void);
422 void RSurf_ActiveModelEntity(const entity_render_t *ent, qboolean wantnormals, qboolean wanttangents, qboolean prepass);
423 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);
424 void RSurf_SetupDepthAndCulling(void);
426 void R_Mesh_ResizeArrays(int newvertices);
428 texture_t *R_GetCurrentTexture(texture_t *t);
429 void R_DrawWorldSurfaces(qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug, qboolean prepass);
430 void R_DrawModelSurfaces(entity_render_t *ent, qboolean skysurfaces, qboolean writedepth, qboolean depthonly, qboolean debug, qboolean prepass);
431 void R_AddWaterPlanes(entity_render_t *ent);
432 void R_DrawCustomSurface(skinframe_t *skinframe, const matrix4x4_t *texmatrix, int materialflags, int firstvertex, int numvertices, int firsttriangle, int numtriangles, qboolean writedepth, qboolean prepass);
433 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);
435 #define BATCHNEED_VERTEXPOSITION (1<< 0) // set up rsurface.batchvertexposition
436 #define BATCHNEED_VERTEXMESH_VERTEX (1<< 1) // set up rsurface.batchvertexmesh
437 #define BATCHNEED_VERTEXMESH_NORMAL (1<< 2) // set up normals in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchnormal3f if BATCHNEED_ARRAYS
438 #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
439 #define BATCHNEED_VERTEXMESH_VERTEXCOLOR (1<< 4) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
440 #define BATCHNEED_VERTEXMESH_TEXCOORD (1<< 5) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
441 #define BATCHNEED_VERTEXMESH_LIGHTMAP (1<< 6) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
442 #define BATCHNEED_ARRAY_VERTEX (1<< 7) // set up rsurface.batchvertex3f and optionally others
443 #define BATCHNEED_ARRAY_NORMAL (1<< 8) // set up normals in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchnormal3f if BATCHNEED_ARRAYS
444 #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
445 #define BATCHNEED_ARRAY_VERTEXCOLOR (1<<10) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
446 #define BATCHNEED_ARRAY_TEXCOORD (1<<11) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
447 #define BATCHNEED_ARRAY_LIGHTMAP (1<<12) // set up vertex colors in rsurface.batchvertexmesh if BATCHNEED_MESH, set up rsurface.batchlightmapcolor4f if BATCHNEED_ARRAYS
448 #define BATCHNEED_NOGAPS (1<<13) // force vertex copying (no gaps)
449 void RSurf_PrepareVerticesForBatch(int batchneed, int texturenumsurfaces, const msurface_t **texturesurfacelist);
450 void RSurf_DrawBatch(void);
452 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);
454 typedef enum rsurfacepass_e
457 RSURFPASS_BACKGROUND,
459 RSURFPASS_DEFERREDGEOMETRY,
463 typedef enum gl20_texunit_e
465 // postprocess shaders, and generic shaders:
468 GL20TU_GAMMARAMPS = 2,
469 // standard material properties
474 // material properties for a second material
475 GL20TU_SECONDARY_NORMAL = 4,
476 GL20TU_SECONDARY_COLOR = 5,
477 GL20TU_SECONDARY_GLOSS = 6,
478 GL20TU_SECONDARY_GLOW = 7,
479 // material properties for a colormapped material
480 // conflicts with secondary material
483 // fog fade in the distance
485 // compiled ambient lightmap and deluxemap
487 GL20TU_DELUXEMAP = 10,
488 // refraction, used by water shaders
489 GL20TU_REFRACTION = 3,
490 // reflection, used by water shaders, also with normal material rendering
491 // conflicts with secondary material
492 GL20TU_REFLECTION = 7,
493 // rtlight attenuation (distance fade) and cubemap filter (projection texturing)
494 // conflicts with lightmap/deluxemap
495 GL20TU_ATTENUATION = 9,
497 GL20TU_SHADOWMAPRECT = 11,
498 GL20TU_SHADOWMAPCUBE = 11,
499 GL20TU_SHADOWMAP2D = 11,
500 GL20TU_CUBEPROJECTION = 12,
501 // orthographic-projection shadowmapping
502 GL20TU_SHADOWMAPORTHORECT = 15,
503 GL20TU_SHADOWMAPORTHO2D = 15,
504 // rtlight prepass data (screenspace depth and normalmap)
505 GL20TU_SCREENDEPTH = 13,
506 GL20TU_SCREENNORMALMAP = 14,
507 // lightmap prepass data (screenspace diffuse and specular from lights)
508 GL20TU_SCREENDIFFUSE = 11,
509 GL20TU_SCREENSPECULAR = 12,
511 GL20TU_REFLECTMASK = 5,
512 GL20TU_REFLECTCUBE = 6,
513 GL20TU_FOGHEIGHTTEXTURE = 14
517 void R_SetupShader_Generic(rtexture_t *first, rtexture_t *second, int texturemode, int rgbscale);
518 void R_SetupShader_DepthOrShadow(void);
519 void R_SetupShader_ShowDepth(void);
520 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);
521 void R_SetupShader_DeferredLight(const rtlight_t *rtlight);
523 typedef struct r_waterstate_waterplane_s
525 rtexture_t *texture_refraction;
526 rtexture_t *texture_reflection;
527 rtexture_t *texture_camera;
529 int materialflags; // combined flags of all water surfaces on this plane
530 unsigned char pvsbits[(MAX_MAP_LEAFS+7)>>3]; // FIXME: buffer overflow on huge maps
534 r_waterstate_waterplane_t;
536 typedef struct r_waterstate_s
540 qboolean renderingscene; // true while rendering a refraction or reflection texture, disables water surfaces
541 qboolean renderingrefraction;
543 int waterwidth, waterheight;
544 int texturewidth, textureheight;
545 int camerawidth, cameraheight;
547 int maxwaterplanes; // same as MAX_WATERPLANES
549 r_waterstate_waterplane_t waterplanes[MAX_WATERPLANES];
551 float screenscale[2];
552 float screencenter[2];
556 extern r_waterstate_t r_waterstate;