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