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 // LordHavoc: 256 dynamic lights
  29 #define MAX_DLIGHTS 256
  30
  31 /// this is the maximum number of input packets that can be predicted
  32 #define CL_MAX_USERCMDS 128
  33
  34 // flags for rtlight rendering
  35 #define LIGHTFLAG_NORMALMODE 1
  36 #define LIGHTFLAG_REALTIMEMODE 2
  37
  38 typedef struct tridecal_s
  39 {
  40         // color and initial alpha value
  41         unsigned char   colors[3][4];
  42         // how long this decal has lived so far (the actual fade begins at cl_decals_time)
  43         float                   lived;
  44         // if >= 0 this indicates the decal should follow an animated triangle
  45         int                             triangleindex;
  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
 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
 340         // animation cache index
 341         int animcacheindex;
 342
 343         // current lighting from map (updated ONLY by client code, not renderer)
 344         vec3_t modellight_ambient;
 345         vec3_t modellight_diffuse; // q3bsp
 346         vec3_t modellight_lightdir; // q3bsp
 347
 348         // storage of decals on this entity
 349         // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
 350         int allowdecals;
 351         decalsystem_t decalsystem;
 352
 353         // FIELDS UPDATED BY RENDERER:
 354         // last time visible during trace culling
 355         double last_trace_visibility;
 356 }
 357 entity_render_t;
 358
 359 typedef struct entity_persistent_s
 360 {
 361         vec3_t trail_origin;
 362
 363         // particle trail
 364         float trail_time;
 365         qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
 366
 367         // muzzleflash fading
 368         float muzzleflash;
 369
 370         // interpolated movement
 371
 372         // start time of move
 373         float lerpstarttime;
 374         // time difference from start to end of move
 375         float lerpdeltatime;
 376         // the move itself, start and end
 377         float oldorigin[3];
 378         float oldangles[3];
 379         float neworigin[3];
 380         float newangles[3];
 381 }
 382 entity_persistent_t;
 383
 384 typedef struct entity_s
 385 {
 386         // baseline state (default values)
 387         entity_state_t state_baseline;
 388         // previous state (interpolating from this)
 389         entity_state_t state_previous;
 390         // current state (interpolating to this)
 391         entity_state_t state_current;
 392
 393         // used for regenerating parts of render
 394         entity_persistent_t persistent;
 395
 396         // the only data the renderer should know about
 397         entity_render_t render;
 398 }
 399 entity_t;
 400
 401 typedef struct usercmd_s
 402 {
 403         vec3_t  viewangles;
 404
 405 // intended velocities
 406         float   forwardmove;
 407         float   sidemove;
 408         float   upmove;
 409
 410         vec3_t  cursor_screen;
 411         vec3_t  cursor_start;
 412         vec3_t  cursor_end;
 413         vec3_t  cursor_impact;
 414         vec3_t  cursor_normal;
 415         vec_t   cursor_fraction;
 416         int             cursor_entitynumber;
 417
 418         double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
 419         double receivetime; // time the move was received at
 420         double clienttime; // time to which server state the move corresponds to
 421         int msec; // for predicted moves
 422         int buttons;
 423         int impulse;
 424         int sequence;
 425         qboolean applied; // if false we're still accumulating a move
 426         qboolean predicted; // if true the sequence should be sent as 0
 427
 428         // derived properties
 429         double frametime;
 430         qboolean canjump;
 431         qboolean jump;
 432         qboolean crouch;
 433 } usercmd_t;
 434
 435 typedef struct lightstyle_s
 436 {
 437         int             length;
 438         char    map[MAX_STYLESTRING];
 439 } lightstyle_t;
 440
 441 typedef struct scoreboard_s
 442 {
 443         char    name[MAX_SCOREBOARDNAME];
 444         int             frags;
 445         int             colors; // two 4 bit fields
 446         // QW fields:
 447         int             qw_userid;
 448         char    qw_userinfo[MAX_USERINFO_STRING];
 449         float   qw_entertime;
 450         int             qw_ping;
 451         int             qw_packetloss;
 452         int             qw_spectator;
 453         char    qw_team[8];
 454         char    qw_skin[MAX_QPATH];
 455 } scoreboard_t;
 456
 457 typedef struct cshift_s
 458 {
 459         float   destcolor[3];
 460         float   percent;                // 0-255
 461         float   alphafade;      // (any speed)
 462 } cshift_t;
 463
 464 #define CSHIFT_CONTENTS 0
 465 #define CSHIFT_DAMAGE   1
 466 #define CSHIFT_BONUS    2
 467 #define CSHIFT_POWERUP  3
 468 #define CSHIFT_VCSHIFT  4
 469 #define NUM_CSHIFTS             5
 470
 471 #define NAME_LENGTH     64
 472
 473
 474 //
 475 // client_state_t should hold all pieces of the client state
 476 //
 477
 478 #define SIGNONS         4                       // signon messages to receive before connected
 479
 480 #define MAX_DEMOS               8
 481 #define MAX_DEMONAME    16
 482
 483 typedef enum cactive_e
 484 {
 485         ca_uninitialized,       // during early startup
 486         ca_dedicated,           // a dedicated server with no ability to start a client
 487         ca_disconnected,        // full screen console with no connection
 488         ca_connected            // valid netcon, talking to a server
 489 }
 490 cactive_t;
 491
 492 typedef enum qw_downloadtype_e
 493 {
 494         dl_none,
 495         dl_single,
 496         dl_skin,
 497         dl_model,
 498         dl_sound
 499 }
 500 qw_downloadtype_t;
 501
 502 typedef enum capturevideoformat_e
 503 {
 504         CAPTUREVIDEOFORMAT_AVI_I420,
 505         CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
 506 }
 507 capturevideoformat_t;
 508
 509 typedef struct capturevideostate_s
 510 {
 511         double startrealtime;
 512         double framerate;
 513         int framestep;
 514         int framestepframe;
 515         qboolean active;
 516         qboolean realtime;
 517         qboolean error;
 518         int soundrate;
 519         int soundchannels;
 520         int frame;
 521         double starttime;
 522         double lastfpstime;
 523         int lastfpsframe;
 524         int soundsampleframe;
 525         unsigned char *screenbuffer;
 526         unsigned char *outbuffer;
 527         char basename[MAX_QPATH];
 528         int width, height;
 529
 530         // precomputed RGB to YUV tables
 531         // converts the RGB values to YUV (see cap_avi.c for how to use them)
 532         short rgbtoyuvscaletable[3][3][256];
 533         unsigned char yuvnormalizetable[3][256];
 534
 535         // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
 536         // 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
 537         unsigned short vidramp[256 * 3];
 538
 539         // stuff to be filled in by the video format module
 540         capturevideoformat_t format;
 541         const char *formatextension;
 542         qfile_t *videofile;
 543                 // always use this:
 544                 //   cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
 545         void (*endvideo) (void);
 546         void (*videoframes) (int num);
 547         void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
 548
 549         // format specific data
 550         void *formatspecific;
 551 }
 552 capturevideostate_t;
 553
 554 #define CL_MAX_DOWNLOADACKS 4
 555
 556 typedef struct cl_downloadack_s
 557 {
 558         int start, size;
 559 }
 560 cl_downloadack_t;
 561
 562 typedef struct cl_soundstats_s
 563 {
 564         int mixedsounds;
 565         int totalsounds;
 566         int latency_milliseconds;
 567 }
 568 cl_soundstats_t;
 569
 570 //
 571 // the client_static_t structure is persistent through an arbitrary number
 572 // of server connections
 573 //
 574 typedef struct client_static_s
 575 {
 576         cactive_t state;
 577
 578         // all client memory allocations go in these pools
 579         mempool_t *levelmempool;
 580         mempool_t *permanentmempool;
 581
 582 // demo loop control
 583         // -1 = don't play demos
 584         int demonum;
 585         // list of demos in loop
 586         char demos[MAX_DEMOS][MAX_DEMONAME];
 587         // the actively playing demo (set by CL_PlayDemo_f)
 588         char demoname[MAX_QPATH];
 589
 590 // demo recording info must be here, because record is started before
 591 // entering a map (and clearing client_state_t)
 592         qboolean demorecording;
 593         fs_offset_t demo_lastcsprogssize;
 594         int demo_lastcsprogscrc;
 595         qboolean demoplayback;
 596         qboolean timedemo;
 597         // -1 = use normal cd track
 598         int forcetrack;
 599         qfile_t *demofile;
 600         // realtime at second frame of timedemo (LordHavoc: changed to double)
 601         double td_starttime;
 602         int td_frames; // total frames parsed
 603         double td_onesecondnexttime;
 604         double td_onesecondframes;
 605         double td_onesecondrealtime;
 606         double td_onesecondminfps;
 607         double td_onesecondmaxfps;
 608         double td_onesecondavgfps;
 609         int td_onesecondavgcount;
 610         // LordHavoc: pausedemo
 611         qboolean demopaused;
 612
 613         // sound mixer statistics for showsound display
 614         cl_soundstats_t soundstats;
 615
 616         qboolean connect_trying;
 617         int connect_remainingtries;
 618         double connect_nextsendtime;
 619         lhnetsocket_t *connect_mysocket;
 620         lhnetaddress_t connect_address;
 621         // protocol version of the server we're connected to
 622         // (kept outside client_state_t because it's used between levels)
 623         protocolversion_t protocol;
 624
 625 #define MAX_RCONS 16
 626         int rcon_trying;
 627         lhnetaddress_t rcon_addresses[MAX_RCONS];
 628         char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
 629         double rcon_timeout[MAX_RCONS];
 630         int rcon_ringpos;
 631
 632 // connection information
 633         // 0 to SIGNONS
 634         int signon;
 635         // network connection
 636         netconn_t *netcon;
 637
 638         // download information
 639         // (note: qw_download variables are also used)
 640         cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
 641
 642         // input sequence numbers are not reset on level change, only connect
 643         int movesequence;
 644         int servermovesequence;
 645
 646         // quakeworld stuff below
 647
 648         // value of "qport" cvar at time of connection
 649         int qw_qport;
 650         // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
 651         int qw_incoming_sequence;
 652         int qw_outgoing_sequence;
 653
 654         // current file download buffer (only saved when file is completed)
 655         char qw_downloadname[MAX_QPATH];
 656         unsigned char *qw_downloadmemory;
 657         int qw_downloadmemorycursize;
 658         int qw_downloadmemorymaxsize;
 659         int qw_downloadnumber;
 660         int qw_downloadpercent;
 661         qw_downloadtype_t qw_downloadtype;
 662         // transfer rate display
 663         double qw_downloadspeedtime;
 664         int qw_downloadspeedcount;
 665         int qw_downloadspeedrate;
 666         qboolean qw_download_deflate;
 667
 668         // current file upload buffer (for uploading screenshots to server)
 669         unsigned char *qw_uploaddata;
 670         int qw_uploadsize;
 671         int qw_uploadpos;
 672
 673         // user infostring
 674         // this normally contains the following keys in quakeworld:
 675         // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
 676         char userinfo[MAX_USERINFO_STRING];
 677
 678         // video capture stuff
 679         capturevideostate_t capturevideo;
 680 }
 681 client_static_t;
 682
 683 extern client_static_t  cls;
 684
 685 typedef struct client_movementqueue_s
 686 {
 687         double time;
 688         float frametime;
 689         int sequence;
 690         float viewangles[3];
 691         float move[3];
 692         qboolean jump;
 693         qboolean crouch;
 694         qboolean canjump;
 695 }
 696 client_movementqueue_t;
 697
 698 //[515]: csqc
 699 typedef struct
 700 {
 701         qboolean drawworld;
 702         qboolean drawenginesbar;
 703         qboolean drawcrosshair;
 704 }csqc_vidvars_t;
 705
 706 typedef enum
 707 {
 708         PARTICLE_BILLBOARD = 0,
 709         PARTICLE_SPARK = 1,
 710         PARTICLE_ORIENTED_DOUBLESIDED = 2,
 711         PARTICLE_VBEAM = 3,
 712         PARTICLE_HBEAM = 4,
 713         PARTICLE_INVALID = -1
 714 }
 715 porientation_t;
 716
 717 typedef enum
 718 {
 719         PBLEND_ALPHA = 0,
 720         PBLEND_ADD = 1,
 721         PBLEND_INVMOD = 2,
 722         PBLEND_INVALID = -1
 723 }
 724 pblend_t;
 725
 726 typedef struct particletype_s
 727 {
 728         pblend_t blendmode;
 729         porientation_t orientation;
 730         qboolean lighting;
 731 }
 732 particletype_t;
 733
 734 typedef enum
 735 {
 736         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
 737 }
 738 ptype_t;
 739
 740 typedef struct decal_s
 741 {
 742         // fields used by rendering:  (44 bytes)
 743         unsigned short  typeindex;
 744         unsigned short  texnum;
 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         int max_entities;
1035         int max_static_entities;
1036         int max_effects;
1037         int max_beams;
1038         int max_dlights;
1039         int max_lightstyle;
1040         int max_brushmodel_entities;
1041         int max_particles;
1042         int max_decals;
1043         int max_showlmps;
1044
1045         entity_t *entities;
1046         unsigned char *entities_active;
1047         entity_t *static_entities;
1048         cl_effect_t *effects;
1049         beam_t *beams;
1050         dlight_t *dlights;
1051         lightstyle_t *lightstyle;
1052         int *brushmodel_entities;
1053         particle_t *particles;
1054         decal_t *decals;
1055         showlmp_t *showlmps;
1056
1057         int num_entities;
1058         int num_static_entities;
1059         int num_brushmodel_entities;
1060         int num_effects;
1061         int num_beams;
1062         int num_dlights;
1063         int num_particles;
1064         int num_decals;
1065         int num_showlmps;
1066
1067         double particles_updatetime;
1068         double decals_updatetime;
1069         int free_particle;
1070         int free_decal;
1071
1072         // cl_serverextension_download feature
1073         int loadmodel_current;
1074         int downloadmodel_current;
1075         int loadmodel_total;
1076         int loadsound_current;
1077         int downloadsound_current;
1078         int loadsound_total;
1079         qboolean downloadcsqc;
1080         qboolean loadcsqc;
1081         qboolean loadbegun;
1082         qboolean loadfinished;
1083
1084         // quakeworld stuff
1085
1086         // local copy of the server infostring
1087         char qw_serverinfo[MAX_SERVERINFO_STRING];
1088
1089         // time of last qw "pings" command sent to server while showing scores
1090         double last_ping_request;
1091
1092         // used during connect
1093         int qw_servercount;
1094
1095         // updated from serverinfo
1096         int qw_teamplay;
1097
1098         // unused: indicates whether the player is spectating
1099         // use cl.scores[cl.playerentity-1].qw_spectator instead
1100         //qboolean qw_spectator;
1101
1102         // last time an input packet was sent
1103         double lastpackettime;
1104
1105         // movement parameters for client prediction
1106         unsigned int moveflags;
1107         float movevars_wallfriction;
1108         float movevars_waterfriction;
1109         float movevars_friction;
1110         float movevars_timescale;
1111         float movevars_gravity;
1112         float movevars_stopspeed;
1113         float movevars_maxspeed;
1114         float movevars_spectatormaxspeed;
1115         float movevars_accelerate;
1116         float movevars_airaccelerate;
1117         float movevars_wateraccelerate;
1118         float movevars_entgravity;
1119         float movevars_jumpvelocity;
1120         float movevars_edgefriction;
1121         float movevars_maxairspeed;
1122         float movevars_stepheight;
1123         float movevars_airaccel_qw;
1124         float movevars_airaccel_sideways_friction;
1125         float movevars_airstopaccelerate;
1126         float movevars_airstrafeaccelerate;
1127         float movevars_maxairstrafespeed;
1128         float movevars_aircontrol;
1129         float movevars_warsowbunny_airforwardaccel;
1130         float movevars_warsowbunny_accel;
1131         float movevars_warsowbunny_topspeed;
1132         float movevars_warsowbunny_turnaccel;
1133         float movevars_warsowbunny_backtosideratio;
1134         float movevars_ticrate;
1135
1136         // models used by qw protocol
1137         int qw_modelindex_spike;
1138         int qw_modelindex_player;
1139         int qw_modelindex_flag;
1140         int qw_modelindex_s_explod;
1141
1142         vec3_t qw_intermission_origin;
1143         vec3_t qw_intermission_angles;
1144
1145         // 255 is the most nails the QW protocol could send
1146         int qw_num_nails;
1147         vec_t qw_nails[255][6];
1148
1149         float qw_weaponkick;
1150
1151         int qw_validsequence;
1152
1153         int qw_deltasequence[QW_UPDATE_BACKUP];
1154
1155         // csqc stuff:
1156         // server entity number corresponding to a clientside entity
1157         unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1158         qboolean csqc_loaded;
1159         vec3_t csqc_origin;
1160         vec3_t csqc_angles;
1161         qboolean csqc_usecsqclistener;
1162         matrix4x4_t csqc_listenermatrix;
1163         char csqc_printtextbuf[MAX_INPUTLINE];
1164
1165         // collision culling data
1166         world_t world;
1167
1168         // loc file stuff (points and boxes describing locations in the level)
1169         cl_locnode_t *locnodes;
1170         // this is updated to cl.movement_origin whenever health is < 1
1171         // used by %d print in say/say_team messages if cl_locs_enable is on
1172         vec3_t lastdeathorigin;
1173
1174         // processing buffer used by R_BuildLightMap, reallocated as needed,
1175         // freed on each level change
1176         size_t buildlightmapmemorysize;
1177         unsigned char *buildlightmapmemory;
1178 }
1179 client_state_t;
1180
1181 //
1182 // cvars
1183 //
1184 extern cvar_t cl_name;
1185 extern cvar_t cl_color;
1186 extern cvar_t cl_rate;
1187 extern cvar_t cl_pmodel;
1188 extern cvar_t cl_playermodel;
1189 extern cvar_t cl_playerskin;
1190
1191 extern cvar_t rcon_password;
1192 extern cvar_t rcon_address;
1193
1194 extern cvar_t cl_upspeed;
1195 extern cvar_t cl_forwardspeed;
1196 extern cvar_t cl_backspeed;
1197 extern cvar_t cl_sidespeed;
1198
1199 extern cvar_t cl_movespeedkey;
1200
1201 extern cvar_t cl_yawspeed;
1202 extern cvar_t cl_pitchspeed;
1203
1204 extern cvar_t cl_anglespeedkey;
1205
1206 extern cvar_t cl_autofire;
1207
1208 extern cvar_t cl_shownet;
1209 extern cvar_t cl_nolerp;
1210 extern cvar_t cl_nettimesyncfactor;
1211 extern cvar_t cl_nettimesyncboundmode;
1212 extern cvar_t cl_nettimesyncboundtolerance;
1213
1214 extern cvar_t cl_pitchdriftspeed;
1215 extern cvar_t lookspring;
1216 extern cvar_t lookstrafe;
1217 extern cvar_t sensitivity;
1218
1219 extern cvar_t freelook;
1220
1221 extern cvar_t m_pitch;
1222 extern cvar_t m_yaw;
1223 extern cvar_t m_forward;
1224 extern cvar_t m_side;
1225
1226 extern cvar_t cl_autodemo;
1227 extern cvar_t cl_autodemo_nameformat;
1228
1229 extern cvar_t r_draweffects;
1230
1231 extern cvar_t cl_explosions_alpha_start;
1232 extern cvar_t cl_explosions_alpha_end;
1233 extern cvar_t cl_explosions_size_start;
1234 extern cvar_t cl_explosions_size_end;
1235 extern cvar_t cl_explosions_lifetime;
1236 extern cvar_t cl_stainmaps;
1237 extern cvar_t cl_stainmaps_clearonload;
1238
1239 extern cvar_t cl_prydoncursor;
1240
1241 extern cvar_t cl_locs_enable;
1242
1243 extern client_state_t cl;
1244
1245 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);
1246
1247 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1248 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1249
1250 //=============================================================================
1251
1252 //
1253 // cl_main
1254 //
1255
1256 void CL_Shutdown (void);
1257 void CL_Init (void);
1258
1259 void CL_EstablishConnection(const char *host);
1260
1261 void CL_Disconnect (void);
1262 void CL_Disconnect_f (void);
1263
1264 void CL_UpdateRenderEntity(entity_render_t *ent);
1265 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1266 void CL_UpdateViewEntities(void);
1267
1268 //
1269 // cl_input
1270 //
1271 typedef struct kbutton_s
1272 {
1273         int             down[2];                // key nums holding it down
1274         int             state;                  // low bit is down state
1275 }
1276 kbutton_t;
1277
1278 extern  kbutton_t       in_mlook, in_klook;
1279 extern  kbutton_t       in_strafe;
1280 extern  kbutton_t       in_speed;
1281
1282 void CL_InitInput (void);
1283 void CL_SendMove (void);
1284
1285 void CL_ValidateState(entity_state_t *s);
1286 void CL_MoveLerpEntityStates(entity_t *ent);
1287 void CL_LerpUpdate(entity_t *e);
1288 void CL_ParseTEnt (void);
1289 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1290 void CL_RelinkBeams (void);
1291 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1292 void CL_ClientMovement_Replay(void);
1293
1294 void CL_ClearTempEntities (void);
1295 entity_render_t *CL_NewTempEntity (double shadertime);
1296
1297 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1298
1299 void CL_ClearState (void);
1300 void CL_ExpandEntities(int num);
1301 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1302
1303
1304 void CL_UpdateWorld (void);
1305 void CL_WriteToServer (void);
1306 void CL_Input (void);
1307 extern int cl_ignoremousemoves;
1308
1309
1310 float CL_KeyState (kbutton_t *key);
1311 const char *Key_KeynumToString (int keynum);
1312 int Key_StringToKeynum (const char *str);
1313
1314 //
1315 // cl_demo.c
1316 //
1317 void CL_StopPlayback(void);
1318 void CL_ReadDemoMessage(void);
1319 void CL_WriteDemoMessage(sizebuf_t *mesage);
1320
1321 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1322 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1323
1324 void CL_NextDemo(void);
1325 void CL_Stop_f(void);
1326 void CL_Record_f(void);
1327 void CL_PlayDemo_f(void);
1328 void CL_TimeDemo_f(void);
1329
1330 //
1331 // cl_parse.c
1332 //
1333 void CL_Parse_Init(void);
1334 void CL_Parse_Shutdown(void);
1335 void CL_ParseServerMessage(void);
1336 void CL_Parse_DumpPacket(void);
1337 void CL_Parse_ErrorCleanUp(void);
1338 void QW_CL_StartUpload(unsigned char *data, int size);
1339 extern cvar_t qport;
1340 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1341
1342 //
1343 // view
1344 //
1345 void V_StartPitchDrift (void);
1346 void V_StopPitchDrift (void);
1347
1348 void V_Init (void);
1349 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1350 void V_UpdateBlends (void);
1351 void V_ParseDamage (void);
1352
1353 //
1354 // cl_part
1355 //
1356
1357 extern cvar_t cl_particles;
1358 extern cvar_t cl_particles_quality;
1359 extern cvar_t cl_particles_size;
1360 extern cvar_t cl_particles_quake;
1361 extern cvar_t cl_particles_blood;
1362 extern cvar_t cl_particles_blood_alpha;
1363 extern cvar_t cl_particles_blood_bloodhack;
1364 extern cvar_t cl_particles_bulletimpacts;
1365 extern cvar_t cl_particles_explosions_sparks;
1366 extern cvar_t cl_particles_explosions_shell;
1367 extern cvar_t cl_particles_rain;
1368 extern cvar_t cl_particles_snow;
1369 extern cvar_t cl_particles_smoke;
1370 extern cvar_t cl_particles_smoke_alpha;
1371 extern cvar_t cl_particles_smoke_alphafade;
1372 extern cvar_t cl_particles_sparks;
1373 extern cvar_t cl_particles_bubbles;
1374 extern cvar_t cl_decals;
1375 extern cvar_t cl_decals_time;
1376 extern cvar_t cl_decals_fadetime;
1377
1378 void CL_Particles_Clear(void);
1379 void CL_Particles_Init(void);
1380 void CL_Particles_Shutdown(void);
1381 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);
1382
1383 typedef enum effectnameindex_s
1384 {
1385         EFFECT_NONE,
1386         EFFECT_TE_GUNSHOT,
1387         EFFECT_TE_GUNSHOTQUAD,
1388         EFFECT_TE_SPIKE,
1389         EFFECT_TE_SPIKEQUAD,
1390         EFFECT_TE_SUPERSPIKE,
1391         EFFECT_TE_SUPERSPIKEQUAD,
1392         EFFECT_TE_WIZSPIKE,
1393         EFFECT_TE_KNIGHTSPIKE,
1394         EFFECT_TE_EXPLOSION,
1395         EFFECT_TE_EXPLOSIONQUAD,
1396         EFFECT_TE_TAREXPLOSION,
1397         EFFECT_TE_TELEPORT,
1398         EFFECT_TE_LAVASPLASH,
1399         EFFECT_TE_SMALLFLASH,
1400         EFFECT_TE_FLAMEJET,
1401         EFFECT_EF_FLAME,
1402         EFFECT_TE_BLOOD,
1403         EFFECT_TE_SPARK,
1404         EFFECT_TE_PLASMABURN,
1405         EFFECT_TE_TEI_G3,
1406         EFFECT_TE_TEI_SMOKE,
1407         EFFECT_TE_TEI_BIGEXPLOSION,
1408         EFFECT_TE_TEI_PLASMAHIT,
1409         EFFECT_EF_STARDUST,
1410         EFFECT_TR_ROCKET,
1411         EFFECT_TR_GRENADE,
1412         EFFECT_TR_BLOOD,
1413         EFFECT_TR_WIZSPIKE,
1414         EFFECT_TR_SLIGHTBLOOD,
1415         EFFECT_TR_KNIGHTSPIKE,
1416         EFFECT_TR_VORESPIKE,
1417         EFFECT_TR_NEHAHRASMOKE,
1418         EFFECT_TR_NEXUIZPLASMA,
1419         EFFECT_TR_GLOWTRAIL,
1420         EFFECT_SVC_PARTICLE,
1421         EFFECT_TOTAL
1422 }
1423 effectnameindex_t;
1424
1425 int CL_ParticleEffectIndexForName(const char *name);
1426 const char *CL_ParticleEffectNameForIndex(int i);
1427 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);
1428 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);
1429 void CL_ParseParticleEffect (void);
1430 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);
1431 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1432 void CL_EntityParticles (const entity_t *ent);
1433 void CL_ParticleExplosion (const vec3_t org);
1434 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1435 void R_NewExplosion(const vec3_t org);
1436
1437 void Debug_PolygonBegin(const char *picname, int flags);
1438 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1439 void Debug_PolygonEnd(void);
1440
1441 #include "cl_screen.h"
1442
1443 extern qboolean sb_showscores;
1444
1445 float RSurf_FogVertex(const vec3_t p);
1446 float RSurf_FogPoint(const vec3_t p);
1447
1448 typedef struct r_refdef_stats_s
1449 {
1450         int renders;
1451         int entities;
1452         int entities_surfaces;
1453         int entities_triangles;
1454         int world_leafs;
1455         int world_portals;
1456         int world_surfaces;
1457         int world_triangles;
1458         int lightmapupdates;
1459         int lightmapupdatepixels;
1460         int particles;
1461         int decals;
1462         int meshes;
1463         int meshes_elements;
1464         int lights;
1465         int lights_clears;
1466         int lights_scissored;
1467         int lights_lighttriangles;
1468         int lights_shadowtriangles;
1469         int lights_dynamicshadowtriangles;
1470         int bloom;
1471         int bloom_copypixels;
1472         int bloom_drawpixels;
1473 }
1474 r_refdef_stats_t;
1475
1476 typedef enum r_viewport_type_e
1477 {
1478         R_VIEWPORTTYPE_ORTHO,
1479         R_VIEWPORTTYPE_PERSPECTIVE,
1480         R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1481         R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1482         R_VIEWPORTTYPE_TOTAL
1483 }
1484 r_viewport_type_t;
1485
1486 typedef struct r_viewport_s
1487 {
1488         double m[16];
1489         matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1490         matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1491         matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1492         int x;
1493         int y;
1494         int z;
1495         int width;
1496         int height;
1497         int depth;
1498         r_viewport_type_t type;
1499 }
1500 r_viewport_t;
1501
1502 typedef struct r_refdef_view_s
1503 {
1504         // view information (changes multiple times per frame)
1505         // if any of these variables change then r_refdef.viewcache must be regenerated
1506         // by calling R_View_Update
1507         // (which also updates viewport, scissor, colormask)
1508
1509         // it is safe and expected to copy this into a structure on the stack and
1510         // call the renderer recursively, then restore from the stack afterward
1511         // (as long as R_View_Update is called)
1512
1513         // eye position information
1514         matrix4x4_t matrix, inverse_matrix;
1515         vec3_t origin;
1516         vec3_t forward;
1517         vec3_t left;
1518         vec3_t right;
1519         vec3_t up;
1520         int numfrustumplanes;
1521         mplane_t frustum[6];
1522         qboolean useclipplane;
1523         qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1524         mplane_t clipplane;
1525         float frustum_x, frustum_y;
1526         vec3_t frustumcorner[4];
1527         // if turned off it renders an ortho view
1528         int useperspective;
1529         float ortho_x, ortho_y;
1530
1531         // screen area to render in
1532         int x;
1533         int y;
1534         int z;
1535         int width;
1536         int height;
1537         int depth;
1538         r_viewport_t viewport;
1539
1540         // which color components to allow (for anaglyph glasses)
1541         int colormask[4];
1542
1543         // global RGB color multiplier for rendering, this is required by HDR
1544         float colorscale;
1545
1546         // whether to call R_ClearScreen before rendering stuff
1547         qboolean clear;
1548         // if true, don't clear or do any post process effects (bloom, etc)
1549         qboolean isoverlay;
1550
1551         // whether to draw r_showtris and such, this is only true for the main
1552         // view render, all secondary renders (HDR, mirrors, portals, cameras,
1553         // distortion effects, etc) omit such debugging information
1554         qboolean showdebug;
1555
1556         // these define which values to use in GL_CullFace calls to request frontface or backface culling
1557         int cullface_front;
1558         int cullface_back;
1559
1560         // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1561         float quality;
1562 }
1563 r_refdef_view_t;
1564
1565 typedef struct r_refdef_viewcache_s
1566 {
1567         // these properties are generated by R_View_Update()
1568
1569         // which entities are currently visible for this viewpoint
1570         // (the used range is 0...r_refdef.scene.numentities)
1571         unsigned char entityvisible[MAX_EDICTS];
1572         // flag arrays used for visibility checking on world model
1573         // (all other entities have no per-surface/per-leaf visibility checks)
1574         // TODO: dynamic resize according to r_refdef.scene.worldmodel->brush.num_clusters
1575         unsigned char world_pvsbits[(32768+7)>>3]; // FIXME: buffer overflow on huge maps
1576         // TODO: dynamic resize according to r_refdef.scene.worldmodel->brush.num_leafs
1577         unsigned char world_leafvisible[32768]; // FIXME: buffer overflow on huge maps
1578         // TODO: dynamic resize according to r_refdef.scene.worldmodel->num_surfaces
1579         unsigned char world_surfacevisible[262144]; // FIXME: buffer overflow on huge maps
1580         // if true, the view is currently in a leaf without pvs data
1581         qboolean world_novis;
1582 }
1583 r_refdef_viewcache_t;
1584
1585 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1586 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1587 typedef struct r_refdef_scene_s {
1588         // whether to call S_ExtraUpdate during render to reduce sound chop
1589         qboolean extraupdate;
1590
1591         // (client gameworld) time for rendering time based effects
1592         double time;
1593
1594         // the world
1595         entity_render_t *worldentity;
1596
1597         // same as worldentity->model
1598         dp_model_t *worldmodel;
1599
1600         // renderable entities (excluding world)
1601         entity_render_t **entities;
1602         int numentities;
1603         int maxentities;
1604
1605         // field of temporary entities that is reset each (client) frame
1606         entity_render_t *tempentities;
1607         int numtempentities;
1608         int maxtempentities;
1609
1610         // renderable dynamic lights
1611         rtlight_t *lights[MAX_DLIGHTS];
1612         rtlight_t templights[MAX_DLIGHTS];
1613         int numlights;
1614
1615         // intensities for light styles right now, controls rtlights
1616         float rtlightstylevalue[256];   // float fraction of base light value
1617         // 8.8bit fixed point intensities for light styles
1618         // controls intensity lightmap layers
1619         unsigned short lightstylevalue[256];    // 8.8 fraction of base light value
1620
1621         float ambient;
1622
1623         qboolean rtworld;
1624         qboolean rtworldshadows;
1625         qboolean rtdlight;
1626         qboolean rtdlightshadows;
1627 } r_refdef_scene_t;
1628
1629 typedef struct r_refdef_s
1630 {
1631         // these fields define the basic rendering information for the world
1632         // but not the view, which could change multiple times in one rendered
1633         // frame (for example when rendering textures for certain effects)
1634
1635         // these are set for water warping before
1636         // frustum_x/frustum_y are calculated
1637         float frustumscale_x, frustumscale_y;
1638
1639         // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1640         r_refdef_view_t view;
1641         r_refdef_viewcache_t viewcache;
1642
1643         // minimum visible distance (pixels closer than this disappear)
1644         double nearclip;
1645         // maximum visible distance (pixels further than this disappear in 16bpp modes,
1646         // in 32bpp an infinite-farclip matrix is used instead)
1647         double farclip;
1648
1649         // fullscreen color blend
1650         float viewblend[4];
1651
1652         r_refdef_scene_t scene;
1653
1654         float fogplane[4];
1655         float fogplaneviewdist;
1656         qboolean fogplaneviewabove;
1657         float fogheightfade;
1658         float fogcolor[3];
1659         float fogrange;
1660         float fograngerecip;
1661         float fogmasktabledistmultiplier;
1662 #define FOGMASKTABLEWIDTH 1024
1663         float fogmasktable[FOGMASKTABLEWIDTH];
1664         float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1665         float fog_density;
1666         float fog_red;
1667         float fog_green;
1668         float fog_blue;
1669         float fog_alpha;
1670         float fog_start;
1671         float fog_end;
1672         float fog_height;
1673         float fog_fadedepth;
1674         qboolean fogenabled;
1675         qboolean oldgl_fogenable;
1676
1677         qboolean draw2dstage;
1678
1679         // true during envmap command capture
1680         qboolean envmap;
1681
1682         // brightness of world lightmaps and related lighting
1683         // (often reduced when world rtlights are enabled)
1684         float lightmapintensity;
1685         // whether to draw world lights realtime, dlights realtime, and their shadows
1686         float polygonfactor;
1687         float polygonoffset;
1688         float shadowpolygonfactor;
1689         float shadowpolygonoffset;
1690
1691         // rendering stats for r_speeds display
1692         // (these are incremented in many places)
1693         r_refdef_stats_t stats;
1694 }
1695 r_refdef_t;
1696
1697 extern r_refdef_t r_refdef;
1698
1699 #endif
1700