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