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