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