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