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