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