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