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