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 // flags for rtlight rendering
  29 #define LIGHTFLAG_NORMALMODE 1
  30 #define LIGHTFLAG_REALTIMEMODE 2
  31
  32 typedef struct tridecal_s
  33 {
  34         // color and initial alpha value
  35         float                   texcoord2f[3][2];
  36         float                   vertex3f[3][3];
  37         unsigned char   color4ub[3][4];
  38         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
  39         float                   lived;
  40         // if >= 0 this indicates the decal should follow an animated triangle
  41         int                             triangleindex;
  42         // for visibility culling
  43         int                             surfaceindex;
  44         // old decals are killed to obey cl_decals_max
  45         int                             decalsequence;
  46 }
  47 tridecal_t;
  48
  49 typedef struct decalsystem_s
  50 {
  51         dp_model_t *model;
  52         double lastupdatetime;
  53         int maxdecals;
  54         int freedecal;
  55         int numdecals;
  56         tridecal_t *decals;
  57         float *vertex3f;
  58         float *texcoord2f;
  59         float *color4f;
  60         int *element3i;
  61         unsigned short *element3s;
  62 }
  63 decalsystem_t;
  64
  65 typedef struct effect_s
  66 {
  67         int active;
  68         vec3_t origin;
  69         double starttime;
  70         float framerate;
  71         int modelindex;
  72         int startframe;
  73         int endframe;
  74         // these are for interpolation
  75         int frame;
  76         double frame1time;
  77         double frame2time;
  78 }
  79 cl_effect_t;
  80
  81 typedef struct beam_s
  82 {
  83         int             entity;
  84         // draw this as lightning polygons, or a model?
  85         int             lightning;
  86         struct model_s  *model;
  87         float   endtime;
  88         vec3_t  start, end;
  89 }
  90 beam_t;
  91
  92 typedef struct rtlight_s
  93 {
  94         // shadow volumes are done entirely in model space, so there are no matrices for dealing with them...  they just use the origin
  95
  96         // note that the world to light matrices are inversely scaled (divided) by lightradius
  97
  98         // core properties
  99         /// matrix for transforming light filter coordinates to world coordinates
 100         matrix4x4_t matrix_lighttoworld;
 101         /// matrix for transforming world coordinates to light filter coordinates
 102         matrix4x4_t matrix_worldtolight;
 103         /// typically 1 1 1, can be lower (dim) or higher (overbright)
 104         vec3_t color;
 105         /// size of the light (remove?)
 106         vec_t radius;
 107         /// light filter
 108         char cubemapname[64];
 109         /// light style to monitor for brightness
 110         int style;
 111         /// whether light should render shadows
 112         int shadow;
 113         /// intensity of corona to render
 114         vec_t corona;
 115         /// radius scale of corona to render (1.0 means same as light radius)
 116         vec_t coronasizescale;
 117         /// ambient intensity to render
 118         vec_t ambientscale;
 119         /// diffuse intensity to render
 120         vec_t diffusescale;
 121         /// specular intensity to render
 122         vec_t specularscale;
 123         /// LIGHTFLAG_* flags
 124         int flags;
 125
 126         // generated properties
 127         /// used only for shadow volumes
 128         vec3_t shadoworigin;
 129         /// culling
 130         vec3_t cullmins;
 131         vec3_t cullmaxs;
 132         // culling
 133         //vec_t cullradius;
 134         // squared cullradius
 135         //vec_t cullradius2;
 136
 137         // rendering properties, updated each time a light is rendered
 138         // this is rtlight->color * d_lightstylevalue
 139         vec3_t currentcolor;
 140         /// used by corona updates, due to occlusion query
 141         float corona_visibility;
 142         unsigned int corona_queryindex_visiblepixels;
 143         unsigned int corona_queryindex_allpixels;
 144         /// this is R_Shadow_Cubemap(rtlight->cubemapname)
 145         rtexture_t *currentcubemap;
 146         /// set by R_CacheRTLight to decide whether R_DrawRTLight should draw it
 147         qboolean draw;
 148         /// these fields are set by R_CacheRTLight for later drawing
 149         int cached_numlightentities;
 150         int cached_numlightentities_noselfshadow;
 151         int cached_numshadowentities;
 152         int cached_numshadowentities_noselfshadow;
 153         int cached_numsurfaces;
 154         struct entity_render_s **cached_lightentities;
 155         struct entity_render_s **cached_lightentities_noselfshadow;
 156         struct entity_render_s **cached_shadowentities;
 157         struct entity_render_s **cached_shadowentities_noselfshadow;
 158         unsigned char *cached_shadowtrispvs;
 159         unsigned char *cached_lighttrispvs;
 160         int *cached_surfacelist;
 161         // reduced light cullbox from GetLightInfo
 162         vec3_t cached_cullmins;
 163         vec3_t cached_cullmaxs;
 164         // current shadow-caster culling planes based on view
 165         // (any geometry outside these planes can not contribute to the visible
 166         //  shadows in any way, and thus can be culled safely)
 167         int cached_numfrustumplanes;
 168         mplane_t cached_frustumplanes[5]; // see R_Shadow_ComputeShadowCasterCullingPlanes
 169
 170         /// static light info
 171         /// true if this light should be compiled as a static light
 172         int isstatic;
 173         /// true if this is a compiled world light, cleared if the light changes
 174         int compiled;
 175         /// the shadowing mode used to compile this light
 176         int shadowmode;
 177         /// premade shadow volumes to render for world entity
 178         shadowmesh_t *static_meshchain_shadow_zpass;
 179         shadowmesh_t *static_meshchain_shadow_zfail;
 180         shadowmesh_t *static_meshchain_shadow_shadowmap;
 181         /// used for visibility testing (more exact than bbox)
 182         int static_numleafs;
 183         int static_numleafpvsbytes;
 184         int *static_leaflist;
 185         unsigned char *static_leafpvs;
 186         /// surfaces seen by light
 187         int static_numsurfaces;
 188         int *static_surfacelist;
 189         /// flag bits indicating which triangles of the world model should cast
 190         /// shadows, and which ones should be lit
 191         ///
 192         /// this avoids redundantly scanning the triangles in each surface twice
 193         /// for whether they should cast shadows, once in culling and once in the
 194         /// actual shadowmarklist production.
 195         int static_numshadowtrispvsbytes;
 196         unsigned char *static_shadowtrispvs;
 197         /// this allows the lighting batch code to skip backfaces andother culled
 198         /// triangles not relevant for lighting
 199         /// (important on big surfaces such as terrain)
 200         int static_numlighttrispvsbytes;
 201         unsigned char *static_lighttrispvs;
 202         /// masks of all shadowmap sides that have any potential static receivers or casters
 203         int static_shadowmap_receivers;
 204         int static_shadowmap_casters;
 205 }
 206 rtlight_t;
 207
 208 typedef struct dlight_s
 209 {
 210         // destroy light after this time
 211         // (dlight only)
 212         vec_t die;
 213         // the entity that owns this light (can be NULL)
 214         // (dlight only)
 215         struct entity_render_s *ent;
 216         // location
 217         // (worldlight: saved to .rtlights file)
 218         vec3_t origin;
 219         // worldlight orientation
 220         // (worldlight only)
 221         // (worldlight: saved to .rtlights file)
 222         vec3_t angles;
 223         // dlight orientation/scaling/location
 224         // (dlight only)
 225         matrix4x4_t matrix;
 226         // color of light
 227         // (worldlight: saved to .rtlights file)
 228         vec3_t color;
 229         // cubemap name to use on this light
 230         // (worldlight: saved to .rtlights file)
 231         char cubemapname[64];
 232         // make light flash while selected
 233         // (worldlight only)
 234         int selected;
 235         // brightness (not really radius anymore)
 236         // (worldlight: saved to .rtlights file)
 237         vec_t radius;
 238         // drop intensity this much each second
 239         // (dlight only)
 240         vec_t decay;
 241         // intensity value which is dropped over time
 242         // (dlight only)
 243         vec_t intensity;
 244         // initial values for intensity to modify
 245         // (dlight only)
 246         vec_t initialradius;
 247         vec3_t initialcolor;
 248         // light style which controls intensity of this light
 249         // (worldlight: saved to .rtlights file)
 250         int style;
 251         // cast shadows
 252         // (worldlight: saved to .rtlights file)
 253         int shadow;
 254         // corona intensity
 255         // (worldlight: saved to .rtlights file)
 256         vec_t corona;
 257         // radius scale of corona to render (1.0 means same as light radius)
 258         // (worldlight: saved to .rtlights file)
 259         vec_t coronasizescale;
 260         // ambient intensity to render
 261         // (worldlight: saved to .rtlights file)
 262         vec_t ambientscale;
 263         // diffuse intensity to render
 264         // (worldlight: saved to .rtlights file)
 265         vec_t diffusescale;
 266         // specular intensity to render
 267         // (worldlight: saved to .rtlights file)
 268         vec_t specularscale;
 269         // LIGHTFLAG_* flags
 270         // (worldlight: saved to .rtlights file)
 271         int flags;
 272         // linked list of world lights
 273         // (worldlight only)
 274         struct dlight_s *next;
 275         // embedded rtlight struct for renderer
 276         // (worldlight only)
 277         rtlight_t rtlight;
 278 }
 279 dlight_t;
 280
 281 #define MAX_FRAMEGROUPBLENDS 4
 282 typedef struct framegroupblend_s
 283 {
 284         // animation number and blend factor
 285         // (for most models this is the frame number)
 286         int frame;
 287         float lerp;
 288         // time frame began playing (for framegroup animations)
 289         double start;
 290 }
 291 framegroupblend_t;
 292
 293 // this is derived from processing of the framegroupblend array
 294 // note: technically each framegroupblend can produce two of these, but that
 295 // never happens in practice because no one blends between more than 2
 296 // framegroups at once
 297 #define MAX_FRAMEBLENDS (MAX_FRAMEGROUPBLENDS * 2)
 298 typedef struct frameblend_s
 299 {
 300         int subframe;
 301         float lerp;
 302 }
 303 frameblend_t;
 304
 305 // LordHavoc: this struct is intended for the renderer but some fields are
 306 // used by the client.
 307 //
 308 // The renderer should not rely on any changes to this struct to be persistent
 309 // across multiple frames because temp entities are wiped every frame, but it
 310 // is acceptable to cache things in this struct that are not critical.
 311 //
 312 // For example the r_cullentities_trace code does such caching.
 313 typedef struct entity_render_s
 314 {
 315         // location
 316         //vec3_t origin;
 317         // orientation
 318         //vec3_t angles;
 319         // transform matrix for model to world
 320         matrix4x4_t matrix;
 321         // transform matrix for world to model
 322         matrix4x4_t inversematrix;
 323         // opacity (alpha) of the model
 324         float alpha;
 325         // size the model is shown
 326         float scale;
 327         // transparent sorting offset
 328         float transparent_offset;
 329
 330         // NULL = no model
 331         dp_model_t *model;
 332         // number of the entity represents, or 0 for non-network entities
 333         int entitynumber;
 334         // literal colormap colors for renderer, if both are 0 0 0 it is not colormapped
 335         vec3_t colormap_pantscolor;
 336         vec3_t colormap_shirtcolor;
 337         // light, particles, etc
 338         int effects;
 339         // qw CTF flags and other internal-use-only effect bits
 340         int internaleffects;
 341         // for Alias models
 342         int skinnum;
 343         // render flags
 344         int flags;
 345
 346         // colormod tinting of models
 347         float colormod[3];
 348         float glowmod[3];
 349
 350         // interpolated animation - active framegroups and blend factors
 351         framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
 352
 353         // time of last model change (for shader animations)
 354         double shadertime;
 355
 356         // calculated by the renderer (but not persistent)
 357
 358         // calculated during R_AddModelEntities
 359         vec3_t mins, maxs;
 360         // subframe numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use subframeblend[0].subframe
 361         frameblend_t frameblend[MAX_FRAMEBLENDS];
 362         // skeletal animation data (if skeleton.relativetransforms is not NULL, it overrides frameblend)
 363         skeleton_t *skeleton;
 364
 365         // animation cache (pointers allocated using R_FrameData_Alloc)
 366         // ONLY valid during R_RenderView!  may be NULL (not cached)
 367         float *animcache_vertex3f;
 368         float *animcache_normal3f;
 369         float *animcache_svector3f;
 370         float *animcache_tvector3f;
 371
 372         // current lighting from map (updated ONLY by client code, not renderer)
 373         vec3_t modellight_ambient;
 374         vec3_t modellight_diffuse; // q3bsp
 375         vec3_t modellight_lightdir; // q3bsp
 376
 377         // storage of decals on this entity
 378         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
 379         int allowdecals;
 380         decalsystem_t decalsystem;
 381
 382         // FIELDS UPDATED BY RENDERER:
 383         // last time visible during trace culling
 384         double last_trace_visibility;
 385 }
 386 entity_render_t;
 387
 388 typedef struct entity_persistent_s
 389 {
 390         vec3_t trail_origin;
 391
 392         // particle trail
 393         float trail_time;
 394         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
 395
 396         // muzzleflash fading
 397         float muzzleflash;
 398
 399         // interpolated movement
 400
 401         // start time of move
 402         float lerpstarttime;
 403         // time difference from start to end of move
 404         float lerpdeltatime;
 405         // the move itself, start and end
 406         float oldorigin[3];
 407         float oldangles[3];
 408         float neworigin[3];
 409         float newangles[3];
 410 }
 411 entity_persistent_t;
 412
 413 typedef struct entity_s
 414 {
 415         // baseline state (default values)
 416         entity_state_t state_baseline;
 417         // previous state (interpolating from this)
 418         entity_state_t state_previous;
 419         // current state (interpolating to this)
 420         entity_state_t state_current;
 421
 422         // used for regenerating parts of render
 423         entity_persistent_t persistent;
 424
 425         // the only data the renderer should know about
 426         entity_render_t render;
 427 }
 428 entity_t;
 429
 430 typedef struct usercmd_s
 431 {
 432         vec3_t  viewangles;
 433
 434 // intended velocities
 435         float   forwardmove;
 436         float   sidemove;
 437         float   upmove;
 438
 439         vec3_t  cursor_screen;
 440         vec3_t  cursor_start;
 441         vec3_t  cursor_end;
 442         vec3_t  cursor_impact;
 443         vec3_t  cursor_normal;
 444         vec_t   cursor_fraction;
 445         int             cursor_entitynumber;
 446
 447         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
 448         double receivetime; // time the move was received at
 449         double clienttime; // time to which server state the move corresponds to
 450         int msec; // for predicted moves
 451         int buttons;
 452         int impulse;
 453         int sequence;
 454         qboolean applied; // if false we're still accumulating a move
 455         qboolean predicted; // if true the sequence should be sent as 0
 456
 457         // derived properties
 458         double frametime;
 459         qboolean canjump;
 460         qboolean jump;
 461         qboolean crouch;
 462 } usercmd_t;
 463
 464 typedef struct lightstyle_s
 465 {
 466         int             length;
 467         char    map[MAX_STYLESTRING];
 468 } lightstyle_t;
 469
 470 typedef struct scoreboard_s
 471 {
 472         char    name[MAX_SCOREBOARDNAME];
 473         int             frags;
 474         int             colors; // two 4 bit fields
 475         // QW fields:
 476         int             qw_userid;
 477         char    qw_userinfo[MAX_USERINFO_STRING];
 478         float   qw_entertime;
 479         int             qw_ping;
 480         int             qw_packetloss;
 481         int             qw_spectator;
 482         char    qw_team[8];
 483         char    qw_skin[MAX_QPATH];
 484 } scoreboard_t;
 485
 486 typedef struct cshift_s
 487 {
 488         float   destcolor[3];
 489         float   percent;                // 0-255
 490         float   alphafade;      // (any speed)
 491 } cshift_t;
 492
 493 #define CSHIFT_CONTENTS 0
 494 #define CSHIFT_DAMAGE   1
 495 #define CSHIFT_BONUS    2
 496 #define CSHIFT_POWERUP  3
 497 #define CSHIFT_VCSHIFT  4
 498 #define NUM_CSHIFTS             5
 499
 500 #define NAME_LENGTH     64
 501
 502
 503 //
 504 // client_state_t should hold all pieces of the client state
 505 //
 506
 507 #define SIGNONS         4                       // signon messages to receive before connected
 508
 509 typedef enum cactive_e
 510 {
 511         ca_uninitialized,       // during early startup
 512         ca_dedicated,           // a dedicated server with no ability to start a client
 513         ca_disconnected,        // full screen console with no connection
 514         ca_connected            // valid netcon, talking to a server
 515 }
 516 cactive_t;
 517
 518 typedef enum qw_downloadtype_e
 519 {
 520         dl_none,
 521         dl_single,
 522         dl_skin,
 523         dl_model,
 524         dl_sound
 525 }
 526 qw_downloadtype_t;
 527
 528 typedef enum capturevideoformat_e
 529 {
 530         CAPTUREVIDEOFORMAT_AVI_I420,
 531         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
 532 }
 533 capturevideoformat_t;
 534
 535 typedef struct capturevideostate_s
 536 {
 537         double startrealtime;
 538         double framerate;
 539         int framestep;
 540         int framestepframe;
 541         qboolean active;
 542         qboolean realtime;
 543         qboolean error;
 544         int soundrate;
 545         int soundchannels;
 546         int frame;
 547         double starttime;
 548         double lastfpstime;
 549         int lastfpsframe;
 550         int soundsampleframe;
 551         unsigned char *screenbuffer;
 552         unsigned char *outbuffer;
 553         char basename[MAX_QPATH];
 554         int width, height;
 555
 556         // precomputed RGB to YUV tables
 557         // converts the RGB values to YUV (see cap_avi.c for how to use them)
 558         short rgbtoyuvscaletable[3][3][256];
 559         unsigned char yuvnormalizetable[3][256];
 560
 561         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
 562         // 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
 563         unsigned short vidramp[256 * 3];
 564
 565         // stuff to be filled in by the video format module
 566         capturevideoformat_t format;
 567         const char *formatextension;
 568         qfile_t *videofile;
 569                 // always use this:
 570                 //   cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
 571         void (*endvideo) (void);
 572         void (*videoframes) (int num);
 573         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
 574
 575         // format specific data
 576         void *formatspecific;
 577 }
 578 capturevideostate_t;
 579
 580 #define CL_MAX_DOWNLOADACKS 4
 581
 582 typedef struct cl_downloadack_s
 583 {
 584         int start, size;
 585 }
 586 cl_downloadack_t;
 587
 588 typedef struct cl_soundstats_s
 589 {
 590         int mixedsounds;
 591         int totalsounds;
 592         int latency_milliseconds;
 593 }
 594 cl_soundstats_t;
 595
 596 //
 597 // the client_static_t structure is persistent through an arbitrary number
 598 // of server connections
 599 //
 600 typedef struct client_static_s
 601 {
 602         cactive_t state;
 603
 604         // all client memory allocations go in these pools
 605         mempool_t *levelmempool;
 606         mempool_t *permanentmempool;
 607
 608 // demo loop control
 609         // -1 = don't play demos
 610         int demonum;
 611         // list of demos in loop
 612         char demos[MAX_DEMOS][MAX_DEMONAME];
 613         // the actively playing demo (set by CL_PlayDemo_f)
 614         char demoname[MAX_QPATH];
 615
 616 // demo recording info must be here, because record is started before
 617 // entering a map (and clearing client_state_t)
 618         qboolean demorecording;
 619         fs_offset_t demo_lastcsprogssize;
 620         int demo_lastcsprogscrc;
 621         qboolean demoplayback;
 622         qboolean timedemo;
 623         // -1 = use normal cd track
 624         int forcetrack;
 625         qfile_t *demofile;
 626         // realtime at second frame of timedemo (LordHavoc: changed to double)
 627         double td_starttime;
 628         int td_frames; // total frames parsed
 629         double td_onesecondnexttime;
 630         double td_onesecondframes;
 631         double td_onesecondrealtime;
 632         double td_onesecondminfps;
 633         double td_onesecondmaxfps;
 634         double td_onesecondavgfps;
 635         int td_onesecondavgcount;
 636         // LordHavoc: pausedemo
 637         qboolean demopaused;
 638
 639         // sound mixer statistics for showsound display
 640         cl_soundstats_t soundstats;
 641
 642         qboolean connect_trying;
 643         int connect_remainingtries;
 644         double connect_nextsendtime;
 645         lhnetsocket_t *connect_mysocket;
 646         lhnetaddress_t connect_address;
 647         // protocol version of the server we're connected to
 648         // (kept outside client_state_t because it's used between levels)
 649         protocolversion_t protocol;
 650
 651 #define MAX_RCONS 16
 652         int rcon_trying;
 653         lhnetaddress_t rcon_addresses[MAX_RCONS];
 654         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
 655         double rcon_timeout[MAX_RCONS];
 656         int rcon_ringpos;
 657
 658 // connection information
 659         // 0 to SIGNONS
 660         int signon;
 661         // network connection
 662         netconn_t *netcon;
 663
 664         // download information
 665         // (note: qw_download variables are also used)
 666         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
 667
 668         // input sequence numbers are not reset on level change, only connect
 669         int movesequence;
 670         int servermovesequence;
 671
 672         // quakeworld stuff below
 673
 674         // value of "qport" cvar at time of connection
 675         int qw_qport;
 676         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
 677         int qw_incoming_sequence;
 678         int qw_outgoing_sequence;
 679
 680         // current file download buffer (only saved when file is completed)
 681         char qw_downloadname[MAX_QPATH];
 682         unsigned char *qw_downloadmemory;
 683         int qw_downloadmemorycursize;
 684         int qw_downloadmemorymaxsize;
 685         int qw_downloadnumber;
 686         int qw_downloadpercent;
 687         qw_downloadtype_t qw_downloadtype;
 688         // transfer rate display
 689         double qw_downloadspeedtime;
 690         int qw_downloadspeedcount;
 691         int qw_downloadspeedrate;
 692         qboolean qw_download_deflate;
 693
 694         // current file upload buffer (for uploading screenshots to server)
 695         unsigned char *qw_uploaddata;
 696         int qw_uploadsize;
 697         int qw_uploadpos;
 698
 699         // user infostring
 700         // this normally contains the following keys in quakeworld:
 701         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
 702         char userinfo[MAX_USERINFO_STRING];
 703
 704         // video capture stuff
 705         capturevideostate_t capturevideo;
 706 }
 707 client_static_t;
 708
 709 extern client_static_t  cls;
 710
 711 typedef struct client_movementqueue_s
 712 {
 713         double time;
 714         float frametime;
 715         int sequence;
 716         float viewangles[3];
 717         float move[3];
 718         qboolean jump;
 719         qboolean crouch;
 720         qboolean canjump;
 721 }
 722 client_movementqueue_t;
 723
 724 //[515]: csqc
 725 typedef struct
 726 {
 727         qboolean drawworld;
 728         qboolean drawenginesbar;
 729         qboolean drawcrosshair;
 730 }csqc_vidvars_t;
 731
 732 typedef enum
 733 {
 734         PARTICLE_BILLBOARD = 0,
 735         PARTICLE_SPARK = 1,
 736         PARTICLE_ORIENTED_DOUBLESIDED = 2,
 737         PARTICLE_VBEAM = 3,
 738         PARTICLE_HBEAM = 4,
 739         PARTICLE_INVALID = -1
 740 }
 741 porientation_t;
 742
 743 typedef enum
 744 {
 745         PBLEND_ALPHA = 0,
 746         PBLEND_ADD = 1,
 747         PBLEND_INVMOD = 2,
 748         PBLEND_INVALID = -1
 749 }
 750 pblend_t;
 751
 752 typedef struct particletype_s
 753 {
 754         pblend_t blendmode;
 755         porientation_t orientation;
 756         qboolean lighting;
 757 }
 758 particletype_t;
 759
 760 typedef enum
 761 {
 762         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
 763 }
 764 ptype_t;
 765
 766 typedef struct decal_s
 767 {
 768         // fields used by rendering:  (44 bytes)
 769         unsigned short  typeindex;
 770         unsigned short  texnum;
 771         int                             decalsequence;
 772         vec3_t                  org;
 773         vec3_t                  normal;
 774         float                   size;
 775         float                   alpha; // 0-255
 776         unsigned char   color[3];
 777         unsigned char   unused1;
 778         int                             clusterindex; // cheap culling by pvs
 779
 780         // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
 781         float                   time2; // used for decal fade
 782         unsigned int    owner; // decal stuck to this entity
 783         dp_model_t                      *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
 784         vec3_t                  relativeorigin; // decal at this location in entity's coordinate space
 785         vec3_t                  relativenormal; // decal oriented this way relative to entity's coordinate space
 786 }
 787 decal_t;
 788
 789 typedef struct particle_s
 790 {
 791         // fields used by rendering: (40 bytes)
 792         unsigned char   typeindex;
 793         pblend_t   blendmode;
 794         porientation_t   orientation;
 795         unsigned char   texnum;
 796         vec3_t                  org;
 797         vec3_t                  vel; // velocity of particle, or orientation of decal, or end point of beam
 798         float                   size;
 799         float                   alpha; // 0-255
 800         unsigned char   color[3];
 801         unsigned char   qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
 802         float           stretch; // only for sparks
 803         int             staincolor;
 804         signed char     staintexnum;
 805         float           stainsizefactor;
 806
 807         // fields not used by rendering:  (40 bytes)
 808         float                   sizeincrease; // rate of size change per second
 809         float                   alphafade; // how much alpha reduces per second
 810         float                   time2; // used for snow fluttering and decal fade
 811         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)
 812         float                   gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
 813         float                   airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
 814         float                   liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
 815         float                   delayedcollisions; // time that p->bounce becomes active
 816         float                   delayedspawn; // time that particle appears and begins moving
 817         float                   die; // time when this particle should be removed, regardless of alpha
 818 }
 819 particle_t;
 820
 821 typedef enum cl_parsingtextmode_e
 822 {
 823         CL_PARSETEXTMODE_NONE,
 824         CL_PARSETEXTMODE_PING,
 825         CL_PARSETEXTMODE_STATUS,
 826         CL_PARSETEXTMODE_STATUS_PLAYERID,
 827         CL_PARSETEXTMODE_STATUS_PLAYERIP
 828 }
 829 cl_parsingtextmode_t;
 830
 831 typedef struct cl_locnode_s
 832 {
 833         struct cl_locnode_s *next;
 834         char *name;
 835         vec3_t mins, maxs;
 836 }
 837 cl_locnode_t;
 838
 839 typedef struct showlmp_s
 840 {
 841         qboolean        isactive;
 842         float           x;
 843         float           y;
 844         char            label[32];
 845         char            pic[128];
 846 }
 847 showlmp_t;
 848
 849 //
 850 // the client_state_t structure is wiped completely at every
 851 // server signon
 852 //
 853 typedef struct client_state_s
 854 {
 855         // true if playing in a local game and no one else is connected
 856         int islocalgame;
 857
 858         // send a clc_nop periodically until connected
 859         float sendnoptime;
 860
 861         // current input being accumulated by mouse/joystick/etc input
 862         usercmd_t cmd;
 863         // latest moves sent to the server that have not been confirmed yet
 864         usercmd_t movecmd[CL_MAX_USERCMDS];
 865
 866 // information for local display
 867         // health, etc
 868         int stats[MAX_CL_STATS];
 869         float *statsf; // points to stats[] array
 870         // last known inventory bit flags, for blinking
 871         int olditems;
 872         // cl.time of acquiring item, for blinking
 873         float item_gettime[32];
 874         // last known STAT_ACTIVEWEAPON
 875         int activeweapon;
 876         // cl.time of changing STAT_ACTIVEWEAPON
 877         float weapontime;
 878         // use pain anim frame if cl.time < this
 879         float faceanimtime;
 880         // for stair smoothing
 881         float stairsmoothz;
 882         double stairsmoothtime;
 883
 884         // color shifts for damage, powerups
 885         cshift_t cshifts[NUM_CSHIFTS];
 886         // and content types
 887         cshift_t prev_cshifts[NUM_CSHIFTS];
 888
 889 // the client maintains its own idea of view angles, which are
 890 // sent to the server each frame.  The server sets punchangle when
 891 // the view is temporarily offset, and an angle reset commands at the start
 892 // of each level and after teleporting.
 893
 894         // mviewangles is read from demo
 895         // viewangles is either client controlled or lerped from mviewangles
 896         vec3_t mviewangles[2], viewangles;
 897         // update by server, used by qc to do weapon recoil
 898         vec3_t mpunchangle[2], punchangle;
 899         // update by server, can be used by mods to kick view around
 900         vec3_t mpunchvector[2], punchvector;
 901         // update by server, used for lean+bob (0 is newest)
 902         vec3_t mvelocity[2], velocity;
 903         // update by server, can be used by mods for zooming
 904         vec_t mviewzoom[2], viewzoom;
 905         // if true interpolation the mviewangles and other interpolation of the
 906         // player is disabled until the next network packet
 907         // this is used primarily by teleporters, and when spectating players
 908         // special checking of the old fixangle[1] is used to differentiate
 909         // between teleporting and spectating
 910         qboolean fixangle[2];
 911
 912         // client movement simulation
 913         // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
 914         // set by CL_ClientMovement_Replay functions
 915         qboolean movement_predicted;
 916         // if true the CL_ClientMovement_Replay function will update origin, etc
 917         qboolean movement_replay;
 918         // simulated data (this is valid even if cl.movement is false)
 919         vec3_t movement_origin;
 920         vec3_t movement_velocity;
 921         // whether the replay should allow a jump at the first sequence
 922         qboolean movement_replay_canjump;
 923
 924 // pitch drifting vars
 925         float idealpitch;
 926         float pitchvel;
 927         qboolean nodrift;
 928         float driftmove;
 929         double laststop;
 930
 931 //[515]: added for csqc purposes
 932         float sensitivityscale;
 933         csqc_vidvars_t csqc_vidvars;    //[515]: these parms must be set to true by default
 934         qboolean csqc_wantsmousemove;
 935         struct model_s *csqc_model_precache[MAX_MODELS];
 936
 937         // local amount for smoothing stepups
 938         //float crouch;
 939
 940         // sent by server
 941         qboolean paused;
 942         qboolean onground;
 943         qboolean inwater;
 944
 945         // used by bob
 946         qboolean oldonground;
 947         double lastongroundtime;
 948         double hitgroundtime;
 949
 950         // don't change view angle, full screen, etc
 951         int intermission;
 952         // latched at intermission start
 953         double completed_time;
 954
 955         // the timestamp of the last two messages
 956         double mtime[2];
 957
 958         // clients view of time, time should be between mtime[0] and mtime[1] to
 959         // generate a lerp point for other data, oldtime is the previous frame's
 960         // value of time, frametime is the difference between time and oldtime
 961         // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
 962         // is only forcefully limited when a packet is received
 963         double time, oldtime;
 964         // how long it has been since the previous client frame in real time
 965         // (not game time, for that use cl.time - cl.oldtime)
 966         double realframetime;
 967
 968         // fade var for fading while dead
 969         float deathfade;
 970
 971         // motionblur alpha level variable
 972         float motionbluralpha;
 973
 974         // copy of realtime from last recieved message, for net trouble icon
 975         float last_received_message;
 976
 977 // information that is static for the entire time connected to a server
 978         struct model_s *model_precache[MAX_MODELS];
 979         struct sfx_s *sound_precache[MAX_SOUNDS];
 980
 981         // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
 982         char model_name[MAX_MODELS][MAX_QPATH];
 983         char sound_name[MAX_SOUNDS][MAX_QPATH];
 984
 985         // for display on solo scoreboard
 986         char levelname[40];
 987         // cl_entitites[cl.viewentity] = player
 988         int viewentity;
 989         // the real player entity (normally same as viewentity,
 990         // different than viewentity if mod uses chasecam or other tricks)
 991         int realplayerentity;
 992         // this is updated to match cl.viewentity whenever it is in the clients
 993         // range, basically this is used in preference to cl.realplayerentity for
 994         // most purposes because when spectating another player it should show
 995         // their information rather than yours
 996         int playerentity;
 997         // max players that can be in this game
 998         int maxclients;
 999         // type of game (deathmatch, coop, singleplayer)
1000         int gametype;
1001
1002         // models and sounds used by engine code (particularly cl_parse.c)
1003         dp_model_t *model_bolt;
1004         dp_model_t *model_bolt2;
1005         dp_model_t *model_bolt3;
1006         dp_model_t *model_beam;
1007         sfx_t *sfx_wizhit;
1008         sfx_t *sfx_knighthit;
1009         sfx_t *sfx_tink1;
1010         sfx_t *sfx_ric1;
1011         sfx_t *sfx_ric2;
1012         sfx_t *sfx_ric3;
1013         sfx_t *sfx_r_exp3;
1014         // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1015         qboolean foundtalk2wav;
1016
1017 // refresh related state
1018
1019         // cl_entitites[0].model
1020         struct model_s *worldmodel;
1021
1022         // the gun model
1023         entity_t viewent;
1024
1025         // cd audio
1026         int cdtrack, looptrack;
1027
1028 // frag scoreboard
1029
1030         // [cl.maxclients]
1031         scoreboard_t *scores;
1032
1033         // keep track of svc_print parsing state (analyzes ping reports and status reports)
1034         cl_parsingtextmode_t parsingtextmode;
1035         int parsingtextplayerindex;
1036         // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1037         // (which could eat the wrong ping report if the player issues one
1038         //  manually, but they would still see a ping report, just a later one
1039         //  caused by the scoreboard code rather than the one they intentionally
1040         //  issued)
1041         int parsingtextexpectingpingforscores;
1042
1043         // entity database stuff
1044         // latest received entity frame numbers
1045 #define LATESTFRAMENUMS 3
1046         int latestframenums[LATESTFRAMENUMS];
1047         entityframe_database_t *entitydatabase;
1048         entityframe4_database_t *entitydatabase4;
1049         entityframeqw_database_t *entitydatabaseqw;
1050
1051         // keep track of quake entities because they need to be killed if they get stale
1052         int lastquakeentity;
1053         unsigned char isquakeentity[MAX_EDICTS];
1054
1055         // bounding boxes for clientside movement
1056         vec3_t playerstandmins;
1057         vec3_t playerstandmaxs;
1058         vec3_t playercrouchmins;
1059         vec3_t playercrouchmaxs;
1060
1061         // old decals are killed based on this
1062         int decalsequence;
1063
1064         int max_entities;
1065         int max_csqcrenderentities;
1066         int max_static_entities;
1067         int max_effects;
1068         int max_beams;
1069         int max_dlights;
1070         int max_lightstyle;
1071         int max_brushmodel_entities;
1072         int max_particles;
1073         int max_decals;
1074         int max_showlmps;
1075
1076         entity_t *entities;
1077         entity_render_t *csqcrenderentities;
1078         unsigned char *entities_active;
1079         entity_t *static_entities;
1080         cl_effect_t *effects;
1081         beam_t *beams;
1082         dlight_t *dlights;
1083         lightstyle_t *lightstyle;
1084         int *brushmodel_entities;
1085         particle_t *particles;
1086         decal_t *decals;
1087         showlmp_t *showlmps;
1088
1089         int num_entities;
1090         int num_static_entities;
1091         int num_brushmodel_entities;
1092         int num_effects;
1093         int num_beams;
1094         int num_dlights;
1095         int num_particles;
1096         int num_decals;
1097         int num_showlmps;
1098
1099         double particles_updatetime;
1100         double decals_updatetime;
1101         int free_particle;
1102         int free_decal;
1103
1104         // cl_serverextension_download feature
1105         int loadmodel_current;
1106         int downloadmodel_current;
1107         int loadmodel_total;
1108         int loadsound_current;
1109         int downloadsound_current;
1110         int loadsound_total;
1111         qboolean downloadcsqc;
1112         qboolean loadcsqc;
1113         qboolean loadbegun;
1114         qboolean loadfinished;
1115
1116         // quakeworld stuff
1117
1118         // local copy of the server infostring
1119         char qw_serverinfo[MAX_SERVERINFO_STRING];
1120
1121         // time of last qw "pings" command sent to server while showing scores
1122         double last_ping_request;
1123
1124         // used during connect
1125         int qw_servercount;
1126
1127         // updated from serverinfo
1128         int qw_teamplay;
1129
1130         // unused: indicates whether the player is spectating
1131         // use cl.scores[cl.playerentity-1].qw_spectator instead
1132         //qboolean qw_spectator;
1133
1134         // last time an input packet was sent
1135         double lastpackettime;
1136
1137         // movement parameters for client prediction
1138         unsigned int moveflags;
1139         float movevars_wallfriction;
1140         float movevars_waterfriction;
1141         float movevars_friction;
1142         float movevars_timescale;
1143         float movevars_gravity;
1144         float movevars_stopspeed;
1145         float movevars_maxspeed;
1146         float movevars_spectatormaxspeed;
1147         float movevars_accelerate;
1148         float movevars_airaccelerate;
1149         float movevars_wateraccelerate;
1150         float movevars_entgravity;
1151         float movevars_jumpvelocity;
1152         float movevars_edgefriction;
1153         float movevars_maxairspeed;
1154         float movevars_stepheight;
1155         float movevars_airaccel_qw;
1156         float movevars_airaccel_sideways_friction;
1157         float movevars_airstopaccelerate;
1158         float movevars_airstrafeaccelerate;
1159         float movevars_maxairstrafespeed;
1160         float movevars_aircontrol;
1161         float movevars_warsowbunny_airforwardaccel;
1162         float movevars_warsowbunny_accel;
1163         float movevars_warsowbunny_topspeed;
1164         float movevars_warsowbunny_turnaccel;
1165         float movevars_warsowbunny_backtosideratio;
1166         float movevars_ticrate;
1167
1168         // models used by qw protocol
1169         int qw_modelindex_spike;
1170         int qw_modelindex_player;
1171         int qw_modelindex_flag;
1172         int qw_modelindex_s_explod;
1173
1174         vec3_t qw_intermission_origin;
1175         vec3_t qw_intermission_angles;
1176
1177         // 255 is the most nails the QW protocol could send
1178         int qw_num_nails;
1179         vec_t qw_nails[255][6];
1180
1181         float qw_weaponkick;
1182
1183         int qw_validsequence;
1184
1185         int qw_deltasequence[QW_UPDATE_BACKUP];
1186
1187         // csqc stuff:
1188         // server entity number corresponding to a clientside entity
1189         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1190         qboolean csqc_loaded;
1191         vec3_t csqc_origin;
1192         vec3_t csqc_angles;
1193         qboolean csqc_usecsqclistener;
1194         matrix4x4_t csqc_listenermatrix;
1195         char csqc_printtextbuf[MAX_INPUTLINE];
1196
1197         // collision culling data
1198         world_t world;
1199
1200         // loc file stuff (points and boxes describing locations in the level)
1201         cl_locnode_t *locnodes;
1202         // this is updated to cl.movement_origin whenever health is < 1
1203         // used by %d print in say/say_team messages if cl_locs_enable is on
1204         vec3_t lastdeathorigin;
1205
1206         // processing buffer used by R_BuildLightMap, reallocated as needed,
1207         // freed on each level change
1208         size_t buildlightmapmemorysize;
1209         unsigned char *buildlightmapmemory;
1210 }
1211 client_state_t;
1212
1213 //
1214 // cvars
1215 //
1216 extern cvar_t cl_name;
1217 extern cvar_t cl_color;
1218 extern cvar_t cl_rate;
1219 extern cvar_t cl_pmodel;
1220 extern cvar_t cl_playermodel;
1221 extern cvar_t cl_playerskin;
1222
1223 extern cvar_t rcon_password;
1224 extern cvar_t rcon_address;
1225
1226 extern cvar_t cl_upspeed;
1227 extern cvar_t cl_forwardspeed;
1228 extern cvar_t cl_backspeed;
1229 extern cvar_t cl_sidespeed;
1230
1231 extern cvar_t cl_movespeedkey;
1232
1233 extern cvar_t cl_yawspeed;
1234 extern cvar_t cl_pitchspeed;
1235
1236 extern cvar_t cl_anglespeedkey;
1237
1238 extern cvar_t cl_autofire;
1239
1240 extern cvar_t cl_shownet;
1241 extern cvar_t cl_nolerp;
1242 extern cvar_t cl_nettimesyncfactor;
1243 extern cvar_t cl_nettimesyncboundmode;
1244 extern cvar_t cl_nettimesyncboundtolerance;
1245
1246 extern cvar_t cl_pitchdriftspeed;
1247 extern cvar_t lookspring;
1248 extern cvar_t lookstrafe;
1249 extern cvar_t sensitivity;
1250
1251 extern cvar_t freelook;
1252
1253 extern cvar_t m_pitch;
1254 extern cvar_t m_yaw;
1255 extern cvar_t m_forward;
1256 extern cvar_t m_side;
1257
1258 extern cvar_t cl_autodemo;
1259 extern cvar_t cl_autodemo_nameformat;
1260
1261 extern cvar_t r_draweffects;
1262
1263 extern cvar_t cl_explosions_alpha_start;
1264 extern cvar_t cl_explosions_alpha_end;
1265 extern cvar_t cl_explosions_size_start;
1266 extern cvar_t cl_explosions_size_end;
1267 extern cvar_t cl_explosions_lifetime;
1268 extern cvar_t cl_stainmaps;
1269 extern cvar_t cl_stainmaps_clearonload;
1270
1271 extern cvar_t cl_prydoncursor;
1272
1273 extern cvar_t cl_locs_enable;
1274
1275 extern client_state_t cl;
1276
1277 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);
1278
1279 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1280 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1281
1282 //=============================================================================
1283
1284 //
1285 // cl_main
1286 //
1287
1288 void CL_Shutdown (void);
1289 void CL_Init (void);
1290
1291 void CL_EstablishConnection(const char *host);
1292
1293 void CL_Disconnect (void);
1294 void CL_Disconnect_f (void);
1295
1296 void CL_UpdateRenderEntity(entity_render_t *ent);
1297 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1298 void CL_UpdateViewEntities(void);
1299
1300 //
1301 // cl_input
1302 //
1303 typedef struct kbutton_s
1304 {
1305         int             down[2];                // key nums holding it down
1306         int             state;                  // low bit is down state
1307 }
1308 kbutton_t;
1309
1310 extern  kbutton_t       in_mlook, in_klook;
1311 extern  kbutton_t       in_strafe;
1312 extern  kbutton_t       in_speed;
1313
1314 void CL_InitInput (void);
1315 void CL_SendMove (void);
1316
1317 void CL_ValidateState(entity_state_t *s);
1318 void CL_MoveLerpEntityStates(entity_t *ent);
1319 void CL_LerpUpdate(entity_t *e);
1320 void CL_ParseTEnt (void);
1321 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1322 void CL_RelinkBeams (void);
1323 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1324 void CL_ClientMovement_Replay(void);
1325
1326 void CL_ClearTempEntities (void);
1327 entity_render_t *CL_NewTempEntity (double shadertime);
1328
1329 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1330
1331 void CL_ClearState (void);
1332 void CL_ExpandEntities(int num);
1333 void CL_ExpandCSQCRenderEntities(int num);
1334 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1335
1336
1337 void CL_UpdateWorld (void);
1338 void CL_WriteToServer (void);
1339 void CL_Input (void);
1340 extern int cl_ignoremousemoves;
1341
1342
1343 float CL_KeyState (kbutton_t *key);
1344 const char *Key_KeynumToString (int keynum);
1345 int Key_StringToKeynum (const char *str);
1346
1347 //
1348 // cl_demo.c
1349 //
1350 void CL_StopPlayback(void);
1351 void CL_ReadDemoMessage(void);
1352 void CL_WriteDemoMessage(sizebuf_t *mesage);
1353
1354 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1355 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1356
1357 void CL_NextDemo(void);
1358 void CL_Stop_f(void);
1359 void CL_Record_f(void);
1360 void CL_PlayDemo_f(void);
1361 void CL_TimeDemo_f(void);
1362
1363 //
1364 // cl_parse.c
1365 //
1366 void CL_Parse_Init(void);
1367 void CL_Parse_Shutdown(void);
1368 void CL_ParseServerMessage(void);
1369 void CL_Parse_DumpPacket(void);
1370 void CL_Parse_ErrorCleanUp(void);
1371 void QW_CL_StartUpload(unsigned char *data, int size);
1372 extern cvar_t qport;
1373 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1374
1375 //
1376 // view
1377 //
1378 void V_StartPitchDrift (void);
1379 void V_StopPitchDrift (void);
1380
1381 void V_Init (void);
1382 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1383 void V_UpdateBlends (void);
1384 void V_ParseDamage (void);
1385
1386 //
1387 // cl_part
1388 //
1389
1390 extern cvar_t cl_particles;
1391 extern cvar_t cl_particles_quality;
1392 extern cvar_t cl_particles_size;
1393 extern cvar_t cl_particles_quake;
1394 extern cvar_t cl_particles_blood;
1395 extern cvar_t cl_particles_blood_alpha;
1396 extern cvar_t cl_particles_blood_bloodhack;
1397 extern cvar_t cl_particles_bulletimpacts;
1398 extern cvar_t cl_particles_explosions_sparks;
1399 extern cvar_t cl_particles_explosions_shell;
1400 extern cvar_t cl_particles_rain;
1401 extern cvar_t cl_particles_snow;
1402 extern cvar_t cl_particles_smoke;
1403 extern cvar_t cl_particles_smoke_alpha;
1404 extern cvar_t cl_particles_smoke_alphafade;
1405 extern cvar_t cl_particles_sparks;
1406 extern cvar_t cl_particles_bubbles;
1407 extern cvar_t cl_decals;
1408 extern cvar_t cl_decals_time;
1409 extern cvar_t cl_decals_fadetime;
1410
1411 void CL_Particles_Clear(void);
1412 void CL_Particles_Init(void);
1413 void CL_Particles_Shutdown(void);
1414 particle_t *CL_NewParticle(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);
1415
1416 typedef enum effectnameindex_s
1417 {
1418         EFFECT_NONE,
1419         EFFECT_TE_GUNSHOT,
1420         EFFECT_TE_GUNSHOTQUAD,
1421         EFFECT_TE_SPIKE,
1422         EFFECT_TE_SPIKEQUAD,
1423         EFFECT_TE_SUPERSPIKE,
1424         EFFECT_TE_SUPERSPIKEQUAD,
1425         EFFECT_TE_WIZSPIKE,
1426         EFFECT_TE_KNIGHTSPIKE,
1427         EFFECT_TE_EXPLOSION,
1428         EFFECT_TE_EXPLOSIONQUAD,
1429         EFFECT_TE_TAREXPLOSION,
1430         EFFECT_TE_TELEPORT,
1431         EFFECT_TE_LAVASPLASH,
1432         EFFECT_TE_SMALLFLASH,
1433         EFFECT_TE_FLAMEJET,
1434         EFFECT_EF_FLAME,
1435         EFFECT_TE_BLOOD,
1436         EFFECT_TE_SPARK,
1437         EFFECT_TE_PLASMABURN,
1438         EFFECT_TE_TEI_G3,
1439         EFFECT_TE_TEI_SMOKE,
1440         EFFECT_TE_TEI_BIGEXPLOSION,
1441         EFFECT_TE_TEI_PLASMAHIT,
1442         EFFECT_EF_STARDUST,
1443         EFFECT_TR_ROCKET,
1444         EFFECT_TR_GRENADE,
1445         EFFECT_TR_BLOOD,
1446         EFFECT_TR_WIZSPIKE,
1447         EFFECT_TR_SLIGHTBLOOD,
1448         EFFECT_TR_KNIGHTSPIKE,
1449         EFFECT_TR_VORESPIKE,
1450         EFFECT_TR_NEHAHRASMOKE,
1451         EFFECT_TR_NEXUIZPLASMA,
1452         EFFECT_TR_GLOWTRAIL,
1453         EFFECT_SVC_PARTICLE,
1454         EFFECT_TOTAL
1455 }
1456 effectnameindex_t;
1457
1458 int CL_ParticleEffectIndexForName(const char *name);
1459 const char *CL_ParticleEffectNameForIndex(int i);
1460 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);
1461 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);
1462 void CL_ParseParticleEffect (void);
1463 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);
1464 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1465 void CL_EntityParticles (const entity_t *ent);
1466 void CL_ParticleExplosion (const vec3_t org);
1467 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1468 void R_NewExplosion(const vec3_t org);
1469
1470 void Debug_PolygonBegin(const char *picname, int flags);
1471 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1472 void Debug_PolygonEnd(void);
1473
1474 #include "cl_screen.h"
1475
1476 extern qboolean sb_showscores;
1477
1478 float RSurf_FogVertex(const vec3_t p);
1479 float RSurf_FogPoint(const vec3_t p);
1480
1481 typedef struct r_refdef_stats_s
1482 {
1483         int renders;
1484         int entities;
1485         int entities_surfaces;
1486         int entities_triangles;
1487         int world_leafs;
1488         int world_portals;
1489         int world_surfaces;
1490         int world_triangles;
1491         int lightmapupdates;
1492         int lightmapupdatepixels;
1493         int particles;
1494         int drawndecals;
1495         int totaldecals;
1496         int meshes;
1497         int meshes_elements;
1498         int lights;
1499         int lights_clears;
1500         int lights_scissored;
1501         int lights_lighttriangles;
1502         int lights_shadowtriangles;
1503         int lights_dynamicshadowtriangles;
1504         int bloom;
1505         int bloom_copypixels;
1506         int bloom_drawpixels;
1507 }
1508 r_refdef_stats_t;
1509
1510 typedef enum r_viewport_type_e
1511 {
1512         R_VIEWPORTTYPE_ORTHO,
1513         R_VIEWPORTTYPE_PERSPECTIVE,
1514         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1515         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1516         R_VIEWPORTTYPE_TOTAL
1517 }
1518 r_viewport_type_t;
1519
1520 typedef struct r_viewport_s
1521 {
1522         double m[16];
1523         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1524         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1525         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1526         int x;
1527         int y;
1528         int z;
1529         int width;
1530         int height;
1531         int depth;
1532         r_viewport_type_t type;
1533 }
1534 r_viewport_t;
1535
1536 typedef struct r_refdef_view_s
1537 {
1538         // view information (changes multiple times per frame)
1539         // if any of these variables change then r_refdef.viewcache must be regenerated
1540         // by calling R_View_Update
1541         // (which also updates viewport, scissor, colormask)
1542
1543         // it is safe and expected to copy this into a structure on the stack and
1544         // call the renderer recursively, then restore from the stack afterward
1545         // (as long as R_View_Update is called)
1546
1547         // eye position information
1548         matrix4x4_t matrix, inverse_matrix;
1549         vec3_t origin;
1550         vec3_t forward;
1551         vec3_t left;
1552         vec3_t right;
1553         vec3_t up;
1554         int numfrustumplanes;
1555         mplane_t frustum[6];
1556         qboolean useclipplane;
1557         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1558         mplane_t clipplane;
1559         float frustum_x, frustum_y;
1560         vec3_t frustumcorner[4];
1561         // if turned off it renders an ortho view
1562         int useperspective;
1563         float ortho_x, ortho_y;
1564
1565         // screen area to render in
1566         int x;
1567         int y;
1568         int z;
1569         int width;
1570         int height;
1571         int depth;
1572         r_viewport_t viewport;
1573
1574         // which color components to allow (for anaglyph glasses)
1575         int colormask[4];
1576
1577         // global RGB color multiplier for rendering, this is required by HDR
1578         float colorscale;
1579
1580         // whether to call R_ClearScreen before rendering stuff
1581         qboolean clear;
1582         // if true, don't clear or do any post process effects (bloom, etc)
1583         qboolean isoverlay;
1584
1585         // whether to draw r_showtris and such, this is only true for the main
1586         // view render, all secondary renders (HDR, mirrors, portals, cameras,
1587         // distortion effects, etc) omit such debugging information
1588         qboolean showdebug;
1589
1590         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1591         int cullface_front;
1592         int cullface_back;
1593
1594         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1595         float quality;
1596 }
1597 r_refdef_view_t;
1598
1599 typedef struct r_refdef_viewcache_s
1600 {
1601         // updated by gl_main_newmap()
1602         int maxentities;
1603         int world_numclusters;
1604         int world_numclusterbytes;
1605         int world_numleafs;
1606         int world_numsurfaces;
1607
1608         // these properties are generated by R_View_Update()
1609
1610         // which entities are currently visible for this viewpoint
1611         // (the used range is 0...r_refdef.scene.numentities)
1612         unsigned char *entityvisible;
1613
1614         // flag arrays used for visibility checking on world model
1615         // (all other entities have no per-surface/per-leaf visibility checks)
1616         unsigned char *world_pvsbits;
1617         unsigned char *world_leafvisible;
1618         unsigned char *world_surfacevisible;
1619         // if true, the view is currently in a leaf without pvs data
1620         qboolean world_novis;
1621 }
1622 r_refdef_viewcache_t;
1623
1624 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1625 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1626 typedef struct r_refdef_scene_s {
1627         // whether to call S_ExtraUpdate during render to reduce sound chop
1628         qboolean extraupdate;
1629
1630         // (client gameworld) time for rendering time based effects
1631         double time;
1632
1633         // the world
1634         entity_render_t *worldentity;
1635
1636         // same as worldentity->model
1637         dp_model_t *worldmodel;
1638
1639         // renderable entities (excluding world)
1640         entity_render_t **entities;
1641         int numentities;
1642         int maxentities;
1643
1644         // field of temporary entities that is reset each (client) frame
1645         entity_render_t *tempentities;
1646         int numtempentities;
1647         int maxtempentities;
1648
1649         // renderable dynamic lights
1650         rtlight_t *lights[MAX_DLIGHTS];
1651         rtlight_t templights[MAX_DLIGHTS];
1652         int numlights;
1653
1654         // intensities for light styles right now, controls rtlights
1655         float rtlightstylevalue[MAX_LIGHTSTYLES];       // float fraction of base light value
1656         // 8.8bit fixed point intensities for light styles
1657         // controls intensity lightmap layers
1658         unsigned short lightstylevalue[MAX_LIGHTSTYLES];        // 8.8 fraction of base light value
1659
1660         float ambient;
1661
1662         qboolean rtworld;
1663         qboolean rtworldshadows;
1664         qboolean rtdlight;
1665         qboolean rtdlightshadows;
1666 } r_refdef_scene_t;
1667
1668 typedef struct r_refdef_s
1669 {
1670         // these fields define the basic rendering information for the world
1671         // but not the view, which could change multiple times in one rendered
1672         // frame (for example when rendering textures for certain effects)
1673
1674         // these are set for water warping before
1675         // frustum_x/frustum_y are calculated
1676         float frustumscale_x, frustumscale_y;
1677
1678         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1679         r_refdef_view_t view;
1680         r_refdef_viewcache_t viewcache;
1681
1682         // minimum visible distance (pixels closer than this disappear)
1683         double nearclip;
1684         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1685         // in 32bpp an infinite-farclip matrix is used instead)
1686         double farclip;
1687
1688         // fullscreen color blend
1689         float viewblend[4];
1690
1691         r_refdef_scene_t scene;
1692
1693         float fogplane[4];
1694         float fogplaneviewdist;
1695         qboolean fogplaneviewabove;
1696         float fogheightfade;
1697         float fogcolor[3];
1698         float fogrange;
1699         float fograngerecip;
1700         float fogmasktabledistmultiplier;
1701 #define FOGMASKTABLEWIDTH 1024
1702         float fogmasktable[FOGMASKTABLEWIDTH];
1703         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1704         float fog_density;
1705         float fog_red;
1706         float fog_green;
1707         float fog_blue;
1708         float fog_alpha;
1709         float fog_start;
1710         float fog_end;
1711         float fog_height;
1712         float fog_fadedepth;
1713         qboolean fogenabled;
1714         qboolean oldgl_fogenable;
1715
1716         qboolean draw2dstage;
1717
1718         // true during envmap command capture
1719         qboolean envmap;
1720
1721         // brightness of world lightmaps and related lighting
1722         // (often reduced when world rtlights are enabled)
1723         float lightmapintensity;
1724         // whether to draw world lights realtime, dlights realtime, and their shadows
1725         float polygonfactor;
1726         float polygonoffset;
1727         float shadowpolygonfactor;
1728         float shadowpolygonoffset;
1729
1730         // rendering stats for r_speeds display
1731         // (these are incremented in many places)
1732         r_refdef_stats_t stats;
1733 }
1734 r_refdef_t;
1735
1736 extern r_refdef_t r_refdef;
1737
1738 #endif
1739