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