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