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