client.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 // client.h
  21
  22 #ifndef CLIENT_H
  23 #define CLIENT_H
  24
  25 #include "matrixlib.h"
  26 #include "snd_main.h"
  27
  28 // NOTE: r_stat_name[] must match this indexing
  29 typedef enum r_stat_e
  30 {
  31         r_stat_timedelta,
  32         r_stat_quality,
  33         r_stat_renders,
  34         r_stat_entities,
  35         r_stat_entities_surfaces,
  36         r_stat_entities_triangles,
  37         r_stat_world_leafs,
  38         r_stat_world_portals,
  39         r_stat_world_surfaces,
  40         r_stat_world_triangles,
  41         r_stat_lightmapupdates,
  42         r_stat_lightmapupdatepixels,
  43         r_stat_particles,
  44         r_stat_drawndecals,
  45         r_stat_totaldecals,
  46         r_stat_draws,
  47         r_stat_draws_vertices,
  48         r_stat_draws_elements,
  49         r_stat_lights,
  50         r_stat_lights_clears,
  51         r_stat_lights_scissored,
  52         r_stat_lights_lighttriangles,
  53         r_stat_lights_shadowtriangles,
  54         r_stat_lights_dynamicshadowtriangles,
  55         r_stat_bouncegrid_lights,
  56         r_stat_bouncegrid_particles,
  57         r_stat_bouncegrid_traces,
  58         r_stat_bouncegrid_hits,
  59         r_stat_bouncegrid_splats,
  60         r_stat_bouncegrid_bounces,
  61         r_stat_photoncache_animated,
  62         r_stat_photoncache_cached,
  63         r_stat_photoncache_traced,
  64         r_stat_bloom,
  65         r_stat_bloom_copypixels,
  66         r_stat_bloom_drawpixels,
  67         r_stat_rendertargets_used,
  68         r_stat_rendertargets_pixels,
  69         r_stat_indexbufferuploadcount,
  70         r_stat_indexbufferuploadsize,
  71         r_stat_vertexbufferuploadcount,
  72         r_stat_vertexbufferuploadsize,
  73         r_stat_framedatacurrent,
  74         r_stat_framedatasize,
  75         r_stat_bufferdatacurrent_vertex, // R_BUFFERDATA_ types are added to this index
  76         r_stat_bufferdatacurrent_index16,
  77         r_stat_bufferdatacurrent_index32,
  78         r_stat_bufferdatacurrent_uniform,
  79         r_stat_bufferdatasize_vertex, // R_BUFFERDATA_ types are added to this index
  80         r_stat_bufferdatasize_index16,
  81         r_stat_bufferdatasize_index32,
  82         r_stat_bufferdatasize_uniform,
  83         r_stat_animcache_skeletal_count,
  84         r_stat_animcache_skeletal_bones,
  85         r_stat_animcache_skeletal_maxbones,
  86         r_stat_animcache_shade_count,
  87         r_stat_animcache_shade_vertices,
  88         r_stat_animcache_shade_maxvertices,
  89         r_stat_animcache_shape_count,
  90         r_stat_animcache_shape_vertices,
  91         r_stat_animcache_shape_maxvertices,
  92         r_stat_batch_batches,
  93         r_stat_batch_withgaps,
  94         r_stat_batch_surfaces,
  95         r_stat_batch_vertices,
  96         r_stat_batch_triangles,
  97         r_stat_batch_fast_batches,
  98         r_stat_batch_fast_surfaces,
  99         r_stat_batch_fast_vertices,
 100         r_stat_batch_fast_triangles,
 101         r_stat_batch_copytriangles_batches,
 102         r_stat_batch_copytriangles_surfaces,
 103         r_stat_batch_copytriangles_vertices,
 104         r_stat_batch_copytriangles_triangles,
 105         r_stat_batch_dynamic_batches,
 106         r_stat_batch_dynamic_surfaces,
 107         r_stat_batch_dynamic_vertices,
 108         r_stat_batch_dynamic_triangles,
 109         r_stat_batch_dynamicskeletal_batches,
 110         r_stat_batch_dynamicskeletal_surfaces,
 111         r_stat_batch_dynamicskeletal_vertices,
 112         r_stat_batch_dynamicskeletal_triangles,
 113         r_stat_batch_dynamic_batches_because_cvar,
 114         r_stat_batch_dynamic_surfaces_because_cvar,
 115         r_stat_batch_dynamic_vertices_because_cvar,
 116         r_stat_batch_dynamic_triangles_because_cvar,
 117         r_stat_batch_dynamic_batches_because_lightmapvertex,
 118         r_stat_batch_dynamic_surfaces_because_lightmapvertex,
 119         r_stat_batch_dynamic_vertices_because_lightmapvertex,
 120         r_stat_batch_dynamic_triangles_because_lightmapvertex,
 121         r_stat_batch_dynamic_batches_because_deformvertexes_autosprite,
 122         r_stat_batch_dynamic_surfaces_because_deformvertexes_autosprite,
 123         r_stat_batch_dynamic_vertices_because_deformvertexes_autosprite,
 124         r_stat_batch_dynamic_triangles_because_deformvertexes_autosprite,
 125         r_stat_batch_dynamic_batches_because_deformvertexes_autosprite2,
 126         r_stat_batch_dynamic_surfaces_because_deformvertexes_autosprite2,
 127         r_stat_batch_dynamic_vertices_because_deformvertexes_autosprite2,
 128         r_stat_batch_dynamic_triangles_because_deformvertexes_autosprite2,
 129         r_stat_batch_dynamic_batches_because_deformvertexes_normal,
 130         r_stat_batch_dynamic_surfaces_because_deformvertexes_normal,
 131         r_stat_batch_dynamic_vertices_because_deformvertexes_normal,
 132         r_stat_batch_dynamic_triangles_because_deformvertexes_normal,
 133         r_stat_batch_dynamic_batches_because_deformvertexes_wave,
 134         r_stat_batch_dynamic_surfaces_because_deformvertexes_wave,
 135         r_stat_batch_dynamic_vertices_because_deformvertexes_wave,
 136         r_stat_batch_dynamic_triangles_because_deformvertexes_wave,
 137         r_stat_batch_dynamic_batches_because_deformvertexes_bulge,
 138         r_stat_batch_dynamic_surfaces_because_deformvertexes_bulge,
 139         r_stat_batch_dynamic_vertices_because_deformvertexes_bulge,
 140         r_stat_batch_dynamic_triangles_because_deformvertexes_bulge,
 141         r_stat_batch_dynamic_batches_because_deformvertexes_move,
 142         r_stat_batch_dynamic_surfaces_because_deformvertexes_move,
 143         r_stat_batch_dynamic_vertices_because_deformvertexes_move,
 144         r_stat_batch_dynamic_triangles_because_deformvertexes_move,
 145         r_stat_batch_dynamic_batches_because_tcgen_lightmap,
 146         r_stat_batch_dynamic_surfaces_because_tcgen_lightmap,
 147         r_stat_batch_dynamic_vertices_because_tcgen_lightmap,
 148         r_stat_batch_dynamic_triangles_because_tcgen_lightmap,
 149         r_stat_batch_dynamic_batches_because_tcgen_vector,
 150         r_stat_batch_dynamic_surfaces_because_tcgen_vector,
 151         r_stat_batch_dynamic_vertices_because_tcgen_vector,
 152         r_stat_batch_dynamic_triangles_because_tcgen_vector,
 153         r_stat_batch_dynamic_batches_because_tcgen_environment,
 154         r_stat_batch_dynamic_surfaces_because_tcgen_environment,
 155         r_stat_batch_dynamic_vertices_because_tcgen_environment,
 156         r_stat_batch_dynamic_triangles_because_tcgen_environment,
 157         r_stat_batch_dynamic_batches_because_tcmod_turbulent,
 158         r_stat_batch_dynamic_surfaces_because_tcmod_turbulent,
 159         r_stat_batch_dynamic_vertices_because_tcmod_turbulent,
 160         r_stat_batch_dynamic_triangles_because_tcmod_turbulent,
 161         r_stat_batch_dynamic_batches_because_nogaps,
 162         r_stat_batch_dynamic_surfaces_because_nogaps,
 163         r_stat_batch_dynamic_vertices_because_nogaps,
 164         r_stat_batch_dynamic_triangles_because_nogaps,
 165         r_stat_batch_dynamic_batches_because_derived,
 166         r_stat_batch_dynamic_surfaces_because_derived,
 167         r_stat_batch_dynamic_vertices_because_derived,
 168         r_stat_batch_dynamic_triangles_because_derived,
 169         r_stat_batch_entitycache_count,
 170         r_stat_batch_entitycache_surfaces,
 171         r_stat_batch_entitycache_vertices,
 172         r_stat_batch_entitycache_triangles,
 173         r_stat_batch_entityanimate_count,
 174         r_stat_batch_entityanimate_surfaces,
 175         r_stat_batch_entityanimate_vertices,
 176         r_stat_batch_entityanimate_triangles,
 177         r_stat_batch_entityskeletal_count,
 178         r_stat_batch_entityskeletal_surfaces,
 179         r_stat_batch_entityskeletal_vertices,
 180         r_stat_batch_entityskeletal_triangles,
 181         r_stat_batch_entitystatic_count,
 182         r_stat_batch_entitystatic_surfaces,
 183         r_stat_batch_entitystatic_vertices,
 184         r_stat_batch_entitystatic_triangles,
 185         r_stat_batch_entitycustom_count,
 186         r_stat_batch_entitycustom_surfaces,
 187         r_stat_batch_entitycustom_vertices,
 188         r_stat_batch_entitycustom_triangles,
 189         r_stat_count // size of array
 190 }
 191 r_stat_t;
 192
 193 // flags for rtlight rendering
 194 #define LIGHTFLAG_NORMALMODE 1
 195 #define LIGHTFLAG_REALTIMEMODE 2
 196
 197 typedef struct tridecal_s
 198 {
 199         // color and initial alpha value
 200         float                   texcoord2f[3][2];
 201         float                   vertex3f[3][3];
 202         float                   color4f[3][4];
 203         float                   plane[4]; // backface culling
 204         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
 205         float                   lived;
 206         // if >= 0 this indicates the decal should follow an animated triangle
 207         int                             triangleindex;
 208         // for visibility culling
 209         int                             surfaceindex;
 210         // old decals are killed to obey cl_decals_max
 211         unsigned int    decalsequence;
 212 }
 213 tridecal_t;
 214
 215 typedef struct decalsystem_s
 216 {
 217         dp_model_t *model;
 218         double lastupdatetime;
 219         int maxdecals;
 220         int freedecal;
 221         int numdecals;
 222         tridecal_t *decals;
 223         float *vertex3f;
 224         float *texcoord2f;
 225         float *color4f;
 226         int *element3i;
 227         unsigned short *element3s;
 228 }
 229 decalsystem_t;
 230
 231 typedef struct effect_s
 232 {
 233         int active;
 234         vec3_t origin;
 235         double starttime;
 236         float framerate;
 237         int modelindex;
 238         int startframe;
 239         int endframe;
 240         // these are for interpolation
 241         int frame;
 242         double frame1time;
 243         double frame2time;
 244 }
 245 cl_effect_t;
 246
 247 typedef struct beam_s
 248 {
 249         int             entity;
 250         // draw this as lightning polygons, or a model?
 251         int             lightning;
 252         struct model_s  *model;
 253         float   endtime;
 254         vec3_t  start, end;
 255 }
 256 beam_t;
 257
 258 typedef struct rtlight_particle_s
 259 {
 260         float origin[3];
 261         float color[3];
 262 }
 263 rtlight_particle_t;
 264
 265 typedef struct rtlight_s
 266 {
 267         // note that the world to light matrices are inversely scaled (divided) by lightradius
 268
 269         // core properties
 270         /// matrix for transforming light filter coordinates to world coordinates
 271         matrix4x4_t matrix_lighttoworld;
 272         /// matrix for transforming world coordinates to light filter coordinates
 273         matrix4x4_t matrix_worldtolight;
 274         /// typically 1 1 1, can be lower (dim) or higher (overbright)
 275         vec3_t color;
 276         /// size of the light (remove?)
 277         vec_t radius;
 278         /// light filter
 279         char cubemapname[64];
 280         /// light style to monitor for brightness
 281         int style;
 282         /// whether light should render shadows (see castshadows for whether it actually does this frame)
 283         int shadow;
 284         /// intensity of corona to render
 285         vec_t corona;
 286         /// radius scale of corona to render (1.0 means same as light radius)
 287         vec_t coronasizescale;
 288         /// ambient intensity to render
 289         vec_t ambientscale;
 290         /// diffuse intensity to render
 291         vec_t diffusescale;
 292         /// specular intensity to render
 293         vec_t specularscale;
 294         /// LIGHTFLAG_* flags
 295         int flags;
 296
 297         // generated properties
 298         /// used only for casting shadows
 299         vec3_t shadoworigin;
 300         /// culling
 301         vec3_t cullmins;
 302         vec3_t cullmaxs;
 303         /// when r_shadow_culllights_trace is set, this is refreshed by each successful trace.
 304         double trace_timer;
 305
 306         // rendering properties, updated each time a light is rendered
 307         // this is rtlight->color * d_lightstylevalue
 308         vec3_t currentcolor;
 309         /// used by corona updates, due to occlusion query
 310         float corona_visibility;
 311         unsigned int corona_queryindex_visiblepixels;
 312         unsigned int corona_queryindex_allpixels;
 313         /// this is R_GetCubemap(rtlight->cubemapname)
 314         rtexture_t *currentcubemap;
 315         /// set by R_Shadow_PrepareLight to decide whether R_Shadow_DrawLight should draw it
 316         qboolean draw;
 317         /// set by R_Shadow_PrepareLight to indicate whether R_Shadow_DrawShadowMaps should do anything
 318         qboolean castshadows;
 319         /// these fields are set by R_Shadow_PrepareLight for later drawing
 320         int cached_numlightentities;
 321         int cached_numlightentities_noselfshadow;
 322         int cached_numshadowentities;
 323         int cached_numshadowentities_noselfshadow;
 324         int cached_numsurfaces;
 325         struct entity_render_s **cached_lightentities;
 326         struct entity_render_s **cached_lightentities_noselfshadow;
 327         struct entity_render_s **cached_shadowentities;
 328         struct entity_render_s **cached_shadowentities_noselfshadow;
 329         unsigned char *cached_shadowtrispvs;
 330         unsigned char *cached_lighttrispvs;
 331         int *cached_surfacelist;
 332         // reduced light cullbox from GetLightInfo
 333         vec3_t cached_cullmins;
 334         vec3_t cached_cullmaxs;
 335         // current shadow-caster culling planes based on view
 336         // (any geometry outside these planes can not contribute to the visible
 337         //  shadows in any way, and thus can be culled safely)
 338         int cached_numfrustumplanes;
 339         mplane_t cached_frustumplanes[5]; // see R_Shadow_ComputeShadowCasterCullingPlanes
 340
 341         /// static light info
 342         /// true if this light should be compiled as a static light
 343         int isstatic;
 344         /// true if this is a compiled world light, cleared if the light changes
 345         int compiled;
 346         /// the shadowing mode used to compile this light
 347         int shadowmode;
 348         /// the size that this light should have (assuming no scene LOD kicking in to reduce it)
 349         int shadowmapsidesize;
 350         /// position of this light in the shadowmap atlas
 351         int shadowmapatlasposition[2];
 352         /// size of one side of this light in the shadowmap atlas (for omnidirectional shadowmaps this is the min corner of a 2x3 arrangement, or a 4x3 arrangement in the case of noselfshadow entities being present)
 353         int shadowmapatlassidesize;
 354         /// optimized and culled mesh to render for world entity shadows
 355         shadowmesh_t *static_meshchain_shadow_shadowmap;
 356         /// used for visibility testing (more exact than bbox)
 357         int static_numleafs;
 358         int static_numleafpvsbytes;
 359         int *static_leaflist;
 360         unsigned char *static_leafpvs;
 361         /// surfaces seen by light
 362         int static_numsurfaces;
 363         int *static_surfacelist;
 364         /// flag bits indicating which triangles of the world model should cast
 365         /// shadows, and which ones should be lit
 366         ///
 367         /// this avoids redundantly scanning the triangles in each surface twice
 368         /// for whether they should cast shadows, once in culling and once in the
 369         /// actual shadowmarklist production.
 370         int static_numshadowtrispvsbytes;
 371         unsigned char *static_shadowtrispvs;
 372         /// this allows the lighting batch code to skip backfaces andother culled
 373         /// triangles not relevant for lighting
 374         /// (important on big surfaces such as terrain)
 375         int static_numlighttrispvsbytes;
 376         unsigned char *static_lighttrispvs;
 377         /// masks of all shadowmap sides that have any potential static receivers or casters
 378         int static_shadowmap_receivers;
 379         int static_shadowmap_casters;
 380         /// particle-tracing cache for global illumination
 381         int particlecache_numparticles;
 382         int particlecache_maxparticles;
 383         int particlecache_updateparticle;
 384         rtlight_particle_t *particlecache_particles;
 385
 386         /// bouncegrid light info
 387         float bouncegrid_photoncolor[3];
 388         float bouncegrid_photons;
 389         int bouncegrid_hits;
 390         int bouncegrid_traces;
 391         float bouncegrid_effectiveradius;
 392 }
 393 rtlight_t;
 394
 395 typedef struct dlight_s
 396 {
 397         // destroy light after this time
 398         // (dlight only)
 399         vec_t die;
 400         // the entity that owns this light (can be NULL)
 401         // (dlight only)
 402         struct entity_render_s *ent;
 403         // location
 404         // (worldlight: saved to .rtlights file)
 405         vec3_t origin;
 406         // worldlight orientation
 407         // (worldlight only)
 408         // (worldlight: saved to .rtlights file)
 409         vec3_t angles;
 410         // dlight orientation/scaling/location
 411         // (dlight only)
 412         matrix4x4_t matrix;
 413         // color of light
 414         // (worldlight: saved to .rtlights file)
 415         vec3_t color;
 416         // cubemap name to use on this light
 417         // (worldlight: saved to .rtlights file)
 418         char cubemapname[64];
 419         // make light flash while selected
 420         // (worldlight only)
 421         int selected;
 422         // brightness (not really radius anymore)
 423         // (worldlight: saved to .rtlights file)
 424         vec_t radius;
 425         // drop intensity this much each second
 426         // (dlight only)
 427         vec_t decay;
 428         // intensity value which is dropped over time
 429         // (dlight only)
 430         vec_t intensity;
 431         // initial values for intensity to modify
 432         // (dlight only)
 433         vec_t initialradius;
 434         vec3_t initialcolor;
 435         // light style which controls intensity of this light
 436         // (worldlight: saved to .rtlights file)
 437         int style;
 438         // cast shadows
 439         // (worldlight: saved to .rtlights file)
 440         int shadow;
 441         // corona intensity
 442         // (worldlight: saved to .rtlights file)
 443         vec_t corona;
 444         // radius scale of corona to render (1.0 means same as light radius)
 445         // (worldlight: saved to .rtlights file)
 446         vec_t coronasizescale;
 447         // ambient intensity to render
 448         // (worldlight: saved to .rtlights file)
 449         vec_t ambientscale;
 450         // diffuse intensity to render
 451         // (worldlight: saved to .rtlights file)
 452         vec_t diffusescale;
 453         // specular intensity to render
 454         // (worldlight: saved to .rtlights file)
 455         vec_t specularscale;
 456         // LIGHTFLAG_* flags
 457         // (worldlight: saved to .rtlights file)
 458         int flags;
 459         // linked list of world lights
 460         // (worldlight only)
 461         struct dlight_s *next;
 462         // embedded rtlight struct for renderer
 463         // (worldlight only)
 464         rtlight_t rtlight;
 465 }
 466 dlight_t;
 467
 468 // this is derived from processing of the framegroupblend array
 469 // note: technically each framegroupblend can produce two of these, but that
 470 // never happens in practice because no one blends between more than 2
 471 // framegroups at once
 472 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
 473 typedef struct frameblend_s
 474 {
 475         int subframe;
 476         float lerp;
 477 }
 478 frameblend_t;
 479
 480 // LadyHavoc: this struct is intended for the renderer but some fields are
 481 // used by the client.
 482 //
 483 // The renderer should not rely on any changes to this struct to be persistent
 484 // across multiple frames because temp entities are wiped every frame, but it
 485 // is acceptable to cache things in this struct that are not critical.
 486 //
 487 // For example the r_cullentities_trace code does such caching.
 488 typedef struct entity_render_s
 489 {
 490         // location
 491         //vec3_t origin;
 492         // orientation
 493         //vec3_t angles;
 494         // transform matrix for model to world
 495         matrix4x4_t matrix;
 496         // transform matrix for world to model
 497         matrix4x4_t inversematrix;
 498         // opacity (alpha) of the model
 499         float alpha;
 500         // size the model is shown
 501         float scale;
 502         // transparent sorting offset
 503         float transparent_offset;
 504
 505         // NULL = no model
 506         dp_model_t *model;
 507         // number of the entity represents, or 0 for non-network entities
 508         int entitynumber;
 509         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
 510         vec3_t colormap_pantscolor;
 511         vec3_t colormap_shirtcolor;
 512         // light, particles, etc
 513         int effects;
 514         // qw CTF flags and other internal-use-only effect bits
 515         int internaleffects;
 516         // for Alias models
 517         int skinnum;
 518         // render flags
 519         int flags;
 520
 521         // colormod tinting of models
 522         float colormod[3];
 523         float glowmod[3];
 524
 525         // interpolated animation - active framegroups and blend factors
 526         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
 527
 528         // time of last model change (for shader animations)
 529         double shadertime;
 530
 531         // calculated by the renderer (but not persistent)
 532
 533         // calculated during R_AddModelEntities
 534         vec3_t mins, maxs;
 535         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
 536         frameblend_t frameblend[MAX_FRAMEBLENDS];
 537         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
 538         skeleton_t *skeleton;
 539
 540         // animation cache (pointers allocated using R_FrameData_Alloc)
 541         // ONLY valid during R_RenderView!  may be NULL (not cached)
 542         float          *animcache_vertex3f;
 543         r_meshbuffer_t *animcache_vertex3f_vertexbuffer;
 544         int             animcache_vertex3f_bufferoffset;
 545         float          *animcache_normal3f;
 546         r_meshbuffer_t *animcache_normal3f_vertexbuffer;
 547         int             animcache_normal3f_bufferoffset;
 548         float          *animcache_svector3f;
 549         r_meshbuffer_t *animcache_svector3f_vertexbuffer;
 550         int             animcache_svector3f_bufferoffset;
 551         float          *animcache_tvector3f;
 552         r_meshbuffer_t *animcache_tvector3f_vertexbuffer;
 553         int             animcache_tvector3f_bufferoffset;
 554         // gpu-skinning shader needs transforms in a certain format, we have to
 555         // upload this to a uniform buffer for the shader to use, and also keep a
 556         // backup copy in system memory for the dynamic batch fallback code
 557         // if this is not NULL, the other animcache variables are NULL
 558         float *animcache_skeletaltransform3x4;
 559         r_meshbuffer_t *animcache_skeletaltransform3x4buffer;
 560         int animcache_skeletaltransform3x4offset;
 561         int animcache_skeletaltransform3x4size;
 562
 563         // CL_UpdateEntityShading reads these fields
 564         // used only if RENDER_CUSTOMIZEDMODELLIGHT is set
 565         vec3_t custommodellight_ambient;
 566         vec3_t custommodellight_diffuse;
 567         vec3_t custommodellight_lightdir;
 568         // CSQC entities get their shading from the root of their attachment chain
 569         float custommodellight_origin[3];
 570
 571         // derived lighting parameters (CL_UpdateEntityShading)
 572
 573         // used by MATERIALFLAG_FULLBRIGHT which is MATERIALFLAG_MODELLIGHT with
 574         // this as ambient color, along with MATERIALFLAG_NORTLIGHT
 575         float render_fullbright[3];
 576         // color tint for the base pass glow textures if any
 577         float render_glowmod[3];
 578         // MATERIALFLAG_MODELLIGHT uses these parameters
 579         float render_modellight_ambient[3];
 580         float render_modellight_diffuse[3];
 581         float render_modellight_lightdir[3];
 582         float render_modellight_specular[3];
 583         // lightmap rendering (not MATERIALFLAG_MODELLIGHT)
 584         float render_lightmap_ambient[3];
 585         float render_lightmap_diffuse[3];
 586         float render_lightmap_specular[3];
 587         // rtlights use these colors for the materials on this entity
 588         float render_rtlight_diffuse[3];
 589         float render_rtlight_specular[3];
 590         // ignore lightmap and use lightgrid on this entity (e.g. FULLBRIGHT)
 591         qboolean render_modellight_forced;
 592         // do not process per pixel lights on this entity at all (like MATERIALFLAG_NORTLIGHT)
 593         qboolean render_rtlight_disabled;
 594
 595         // storage of decals on this entity
 596         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
 597         int allowdecals;
 598         decalsystem_t decalsystem;
 599
 600         // FIELDS UPDATED BY RENDERER:
 601         // last time visible during trace culling
 602         double last_trace_visibility;
 603
 604         // user wavefunc parameters (from csqc)
 605         vec_t userwavefunc_param[Q3WAVEFUNC_USER_COUNT];
 606 }
 607 entity_render_t;
 608
 609 typedef struct entity_persistent_s
 610 {
 611         vec3_t trail_origin; // previous position for particle trail spawning
 612         vec3_t oldorigin; // lerp
 613         vec3_t oldangles; // lerp
 614         vec3_t neworigin; // lerp
 615         vec3_t newangles; // lerp
 616         vec_t lerpstarttime; // lerp
 617         vec_t lerpdeltatime; // lerp
 618         float muzzleflash; // muzzleflash intensity, fades over time
 619         float trail_time; // residual error accumulation for particle trail spawning (to keep spacing across frames)
 620         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
 621 }
 622 entity_persistent_t;
 623
 624 typedef struct entity_s
 625 {
 626         // baseline state (default values)
 627         entity_state_t state_baseline;
 628         // previous state (interpolating from this)
 629         entity_state_t state_previous;
 630         // current state (interpolating to this)
 631         entity_state_t state_current;
 632
 633         // used for regenerating parts of render
 634         entity_persistent_t persistent;
 635
 636         // the only data the renderer should know about
 637         entity_render_t render;
 638 }
 639 entity_t;
 640
 641 typedef struct usercmd_s
 642 {
 643         vec3_t  viewangles;
 644
 645 // intended velocities
 646         float   forwardmove;
 647         float   sidemove;
 648         float   upmove;
 649
 650         vec3_t  cursor_screen;
 651         vec3_t  cursor_start;
 652         vec3_t  cursor_end;
 653         vec3_t  cursor_impact;
 654         vec3_t  cursor_normal;
 655         vec_t   cursor_fraction;
 656         int             cursor_entitynumber;
 657
 658         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
 659         double receivetime; // time the move was received at
 660         double clienttime; // time to which server state the move corresponds to
 661         int msec; // for predicted moves
 662         int buttons;
 663         int impulse;
 664         unsigned int sequence;
 665         qboolean applied; // if false we're still accumulating a move
 666         qboolean predicted; // if true the sequence should be sent as 0
 667
 668         // derived properties
 669         double frametime;
 670         qboolean canjump;
 671         qboolean jump;
 672         qboolean crouch;
 673 } usercmd_t;
 674
 675 typedef struct lightstyle_s
 676 {
 677         int             length;
 678         char    map[MAX_STYLESTRING];
 679 } lightstyle_t;
 680
 681 typedef struct scoreboard_s
 682 {
 683         char    name[MAX_SCOREBOARDNAME];
 684         int             frags;
 685         int             colors; // two 4 bit fields
 686         // QW fields:
 687         int             qw_userid;
 688         char    qw_userinfo[MAX_USERINFO_STRING];
 689         float   qw_entertime;
 690         int             qw_ping;
 691         int             qw_packetloss;
 692         int             qw_movementloss;
 693         int             qw_spectator;
 694         char    qw_team[8];
 695         char    qw_skin[MAX_QPATH];
 696 } scoreboard_t;
 697
 698 typedef struct cshift_s
 699 {
 700         float   destcolor[3];
 701         float   percent;                // 0-255
 702         float   alphafade;      // (any speed)
 703 } cshift_t;
 704
 705 #define CSHIFT_CONTENTS 0
 706 #define CSHIFT_DAMAGE   1
 707 #define CSHIFT_BONUS    2
 708 #define CSHIFT_POWERUP  3
 709 #define CSHIFT_VCSHIFT  4
 710 #define NUM_CSHIFTS             5
 711
 712 #define NAME_LENGTH     64
 713
 714
 715 //
 716 // client_state_t should hold all pieces of the client state
 717 //
 718
 719 #define SIGNONS         4                       // signon messages to receive before connected
 720
 721 typedef enum cactive_e
 722 {
 723         ca_uninitialized,       // during early startup
 724         ca_dedicated,           // a dedicated server with no ability to start a client
 725         ca_disconnected,        // full screen console with no connection
 726         ca_connected            // valid netcon, talking to a server
 727 }
 728 cactive_t;
 729
 730 typedef enum qw_downloadtype_e
 731 {
 732         dl_none,
 733         dl_single,
 734         dl_skin,
 735         dl_model,
 736         dl_sound
 737 }
 738 qw_downloadtype_t;
 739
 740 typedef enum capturevideoformat_e
 741 {
 742         CAPTUREVIDEOFORMAT_AVI_I420,
 743         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA
 744 }
 745 capturevideoformat_t;
 746
 747 typedef struct capturevideostate_s
 748 {
 749         double startrealtime;
 750         double framerate;
 751         int framestep;
 752         int framestepframe;
 753         qboolean active;
 754         qboolean realtime;
 755         qboolean error;
 756         int soundrate;
 757         int soundchannels;
 758         int frame;
 759         double starttime;
 760         double lastfpstime;
 761         int lastfpsframe;
 762         int soundsampleframe;
 763         unsigned char *screenbuffer;
 764         unsigned char *outbuffer;
 765         char basename[MAX_QPATH];
 766         int width, height;
 767
 768         // precomputed RGB to YUV tables
 769         // converts the RGB values to YUV (see cap_avi.c for how to use them)
 770         short rgbtoyuvscaletable[3][3][256];
 771         unsigned char yuvnormalizetable[3][256];
 772
 773         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
 774         // note: to map from these values to RGB24, you have to multiply by 255.0/65535.0, then add 0.5, then cast to integer
 775         unsigned short vidramp[256 * 3];
 776
 777         // stuff to be filled in by the video format module
 778         capturevideoformat_t format;
 779         const char *formatextension;
 780         qfile_t *videofile;
 781                 // always use this:
 782                 //   cls.capturevideo.videofile = FS_OpenRealFile(va(vabuf, sizeof(vabuf), "%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
 783         void (*endvideo) (void);
 784         void (*videoframes) (int num);
 785         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
 786
 787         // format specific data
 788         void *formatspecific;
 789 }
 790 capturevideostate_t;
 791
 792 #define CL_MAX_DOWNLOADACKS 4
 793
 794 typedef struct cl_downloadack_s
 795 {
 796         int start, size;
 797 }
 798 cl_downloadack_t;
 799
 800 typedef struct cl_soundstats_s
 801 {
 802         int mixedsounds;
 803         int totalsounds;
 804         int latency_milliseconds;
 805 }
 806 cl_soundstats_t;
 807
 808 //
 809 // the client_static_t structure is persistent through an arbitrary number
 810 // of server connections
 811 //
 812 typedef struct client_static_s
 813 {
 814         cactive_t state;
 815
 816         // all client memory allocations go in these pools
 817         mempool_t *levelmempool;
 818         mempool_t *permanentmempool;
 819
 820 // demo loop control
 821         // -1 = don't play demos
 822         int demonum;
 823         // list of demos in loop
 824         char demos[MAX_DEMOS][MAX_DEMONAME];
 825         // the actively playing demo (set by CL_PlayDemo_f)
 826         char demoname[MAX_QPATH];
 827
 828 // demo recording info must be here, because record is started before
 829 // entering a map (and clearing client_state_t)
 830         qboolean demorecording;
 831         fs_offset_t demo_lastcsprogssize;
 832         int demo_lastcsprogscrc;
 833         qboolean demoplayback;
 834         qboolean demostarting; // set if currently starting a demo, to stop -demo from quitting when switching to another demo
 835         qboolean timedemo;
 836         // -1 = use normal cd track
 837         int forcetrack;
 838         qfile_t *demofile;
 839         // realtime at second frame of timedemo (LadyHavoc: changed to double)
 840         double td_starttime;
 841         int td_frames; // total frames parsed
 842         double td_onesecondnexttime;
 843         double td_onesecondframes;
 844         double td_onesecondrealtime;
 845         double td_onesecondminfps;
 846         double td_onesecondmaxfps;
 847         double td_onesecondavgfps;
 848         int td_onesecondavgcount;
 849         // LadyHavoc: pausedemo
 850         qboolean demopaused;
 851
 852         // sound mixer statistics for showsound display
 853         cl_soundstats_t soundstats;
 854
 855         qboolean connect_trying;
 856         int connect_remainingtries;
 857         double connect_nextsendtime;
 858         lhnetsocket_t *connect_mysocket;
 859         lhnetaddress_t connect_address;
 860         lhnetaddress_t rcon_address;
 861         // protocol version of the server we're connected to
 862         // (kept outside client_state_t because it's used between levels)
 863         protocolversion_t protocol;
 864
 865 #define MAX_RCONS 16
 866         int rcon_trying;
 867         lhnetaddress_t rcon_addresses[MAX_RCONS];
 868         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
 869         double rcon_timeout[MAX_RCONS];
 870         int rcon_ringpos;
 871
 872 // connection information
 873         // 0 to SIGNONS
 874         int signon;
 875         // network connection
 876         netconn_t *netcon;
 877
 878         // download information
 879         // (note: qw_download variables are also used)
 880         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
 881
 882         // input sequence numbers are not reset on level change, only connect
 883         unsigned int servermovesequence;
 884
 885         // quakeworld stuff below
 886
 887         // value of "qport" cvar at time of connection
 888         int qw_qport;
 889         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
 890         unsigned int qw_incoming_sequence;
 891         unsigned int qw_outgoing_sequence;
 892
 893         // current file download buffer (only saved when file is completed)
 894         char qw_downloadname[MAX_QPATH];
 895         unsigned char *qw_downloadmemory;
 896         int qw_downloadmemorycursize;
 897         int qw_downloadmemorymaxsize;
 898         int qw_downloadnumber;
 899         int qw_downloadpercent;
 900         qw_downloadtype_t qw_downloadtype;
 901         // transfer rate display
 902         double qw_downloadspeedtime;
 903         int qw_downloadspeedcount;
 904         int qw_downloadspeedrate;
 905         qboolean qw_download_deflate;
 906
 907         // current file upload buffer (for uploading screenshots to server)
 908         unsigned char *qw_uploaddata;
 909         int qw_uploadsize;
 910         int qw_uploadpos;
 911
 912         // user infostring
 913         // this normally contains the following keys in quakeworld:
 914         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
 915         char userinfo[MAX_USERINFO_STRING];
 916
 917         // extra user info for the "connect" command
 918         char connect_userinfo[MAX_USERINFO_STRING];
 919
 920         // video capture stuff
 921         capturevideostate_t capturevideo;
 922
 923         // crypto channel
 924         crypto_t crypto;
 925
 926         // ProQuake compatibility stuff
 927         int proquake_servermod; // 0 = not proquake, 1 = proquake
 928         int proquake_serverversion; // actual proquake server version * 10 (3.40 = 34, etc)
 929         int proquake_serverflags; // 0 (PQF_CHEATFREE not supported)
 930
 931         // don't write-then-read csprogs.dat (useful for demo playback)
 932         unsigned char *caughtcsprogsdata;
 933         fs_offset_t caughtcsprogsdatasize;
 934
 935         int r_speeds_graph_length;
 936         int r_speeds_graph_current;
 937         int *r_speeds_graph_data;
 938
 939         // graph scales
 940         int r_speeds_graph_datamin[r_stat_count];
 941         int r_speeds_graph_datamax[r_stat_count];
 942 }
 943 client_static_t;
 944
 945 extern client_static_t  cls;
 946
 947 //[515]: csqc
 948 typedef struct
 949 {
 950         qboolean drawworld;
 951         qboolean drawenginesbar;
 952         qboolean drawcrosshair;
 953 }csqc_vidvars_t;
 954
 955 typedef enum
 956 {
 957         PARTICLE_BILLBOARD = 0,
 958         PARTICLE_SPARK = 1,
 959         PARTICLE_ORIENTED_DOUBLESIDED = 2,
 960         PARTICLE_VBEAM = 3,
 961         PARTICLE_HBEAM = 4,
 962         PARTICLE_INVALID = -1
 963 }
 964 porientation_t;
 965
 966 typedef enum
 967 {
 968         PBLEND_ALPHA = 0,
 969         PBLEND_ADD = 1,
 970         PBLEND_INVMOD = 2,
 971         PBLEND_INVALID = -1
 972 }
 973 pblend_t;
 974
 975 typedef struct particletype_s
 976 {
 977         pblend_t blendmode;
 978         porientation_t orientation;
 979         qboolean lighting;
 980 }
 981 particletype_t;
 982
 983 typedef enum ptype_e
 984 {
 985         pt_dead, pt_alphastatic, pt_static, pt_spark, pt_beam, pt_rain, pt_raindecal, pt_snow, pt_bubble, pt_blood, pt_smoke, pt_decal, pt_entityparticle, pt_total
 986 }
 987 ptype_t;
 988
 989 typedef struct particle_s
 990 {
 991         // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
 992
 993         // fields used by rendering: (48 bytes)
 994         vec3_t          sortorigin; // sort by this group origin, not particle org
 995         vec3_t          org;
 996         vec3_t          vel; // velocity of particle, or orientation of decal, or end point of beam
 997         float           size;
 998         float           alpha; // 0-255
 999         float           stretch; // only for sparks
1000
1001         // fields not used by rendering:  (44 bytes)
1002         float           stainsize;
1003         float           stainalpha;
1004         float           sizeincrease; // rate of size change per second
1005         float           alphafade; // how much alpha reduces per second
1006         float           time2; // used for snow fluttering and decal fade
1007         float           bounce; // how much bounce-back from a surface the particle hits (0 = no physics, 1 = stop and slide, 2 = keep bouncing forever, 1.5 is typical)
1008         float           gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
1009         float           airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
1010         float           liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
1011 //      float           delayedcollisions; // time that p->bounce becomes active
1012         float           delayedspawn; // time that particle appears and begins moving
1013         float           die; // time when this particle should be removed, regardless of alpha
1014
1015         // short variables grouped to save memory (4 bytes)
1016         short                   angle; // base rotation of particle
1017         short                   spin; // geometry rotation speed around the particle center normal
1018
1019         // byte variables grouped to save memory (12 bytes)
1020         unsigned char   color[3];
1021         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
1022         unsigned char   typeindex;
1023         unsigned char   blendmode;
1024         unsigned char   orientation;
1025         unsigned char   texnum;
1026         unsigned char   staincolor[3];
1027         signed char     staintexnum;
1028 }
1029 particle_t;
1030
1031 typedef enum cl_parsingtextmode_e
1032 {
1033         CL_PARSETEXTMODE_NONE,
1034         CL_PARSETEXTMODE_PING,
1035         CL_PARSETEXTMODE_STATUS,
1036         CL_PARSETEXTMODE_STATUS_PLAYERID,
1037         CL_PARSETEXTMODE_STATUS_PLAYERIP
1038 }
1039 cl_parsingtextmode_t;
1040
1041 typedef struct cl_locnode_s
1042 {
1043         struct cl_locnode_s *next;
1044         char *name;
1045         vec3_t mins, maxs;
1046 }
1047 cl_locnode_t;
1048
1049 typedef struct showlmp_s
1050 {
1051         qboolean        isactive;
1052         float           x;
1053         float           y;
1054         char            label[32];
1055         char            pic[128];
1056 }
1057 showlmp_t;
1058
1059 //
1060 // the client_state_t structure is wiped completely at every
1061 // server signon
1062 //
1063 typedef struct client_state_s
1064 {
1065         // true if playing in a local game and no one else is connected
1066         int islocalgame;
1067
1068         // send a clc_nop periodically until connected
1069         float sendnoptime;
1070
1071         // current input being accumulated by mouse/joystick/etc input
1072         usercmd_t cmd;
1073         // latest moves sent to the server that have not been confirmed yet
1074         usercmd_t movecmd[CL_MAX_USERCMDS];
1075
1076 // information for local display
1077         // health, etc
1078         int stats[MAX_CL_STATS];
1079         float *statsf; // points to stats[] array
1080         // last known inventory bit flags, for blinking
1081         int olditems;
1082         // cl.time of acquiring item, for blinking
1083         float item_gettime[32];
1084         // last known STAT_ACTIVEWEAPON
1085         int activeweapon;
1086         // cl.time of changing STAT_ACTIVEWEAPON
1087         float weapontime;
1088         // use pain anim frame if cl.time < this
1089         float faceanimtime;
1090         // for stair smoothing
1091         float stairsmoothz;
1092         double stairsmoothtime;
1093
1094         // color shifts for damage, powerups
1095         cshift_t cshifts[NUM_CSHIFTS];
1096         // and content types
1097         cshift_t prev_cshifts[NUM_CSHIFTS];
1098
1099 // the client maintains its own idea of view angles, which are
1100 // sent to the server each frame.  The server sets punchangle when
1101 // the view is temporarily offset, and an angle reset commands at the start
1102 // of each level and after teleporting.
1103
1104         // mviewangles is read from demo
1105         // viewangles is either client controlled or lerped from mviewangles
1106         vec3_t mviewangles[2], viewangles;
1107         // update by server, used by qc to do weapon recoil
1108         vec3_t mpunchangle[2], punchangle;
1109         // update by server, can be used by mods to kick view around
1110         vec3_t mpunchvector[2], punchvector;
1111         // update by server, used for lean+bob (0 is newest)
1112         vec3_t mvelocity[2], velocity;
1113         // update by server, can be used by mods for zooming
1114         vec_t mviewzoom[2], viewzoom;
1115         // if true interpolation the mviewangles and other interpolation of the
1116         // player is disabled until the next network packet
1117         // this is used primarily by teleporters, and when spectating players
1118         // special checking of the old fixangle[1] is used to differentiate
1119         // between teleporting and spectating
1120         qboolean fixangle[2];
1121
1122         // client movement simulation
1123         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
1124         // set by CL_ClientMovement_Replay functions
1125         qboolean movement_predicted;
1126         // if true the CL_ClientMovement_Replay function will update origin, etc
1127         qboolean movement_replay;
1128         // simulated data (this is valid even if cl.movement is false)
1129         vec3_t movement_origin;
1130         vec3_t movement_velocity;
1131         // whether the replay should allow a jump at the first sequence
1132         qboolean movement_replay_canjump;
1133
1134         // previous gun angles (for leaning effects)
1135         vec3_t gunangles_prev;
1136         vec3_t gunangles_highpass;
1137         vec3_t gunangles_adjustment_lowpass;
1138         vec3_t gunangles_adjustment_highpass;
1139         // previous gun angles (for leaning effects)
1140         vec3_t gunorg_prev;
1141         vec3_t gunorg_highpass;
1142         vec3_t gunorg_adjustment_lowpass;
1143         vec3_t gunorg_adjustment_highpass;
1144
1145 // pitch drifting vars
1146         float idealpitch;
1147         float pitchvel;
1148         qboolean nodrift;
1149         float driftmove;
1150         double laststop;
1151
1152 //[515]: added for csqc purposes
1153         float sensitivityscale;
1154         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
1155         qboolean csqc_wantsmousemove;
1156         qboolean csqc_paused; // vortex: int because could be flags
1157         struct model_s *csqc_model_precache[MAX_MODELS];
1158
1159         // local amount for smoothing stepups
1160         //float crouch;
1161
1162         // sent by server
1163         qboolean paused;
1164         qboolean onground;
1165         qboolean inwater;
1166
1167         // used by bob
1168         qboolean oldonground;
1169         double lastongroundtime;
1170         double hitgroundtime;
1171         float bob2_smooth;
1172         float bobfall_speed;
1173         float bobfall_swing;
1174         double calcrefdef_prevtime;
1175
1176         // don't change view angle, full screen, etc
1177         int intermission;
1178         // latched at intermission start
1179         double completed_time;
1180
1181         // the timestamp of the last two messages
1182         double mtime[2];
1183
1184         // clients view of time, time should be between mtime[0] and mtime[1] to
1185         // generate a lerp point for other data, oldtime is the previous frame's
1186         // value of time, frametime is the difference between time and oldtime
1187         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
1188         // is only forcefully limited when a packet is received
1189         double time, oldtime;
1190         // how long it has been since the previous client frame in real time
1191         // (not game time, for that use cl.time - cl.oldtime)
1192         double realframetime;
1193
1194         // fade var for fading while dead
1195         float deathfade;
1196
1197         // motionblur alpha level variable
1198         float motionbluralpha;
1199
1200         // copy of realtime from last recieved message, for net trouble icon
1201         float last_received_message;
1202
1203 // information that is static for the entire time connected to a server
1204         struct model_s *model_precache[MAX_MODELS];
1205         struct sfx_s *sound_precache[MAX_SOUNDS];
1206
1207         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1208         char model_name[MAX_MODELS][MAX_QPATH];
1209         char sound_name[MAX_SOUNDS][MAX_QPATH];
1210
1211         // for display on solo scoreboard
1212         char worldmessage[40]; // map title (not related to filename)
1213         // variants of map name
1214         char worldbasename[MAX_QPATH]; // %s
1215         char worldname[MAX_QPATH]; // maps/%s.bsp
1216         char worldnamenoextension[MAX_QPATH]; // maps/%s
1217         // cl_entitites[cl.viewentity] = player
1218         int viewentity;
1219         // the real player entity (normally same as viewentity,
1220         // different than viewentity if mod uses chasecam or other tricks)
1221         int realplayerentity;
1222         // this is updated to match cl.viewentity whenever it is in the clients
1223         // range, basically this is used in preference to cl.realplayerentity for
1224         // most purposes because when spectating another player it should show
1225         // their information rather than yours
1226         int playerentity;
1227         // max players that can be in this game
1228         int maxclients;
1229         // type of game (deathmatch, coop, singleplayer)
1230         int gametype;
1231
1232         // models and sounds used by engine code (particularly cl_parse.c)
1233         dp_model_t *model_bolt;
1234         dp_model_t *model_bolt2;
1235         dp_model_t *model_bolt3;
1236         dp_model_t *model_beam;
1237         sfx_t *sfx_wizhit;
1238         sfx_t *sfx_knighthit;
1239         sfx_t *sfx_tink1;
1240         sfx_t *sfx_ric1;
1241         sfx_t *sfx_ric2;
1242         sfx_t *sfx_ric3;
1243         sfx_t *sfx_r_exp3;
1244         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1245         qboolean foundtalk2wav;
1246
1247 // refresh related state
1248
1249         // cl_entitites[0].model
1250         struct model_s *worldmodel;
1251
1252         // the gun model
1253         entity_t viewent;
1254
1255         // cd audio
1256         int cdtrack, looptrack;
1257
1258 // frag scoreboard
1259
1260         // [cl.maxclients]
1261         scoreboard_t *scores;
1262
1263         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1264         cl_parsingtextmode_t parsingtextmode;
1265         int parsingtextplayerindex;
1266         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1267         // (which could eat the wrong ping report if the player issues one
1268         //  manually, but they would still see a ping report, just a later one
1269         //  caused by the scoreboard code rather than the one they intentionally
1270         //  issued)
1271         int parsingtextexpectingpingforscores;
1272
1273         // entity database stuff
1274         // latest received entity frame numbers
1275 #define LATESTFRAMENUMS 32
1276         int latestframenumsposition;
1277         int latestframenums[LATESTFRAMENUMS];
1278         unsigned int latestsendnums[LATESTFRAMENUMS];
1279         entityframe_database_t *entitydatabase;
1280         entityframe4_database_t *entitydatabase4;
1281         entityframeqw_database_t *entitydatabaseqw;
1282
1283         // keep track of quake entities because they need to be killed if they get stale
1284         int lastquakeentity;
1285         unsigned char isquakeentity[MAX_EDICTS];
1286
1287         // bounding boxes for clientside movement
1288         vec3_t playerstandmins;
1289         vec3_t playerstandmaxs;
1290         vec3_t playercrouchmins;
1291         vec3_t playercrouchmaxs;
1292
1293         // old decals are killed based on this
1294         unsigned int decalsequence;
1295
1296         int max_entities;
1297         int max_csqcrenderentities;
1298         int max_static_entities;
1299         int max_effects;
1300         int max_beams;
1301         int max_dlights;
1302         int max_lightstyle;
1303         int max_brushmodel_entities;
1304         int max_particles;
1305         int max_showlmps;
1306
1307         entity_t *entities;
1308         entity_render_t *csqcrenderentities;
1309         unsigned char *entities_active;
1310         entity_t *static_entities;
1311         cl_effect_t *effects;
1312         beam_t *beams;
1313         dlight_t *dlights;
1314         lightstyle_t *lightstyle;
1315         int *brushmodel_entities;
1316         particle_t *particles;
1317         showlmp_t *showlmps;
1318
1319         int num_entities;
1320         int num_static_entities;
1321         int num_brushmodel_entities;
1322         int num_effects;
1323         int num_beams;
1324         int num_dlights;
1325         int num_particles;
1326         int num_decals;
1327         int num_showlmps;
1328
1329         double particles_updatetime;
1330         double decals_updatetime;
1331         int free_particle;
1332         int free_decal;
1333
1334         // cl_serverextension_download feature
1335         int loadmodel_current;
1336         int downloadmodel_current;
1337         int loadmodel_total;
1338         int loadsound_current;
1339         int downloadsound_current;
1340         int loadsound_total;
1341         qboolean downloadcsqc;
1342         qboolean loadcsqc;
1343         qboolean loadbegun;
1344         qboolean loadfinished;
1345
1346         // quakeworld stuff
1347
1348         // local copy of the server infostring
1349         char qw_serverinfo[MAX_SERVERINFO_STRING];
1350
1351         // time of last qw "pings" command sent to server while showing scores
1352         double last_ping_request;
1353
1354         // used during connect
1355         int qw_servercount;
1356
1357         // updated from serverinfo
1358         int qw_teamplay;
1359
1360         // unused: indicates whether the player is spectating
1361         // use cl.scores[cl.playerentity-1].qw_spectator instead
1362         //qboolean qw_spectator;
1363
1364         // last time an input packet was sent
1365         double lastpackettime;
1366
1367         // movement parameters for client prediction
1368         unsigned int moveflags;
1369         float movevars_wallfriction;
1370         float movevars_waterfriction;
1371         float movevars_friction;
1372         float movevars_timescale;
1373         float movevars_gravity;
1374         float movevars_stopspeed;
1375         float movevars_maxspeed;
1376         float movevars_spectatormaxspeed;
1377         float movevars_accelerate;
1378         float movevars_airaccelerate;
1379         float movevars_wateraccelerate;
1380         float movevars_entgravity;
1381         float movevars_jumpvelocity;
1382         float movevars_edgefriction;
1383         float movevars_maxairspeed;
1384         float movevars_stepheight;
1385         float movevars_airaccel_qw;
1386         float movevars_airaccel_qw_stretchfactor;
1387         float movevars_airaccel_sideways_friction;
1388         float movevars_airstopaccelerate;
1389         float movevars_airstrafeaccelerate;
1390         float movevars_maxairstrafespeed;
1391         float movevars_airstrafeaccel_qw;
1392         float movevars_aircontrol;
1393         float movevars_aircontrol_power;
1394         float movevars_aircontrol_penalty;
1395         float movevars_warsowbunny_airforwardaccel;
1396         float movevars_warsowbunny_accel;
1397         float movevars_warsowbunny_topspeed;
1398         float movevars_warsowbunny_turnaccel;
1399         float movevars_warsowbunny_backtosideratio;
1400         float movevars_ticrate;
1401         float movevars_airspeedlimit_nonqw;
1402
1403         // models used by qw protocol
1404         int qw_modelindex_spike;
1405         int qw_modelindex_player;
1406         int qw_modelindex_flag;
1407         int qw_modelindex_s_explod;
1408
1409         vec3_t qw_intermission_origin;
1410         vec3_t qw_intermission_angles;
1411
1412         // 255 is the most nails the QW protocol could send
1413         int qw_num_nails;
1414         vec_t qw_nails[255][6];
1415
1416         float qw_weaponkick;
1417
1418         unsigned int qw_validsequence;
1419
1420         unsigned int qw_deltasequence[QW_UPDATE_BACKUP];
1421
1422         // csqc stuff:
1423         // server entity number corresponding to a clientside entity
1424         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1425         qboolean csqc_loaded;
1426         vec3_t csqc_vieworigin;
1427         vec3_t csqc_viewangles;
1428         vec3_t csqc_vieworiginfromengine;
1429         vec3_t csqc_viewanglesfromengine;
1430         matrix4x4_t csqc_viewmodelmatrixfromengine;
1431         qboolean csqc_usecsqclistener;
1432         matrix4x4_t csqc_listenermatrix;
1433         char csqc_printtextbuf[MAX_INPUTLINE];
1434
1435         // collision culling data
1436         world_t world;
1437
1438         // loc file stuff (points and boxes describing locations in the level)
1439         cl_locnode_t *locnodes;
1440         // this is updated to cl.movement_origin whenever health is < 1
1441         // used by %d print in say/say_team messages if cl_locs_enable is on
1442         vec3_t lastdeathorigin;
1443
1444         // processing buffer used by R_BuildLightMap, reallocated as needed,
1445         // freed on each level change
1446         size_t buildlightmapmemorysize;
1447         unsigned char *buildlightmapmemory;
1448
1449         // used by EntityState5_ReadUpdate
1450         skeleton_t *engineskeletonobjects;
1451 }
1452 client_state_t;
1453
1454 //
1455 // cvars
1456 //
1457 extern cvar_t cl_name;
1458 extern cvar_t cl_color;
1459 extern cvar_t cl_rate;
1460 extern cvar_t cl_rate_burstsize;
1461 extern cvar_t cl_pmodel;
1462 extern cvar_t cl_playermodel;
1463 extern cvar_t cl_playerskin;
1464
1465 extern cvar_t rcon_password;
1466 extern cvar_t rcon_address;
1467
1468 extern cvar_t cl_upspeed;
1469 extern cvar_t cl_forwardspeed;
1470 extern cvar_t cl_backspeed;
1471 extern cvar_t cl_sidespeed;
1472
1473 extern cvar_t cl_movespeedkey;
1474
1475 extern cvar_t cl_yawspeed;
1476 extern cvar_t cl_pitchspeed;
1477
1478 extern cvar_t cl_anglespeedkey;
1479
1480 extern cvar_t cl_autofire;
1481
1482 extern cvar_t cl_shownet;
1483 extern cvar_t cl_nolerp;
1484 extern cvar_t cl_nettimesyncfactor;
1485 extern cvar_t cl_nettimesyncboundmode;
1486 extern cvar_t cl_nettimesyncboundtolerance;
1487
1488 extern cvar_t cl_pitchdriftspeed;
1489 extern cvar_t lookspring;
1490 extern cvar_t lookstrafe;
1491 extern cvar_t sensitivity;
1492
1493 extern cvar_t freelook;
1494
1495 extern cvar_t m_pitch;
1496 extern cvar_t m_yaw;
1497 extern cvar_t m_forward;
1498 extern cvar_t m_side;
1499
1500 extern cvar_t cl_autodemo;
1501 extern cvar_t cl_autodemo_nameformat;
1502 extern cvar_t cl_autodemo_delete;
1503
1504 extern cvar_t r_draweffects;
1505
1506 extern cvar_t cl_explosions_alpha_start;
1507 extern cvar_t cl_explosions_alpha_end;
1508 extern cvar_t cl_explosions_size_start;
1509 extern cvar_t cl_explosions_size_end;
1510 extern cvar_t cl_explosions_lifetime;
1511 extern cvar_t cl_stainmaps;
1512 extern cvar_t cl_stainmaps_clearonload;
1513
1514 extern cvar_t cl_prydoncursor;
1515 extern cvar_t cl_prydoncursor_notrace;
1516
1517 extern cvar_t cl_locs_enable;
1518
1519 extern client_state_t cl;
1520
1521 extern void CL_AllocLightFlash (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
1522
1523 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1524 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1525
1526 //=============================================================================
1527
1528 //
1529 // cl_main
1530 //
1531
1532 void CL_Shutdown (void);
1533 void CL_Init (void);
1534
1535 void CL_EstablishConnection(const char *host, int firstarg);
1536
1537 void CL_Disconnect (void);
1538 void CL_Disconnect_f(cmd_state_t *cmd);
1539
1540 void CL_UpdateRenderEntity(entity_render_t *ent);
1541 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1542 void CL_UpdateViewEntities(void);
1543
1544 //
1545 // cl_input
1546 //
1547 typedef struct kbutton_s
1548 {
1549         int             down[2];                // key nums holding it down
1550         int             state;                  // low bit is down state
1551 }
1552 kbutton_t;
1553
1554 extern  kbutton_t       in_mlook, in_klook;
1555 extern  kbutton_t       in_strafe;
1556 extern  kbutton_t       in_speed;
1557
1558 void CL_InitInput (void);
1559 void CL_SendMove (void);
1560
1561 void CL_ValidateState(entity_state_t *s);
1562 void CL_MoveLerpEntityStates(entity_t *ent);
1563 void CL_LerpUpdate(entity_t *e);
1564 void CL_ParseTEnt (void);
1565 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1566 void CL_RelinkBeams (void);
1567 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1568 void CL_ClientMovement_Replay(void);
1569
1570 void CL_ClearTempEntities (void);
1571 entity_render_t *CL_NewTempEntity (double shadertime);
1572
1573 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1574
1575 void CL_ClearState (void);
1576 void CL_ExpandEntities(int num);
1577 void CL_ExpandCSQCRenderEntities(int num);
1578 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1579
1580
1581 void CL_UpdateWorld (void);
1582 void CL_WriteToServer (void);
1583 void CL_Input (void);
1584 extern int cl_ignoremousemoves;
1585
1586
1587 float CL_KeyState (kbutton_t *key);
1588 const char *Key_KeynumToString (int keynum, char *buf, size_t buflength);
1589 int Key_StringToKeynum (const char *str);
1590
1591 //
1592 // cl_demo.c
1593 //
1594 void CL_StopPlayback(void);
1595 void CL_ReadDemoMessage(void);
1596 void CL_WriteDemoMessage(sizebuf_t *mesage);
1597
1598 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1599 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1600
1601 void CL_NextDemo(void);
1602 void CL_Stop_f(cmd_state_t *cmd);
1603 void CL_Record_f(cmd_state_t *cmd);
1604 void CL_PlayDemo_f(cmd_state_t *cmd);
1605 void CL_TimeDemo_f(cmd_state_t *cmd);
1606
1607 //
1608 // cl_parse.c
1609 //
1610 void CL_Parse_Init(void);
1611 void CL_Parse_Shutdown(void);
1612 void CL_ParseServerMessage(void);
1613 void CL_Parse_DumpPacket(void);
1614 void CL_Parse_ErrorCleanUp(void);
1615 void QW_CL_StartUpload(unsigned char *data, int size);
1616 extern cvar_t qport;
1617 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1618
1619 //
1620 // view
1621 //
1622 void V_StartPitchDrift_f(cmd_state_t *cmd);
1623 void V_StopPitchDrift (void);
1624
1625 void V_Init (void);
1626 float V_CalcRoll (const vec3_t angles, const vec3_t velocity);
1627 void V_UpdateBlends (void);
1628 void V_ParseDamage (void);
1629
1630 //
1631 // cl_part
1632 //
1633
1634 extern cvar_t cl_particles;
1635 extern cvar_t cl_particles_quality;
1636 extern cvar_t cl_particles_size;
1637 extern cvar_t cl_particles_quake;
1638 extern cvar_t cl_particles_blood;
1639 extern cvar_t cl_particles_blood_alpha;
1640 extern cvar_t cl_particles_blood_decal_alpha;
1641 extern cvar_t cl_particles_blood_decal_scalemin;
1642 extern cvar_t cl_particles_blood_decal_scalemax;
1643 extern cvar_t cl_particles_blood_bloodhack;
1644 extern cvar_t cl_particles_bulletimpacts;
1645 extern cvar_t cl_particles_explosions_sparks;
1646 extern cvar_t cl_particles_explosions_shell;
1647 extern cvar_t cl_particles_rain;
1648 extern cvar_t cl_particles_snow;
1649 extern cvar_t cl_particles_smoke;
1650 extern cvar_t cl_particles_smoke_alpha;
1651 extern cvar_t cl_particles_smoke_alphafade;
1652 extern cvar_t cl_particles_sparks;
1653 extern cvar_t cl_particles_bubbles;
1654 extern cvar_t cl_decals;
1655 extern cvar_t cl_decals_time;
1656 extern cvar_t cl_decals_fadetime;
1657
1658 void CL_Particles_Clear(void);
1659 void CL_Particles_Init(void);
1660 void CL_Particles_Shutdown(void);
1661 particle_t *CL_NewParticle(const vec3_t sortorigin, unsigned short ptypeindex, int pcolor1, int pcolor2, int ptex, float psize, float psizeincrease, float palpha, float palphafade, float pgravity, float pbounce, float px, float py, float pz, float pvx, float pvy, float pvz, float pairfriction, float pliquidfriction, float originjitter, float velocityjitter, qboolean pqualityreduction, float lifetime, float stretch, pblend_t blendmode, porientation_t orientation, int staincolor1, int staincolor2, int staintex, float stainalpha, float stainsize, float angle, float spin, float tint[4]);
1662
1663 typedef enum effectnameindex_s
1664 {
1665         EFFECT_NONE,
1666         EFFECT_TE_GUNSHOT,
1667         EFFECT_TE_GUNSHOTQUAD,
1668         EFFECT_TE_SPIKE,
1669         EFFECT_TE_SPIKEQUAD,
1670         EFFECT_TE_SUPERSPIKE,
1671         EFFECT_TE_SUPERSPIKEQUAD,
1672         EFFECT_TE_WIZSPIKE,
1673         EFFECT_TE_KNIGHTSPIKE,
1674         EFFECT_TE_EXPLOSION,
1675         EFFECT_TE_EXPLOSIONQUAD,
1676         EFFECT_TE_TAREXPLOSION,
1677         EFFECT_TE_TELEPORT,
1678         EFFECT_TE_LAVASPLASH,
1679         EFFECT_TE_SMALLFLASH,
1680         EFFECT_TE_FLAMEJET,
1681         EFFECT_EF_FLAME,
1682         EFFECT_TE_BLOOD,
1683         EFFECT_TE_SPARK,
1684         EFFECT_TE_PLASMABURN,
1685         EFFECT_TE_TEI_G3,
1686         EFFECT_TE_TEI_SMOKE,
1687         EFFECT_TE_TEI_BIGEXPLOSION,
1688         EFFECT_TE_TEI_PLASMAHIT,
1689         EFFECT_EF_STARDUST,
1690         EFFECT_TR_ROCKET,
1691         EFFECT_TR_GRENADE,
1692         EFFECT_TR_BLOOD,
1693         EFFECT_TR_WIZSPIKE,
1694         EFFECT_TR_SLIGHTBLOOD,
1695         EFFECT_TR_KNIGHTSPIKE,
1696         EFFECT_TR_VORESPIKE,
1697         EFFECT_TR_NEHAHRASMOKE,
1698         EFFECT_TR_NEXUIZPLASMA,
1699         EFFECT_TR_GLOWTRAIL,
1700         EFFECT_SVC_PARTICLE,
1701         EFFECT_TOTAL
1702 }
1703 effectnameindex_t;
1704
1705 int CL_ParticleEffectIndexForName(const char *name);
1706 const char *CL_ParticleEffectNameForIndex(int i);
1707 void CL_ParticleEffect(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor);
1708 void CL_ParticleTrail(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor, qboolean spawndlight, qboolean spawnparticles, float tintmins[4], float tintmaxs[4], float fade);
1709 void CL_ParticleBox(int effectindex, float pcount, const vec3_t originmins, const vec3_t originmaxs, const vec3_t velocitymins, const vec3_t velocitymaxs, entity_t *ent, int palettecolor, qboolean spawndlight, qboolean spawnparticles, float tintmins[4], float tintmaxs[4], float fade);
1710 void CL_ParseParticleEffect (void);
1711 void CL_ParticleCube (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, vec_t gravity, vec_t randomvel);
1712 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1713 void CL_EntityParticles (const entity_t *ent);
1714 void CL_ParticleExplosion (const vec3_t org);
1715 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1716 void R_NewExplosion(const vec3_t org);
1717
1718 #include "cl_screen.h"
1719
1720 extern qboolean sb_showscores;
1721
1722 float RSurf_FogVertex(const vec3_t p);
1723 float RSurf_FogPoint(const vec3_t p);
1724
1725 typedef enum r_viewport_type_e
1726 {
1727         R_VIEWPORTTYPE_ORTHO,
1728         R_VIEWPORTTYPE_PERSPECTIVE,
1729         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1730         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1731         R_VIEWPORTTYPE_TOTAL
1732 }
1733 r_viewport_type_t;
1734
1735 typedef struct r_viewport_s
1736 {
1737         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1738         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1739         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1740         int x;
1741         int y;
1742         int z;
1743         int width;
1744         int height;
1745         int depth;
1746         r_viewport_type_t type;
1747         float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1748 }
1749 r_viewport_t;
1750
1751 typedef struct r_refdef_view_s
1752 {
1753         // view information (changes multiple times per frame)
1754         // if any of these variables change then r_refdef.viewcache must be regenerated
1755         // by calling R_View_Update
1756         // (which also updates viewport, scissor, colormask)
1757
1758         // it is safe and expected to copy this into a structure on the stack and
1759         // call the renderer recursively, then restore from the stack afterward
1760         // (as long as R_View_Update is called)
1761
1762         // eye position information
1763         matrix4x4_t matrix, inverse_matrix;
1764         vec3_t origin;
1765         vec3_t forward;
1766         vec3_t left;
1767         vec3_t right;
1768         vec3_t up;
1769         int numfrustumplanes;
1770         mplane_t frustum[6];
1771         qboolean useclipplane;
1772         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1773         mplane_t clipplane;
1774         float frustum_x, frustum_y;
1775         vec3_t frustumcorner[4];
1776         // if turned off it renders an ortho view
1777         int useperspective;
1778         // allows visibility culling based on the view origin (e.g. pvs and R_CanSeeBox)
1779         // this is turned off by:
1780         // r_trippy
1781         // !r_refdef.view.useperspective
1782         // (sometimes) r_refdef.view.useclipplane
1783         int usevieworiginculling;
1784         float ortho_x, ortho_y;
1785
1786         // screen area to render in
1787         int x;
1788         int y;
1789         int z;
1790         int width;
1791         int height;
1792         int depth;
1793         r_viewport_t viewport; // note: if r_viewscale is used, the viewport.width and viewport.height may be less than width and height
1794
1795         // which color components to allow (for anaglyph glasses)
1796         int colormask[4];
1797
1798         // global RGB color multiplier for rendering
1799         float colorscale;
1800
1801         // whether to call R_ClearScreen before rendering stuff
1802         qboolean clear;
1803         // if true, don't clear or do any post process effects (bloom, etc)
1804         qboolean isoverlay;
1805         // if true, this is the MAIN view (which is, after CSQC, copied into the scene for use e.g. by r_speeds 1, showtex, prydon cursor)
1806         qboolean ismain;
1807
1808         // whether to draw r_showtris and such, this is only true for the main
1809         // view render, all secondary renders (mirrors, portals, cameras,
1810         // distortion effects, etc) omit such debugging information
1811         qboolean showdebug;
1812
1813         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1814         int cullface_front;
1815         int cullface_back;
1816
1817         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1818         float quality;
1819 }
1820 r_refdef_view_t;
1821
1822 typedef struct r_refdef_viewcache_s
1823 {
1824         // updated by gl_main_newmap()
1825         int maxentities;
1826         int world_numclusters;
1827         int world_numclusterbytes;
1828         int world_numleafs;
1829         int world_numsurfaces;
1830
1831         // these properties are generated by R_View_Update()
1832
1833         // which entities are currently visible for this viewpoint
1834         // (the used range is 0...r_refdef.scene.numentities)
1835         unsigned char *entityvisible;
1836
1837         // flag arrays used for visibility checking on world model
1838         // (all other entities have no per-surface/per-leaf visibility checks)
1839         unsigned char *world_pvsbits;
1840         unsigned char *world_leafvisible;
1841         unsigned char *world_surfacevisible;
1842         // if true, the view is currently in a leaf without pvs data
1843         qboolean world_novis;
1844 }
1845 r_refdef_viewcache_t;
1846
1847 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1848 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1849 typedef struct r_refdef_scene_s {
1850         // whether to call S_ExtraUpdate during render to reduce sound chop
1851         qboolean extraupdate;
1852
1853         // (client gameworld) time for rendering time based effects
1854         double time;
1855
1856         // the world
1857         entity_render_t *worldentity;
1858
1859         // same as worldentity->model
1860         dp_model_t *worldmodel;
1861
1862         // renderable entities (excluding world)
1863         entity_render_t **entities;
1864         int numentities;
1865         int maxentities;
1866
1867         // field of temporary entities that is reset each (client) frame
1868         entity_render_t *tempentities;
1869         int numtempentities;
1870         int maxtempentities;
1871         qboolean expandtempentities;
1872
1873         // renderable dynamic lights
1874         rtlight_t *lights[MAX_DLIGHTS];
1875         rtlight_t templights[MAX_DLIGHTS];
1876         int numlights;
1877
1878         // intensities for light styles right now, controls rtlights
1879         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1880         // 8.8bit fixed point intensities for light styles
1881         // controls intensity lightmap layers
1882         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1883
1884         // adds brightness to the whole scene, separate from lightmapintensity
1885         // see CL_UpdateEntityShading
1886         float ambientintensity;
1887         // brightness of lightmap and modellight lighting on materials
1888         // see CL_UpdateEntityShading
1889         float lightmapintensity;
1890
1891         qboolean rtworld;
1892         qboolean rtworldshadows;
1893         qboolean rtdlight;
1894         qboolean rtdlightshadows;
1895 } r_refdef_scene_t;
1896
1897 typedef struct r_refdef_s
1898 {
1899         // these fields define the basic rendering information for the world
1900         // but not the view, which could change multiple times in one rendered
1901         // frame (for example when rendering textures for certain effects)
1902
1903         // these are set for water warping before
1904         // frustum_x/frustum_y are calculated
1905         float frustumscale_x, frustumscale_y;
1906
1907         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1908         r_refdef_view_t view;
1909         r_refdef_viewcache_t viewcache;
1910
1911         // minimum visible distance (pixels closer than this disappear)
1912         double nearclip;
1913         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1914         // in 32bpp an infinite-farclip matrix is used instead)
1915         double farclip;
1916
1917         // fullscreen color blend
1918         float viewblend[4];
1919
1920         r_refdef_scene_t scene;
1921
1922         float fogplane[4];
1923         float fogplaneviewdist;
1924         qboolean fogplaneviewabove;
1925         float fogheightfade;
1926         float fogcolor[3];
1927         float fogrange;
1928         float fograngerecip;
1929         float fogmasktabledistmultiplier;
1930 #define FOGMASKTABLEWIDTH 1024
1931         float fogmasktable[FOGMASKTABLEWIDTH];
1932         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1933         float fog_density;
1934         float fog_red;
1935         float fog_green;
1936         float fog_blue;
1937         float fog_alpha;
1938         float fog_start;
1939         float fog_end;
1940         float fog_height;
1941         float fog_fadedepth;
1942         qboolean fogenabled;
1943         qboolean oldgl_fogenable;
1944
1945         // new flexible texture height fog (overrides normal fog)
1946         char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1947         unsigned char *fog_height_table1d;
1948         unsigned char *fog_height_table2d;
1949         int fog_height_tablesize; // enable
1950         float fog_height_tablescale;
1951         float fog_height_texcoordscale;
1952         char fogheighttexturename[64]; // detects changes to active fog height texture
1953
1954         int draw2dstage; // 0 = no, 1 = yes, other value = needs setting up again
1955
1956         // true during envmap command capture
1957         qboolean envmap;
1958
1959         // whether to draw world lights realtime, dlights realtime, and their shadows
1960         float polygonfactor;
1961         float polygonoffset;
1962
1963         // how long R_RenderView took on the previous frame
1964         double lastdrawscreentime;
1965
1966         // rendering stats for r_speeds display
1967         // (these are incremented in many places)
1968         int stats[r_stat_count];
1969 }
1970 r_refdef_t;
1971
1972 extern r_refdef_t r_refdef;
1973
1974 typedef enum waterlevel_e
1975 {
1976         WATERLEVEL_NONE,
1977         WATERLEVEL_WETFEET,
1978         WATERLEVEL_SWIMMING,
1979         WATERLEVEL_SUBMERGED
1980 }
1981 waterlevel_t;
1982
1983 typedef struct cl_clientmovement_state_s
1984 {
1985         // entity to be ignored for movement
1986         struct prvm_edict_s *self;
1987         // position
1988         vec3_t origin;
1989         vec3_t velocity;
1990         // current bounding box (different if crouched vs standing)
1991         vec3_t mins;
1992         vec3_t maxs;
1993         // currently on the ground
1994         qboolean onground;
1995         // currently crouching
1996         qboolean crouched;
1997         // what kind of water (SUPERCONTENTS_LAVA for instance)
1998         int watertype;
1999         // how deep
2000         waterlevel_t waterlevel;
2001         // weird hacks when jumping out of water
2002         // (this is in seconds and counts down to 0)
2003         float waterjumptime;
2004
2005         // user command
2006         usercmd_t cmd;
2007 }
2008 cl_clientmovement_state_t;
2009 void CL_ClientMovement_PlayerMove_Frame(cl_clientmovement_state_t *s);
2010
2011 // warpzone prediction hack (CSQC builtin)
2012 void CL_RotateMoves(const matrix4x4_t *m);
2013
2014 typedef enum meshname_e {
2015         MESH_DEBUG,
2016         MESH_CSQCPOLYGONS,
2017         MESH_PARTICLES,
2018         MESH_UI,
2019         NUM_MESHENTITIES,
2020 } meshname_t;
2021 extern entity_t cl_meshentities[NUM_MESHENTITIES];
2022 extern dp_model_t cl_meshentitymodels[NUM_MESHENTITIES];
2023 extern const char *cl_meshentitynames[NUM_MESHENTITIES];
2024 #define CL_Mesh_Debug() (&cl_meshentitymodels[MESH_DEBUG])
2025 #define CL_Mesh_CSQC() (&cl_meshentitymodels[MESH_CSQCPOLYGONS])
2026 #define CL_Mesh_Particles() (&cl_meshentitymodels[MESH_PARTICLES])
2027 #define CL_Mesh_UI() (&cl_meshentitymodels[MESH_UI])
2028 void CL_MeshEntities_AddToScene(void);
2029 void CL_MeshEntities_Reset(void);
2030 void CL_UpdateEntityShading(void);
2031
2032 void CL_NewFrameReceived(int num);
2033 void CL_ParseEntityLump(char *entitystring);
2034 void CL_FindNonSolidLocation(const vec3_t in, vec3_t out, vec_t radius);
2035 void CL_RelinkLightFlashes(void);
2036 void CL_Beam_AddPolygons(const beam_t *b);
2037 void Sbar_ShowFPS(void);
2038 void Sbar_ShowFPS_Update(void);
2039 void Host_SaveConfig(void);
2040 void Host_LoadConfig_f(cmd_state_t *cmd);
2041 void CL_UpdateMoveVars(void);
2042 void SCR_CaptureVideo_SoundFrame(const portable_sampleframe_t *paintbuffer, size_t length);
2043 void V_DriftPitch(void);
2044 void V_FadeViewFlashs(void);
2045 void V_CalcViewBlend(void);
2046 void V_CalcRefdefUsing (const matrix4x4_t *entrendermatrix, const vec3_t clviewangles, qboolean teleported, qboolean clonground, qboolean clcmdjump, float clstatsviewheight, qboolean cldead, qboolean clintermission, const vec3_t clvelocity);
2047 void V_CalcRefdef(void);
2048 void CL_Locs_Reload_f(cmd_state_t *cmd);
2049
2050 #endif
2051