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