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