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