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