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