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