2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
25 #include "matrixlib.h"
28 // flags for rtlight rendering
29 #define LIGHTFLAG_NORMALMODE 1
30 #define LIGHTFLAG_REALTIMEMODE 2
32 typedef struct tridecal_s
34 // color and initial alpha value
35 float texcoord2f[3][2];
37 unsigned char color4ub[3][4];
38 // how long this decal has lived so far (the actual fade begins at cl_decals_time)
40 // if >= 0 this indicates the decal should follow an animated triangle
42 // for visibility culling
44 // old decals are killed to obey cl_decals_max
49 typedef struct decalsystem_s
52 double lastupdatetime;
61 unsigned short *element3s;
65 typedef struct effect_s
74 // these are for interpolation
84 // draw this as lightning polygons, or a model?
86 struct model_s *model;
92 typedef struct rtlight_s
94 // shadow volumes are done entirely in model space, so there are no matrices for dealing with them... they just use the origin
96 // note that the world to light matrices are inversely scaled (divided) by lightradius
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)
105 /// size of the light (remove?)
108 char cubemapname[64];
109 /// light style to monitor for brightness
111 /// whether light should render shadows
113 /// intensity of corona to render
115 /// radius scale of corona to render (1.0 means same as light radius)
116 vec_t coronasizescale;
117 /// ambient intensity to render
119 /// diffuse intensity to render
121 /// specular intensity to render
123 /// LIGHTFLAG_* flags
126 // generated properties
127 /// used only for shadow volumes
134 // squared cullradius
137 // rendering properties, updated each time a light is rendered
138 // this is rtlight->color * d_lightstylevalue
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
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
170 /// static light info
171 /// true if this light should be compiled as a static light
173 /// true if this is a compiled world light, cleared if the light changes
175 /// the shadowing mode used to compile this light
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)
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
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;
208 typedef struct dlight_s
210 // destroy light after this time
213 // the entity that owns this light (can be NULL)
215 struct entity_render_s *ent;
217 // (worldlight: saved to .rtlights file)
219 // worldlight orientation
221 // (worldlight: saved to .rtlights file)
223 // dlight orientation/scaling/location
227 // (worldlight: saved to .rtlights file)
229 // cubemap name to use on this light
230 // (worldlight: saved to .rtlights file)
231 char cubemapname[64];
232 // make light flash while selected
235 // brightness (not really radius anymore)
236 // (worldlight: saved to .rtlights file)
238 // drop intensity this much each second
241 // intensity value which is dropped over time
244 // initial values for intensity to modify
248 // light style which controls intensity of this light
249 // (worldlight: saved to .rtlights file)
252 // (worldlight: saved to .rtlights file)
255 // (worldlight: saved to .rtlights file)
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)
263 // diffuse intensity to render
264 // (worldlight: saved to .rtlights file)
266 // specular intensity to render
267 // (worldlight: saved to .rtlights file)
270 // (worldlight: saved to .rtlights file)
272 // linked list of world lights
274 struct dlight_s *next;
275 // embedded rtlight struct for renderer
281 #define MAX_FRAMEGROUPBLENDS 4
282 typedef struct framegroupblend_s
284 // animation number and blend factor
285 // (for most models this is the frame number)
288 // time frame began playing (for framegroup animations)
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
305 // LordHavoc: this struct is intended for the renderer but some fields are
306 // used by the client.
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.
312 // For example the r_cullentities_trace code does such caching.
313 typedef struct entity_render_s
319 // transform matrix for model to world
321 // transform matrix for world to model
322 matrix4x4_t inversematrix;
323 // opacity (alpha) of the model
325 // size the model is shown
327 // transparent sorting offset
328 float transparent_offset;
332 // number of the entity represents, or 0 for non-network entities
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
339 // qw CTF flags and other internal-use-only effect bits
346 // colormod tinting of models
350 // interpolated animation - active framegroups and blend factors
351 framegroupblend_t framegroupblend[MAX_FRAMEGROUPBLENDS];
353 // time of last model change (for shader animations)
356 // calculated by the renderer (but not persistent)
358 // calculated during R_AddModelEntities
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;
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;
372 // current lighting from map (updated ONLY by client code, not renderer)
373 vec3_t modellight_ambient;
374 vec3_t modellight_diffuse; // q3bsp
375 vec3_t modellight_lightdir; // q3bsp
377 // storage of decals on this entity
378 // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
380 decalsystem_t decalsystem;
382 // FIELDS UPDATED BY RENDERER:
383 // last time visible during trace culling
384 double last_trace_visibility;
388 typedef struct entity_persistent_s
394 qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
396 // muzzleflash fading
399 // interpolated movement
401 // start time of move
403 // time difference from start to end of move
405 // the move itself, start and end
413 typedef struct entity_s
415 // baseline state (default values)
416 entity_state_t state_baseline;
417 // previous state (interpolating from this)
418 entity_state_t state_previous;
419 // current state (interpolating to this)
420 entity_state_t state_current;
422 // used for regenerating parts of render
423 entity_persistent_t persistent;
425 // the only data the renderer should know about
426 entity_render_t render;
430 typedef struct usercmd_s
434 // intended velocities
439 vec3_t cursor_screen;
442 vec3_t cursor_impact;
443 vec3_t cursor_normal;
444 vec_t cursor_fraction;
445 int cursor_entitynumber;
447 double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
448 double receivetime; // time the move was received at
449 double clienttime; // time to which server state the move corresponds to
450 int msec; // for predicted moves
454 qboolean applied; // if false we're still accumulating a move
455 qboolean predicted; // if true the sequence should be sent as 0
457 // derived properties
464 typedef struct lightstyle_s
467 char map[MAX_STYLESTRING];
470 typedef struct scoreboard_s
472 char name[MAX_SCOREBOARDNAME];
474 int colors; // two 4 bit fields
477 char qw_userinfo[MAX_USERINFO_STRING];
484 char qw_skin[MAX_QPATH];
487 typedef struct cshift_s
490 float percent; // 0-255
491 float alphafade; // (any speed)
494 #define CSHIFT_CONTENTS 0
495 #define CSHIFT_DAMAGE 1
496 #define CSHIFT_BONUS 2
497 #define CSHIFT_POWERUP 3
498 #define CSHIFT_VCSHIFT 4
499 #define NUM_CSHIFTS 5
501 #define NAME_LENGTH 64
505 // client_state_t should hold all pieces of the client state
508 #define SIGNONS 4 // signon messages to receive before connected
510 typedef enum cactive_e
512 ca_uninitialized, // during early startup
513 ca_dedicated, // a dedicated server with no ability to start a client
514 ca_disconnected, // full screen console with no connection
515 ca_connected // valid netcon, talking to a server
519 typedef enum qw_downloadtype_e
529 typedef enum capturevideoformat_e
531 CAPTUREVIDEOFORMAT_AVI_I420,
532 CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
534 capturevideoformat_t;
536 typedef struct capturevideostate_s
538 double startrealtime;
551 int soundsampleframe;
552 unsigned char *screenbuffer;
553 unsigned char *outbuffer;
554 char basename[MAX_QPATH];
557 // precomputed RGB to YUV tables
558 // converts the RGB values to YUV (see cap_avi.c for how to use them)
559 short rgbtoyuvscaletable[3][3][256];
560 unsigned char yuvnormalizetable[3][256];
562 // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
563 // 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
564 unsigned short vidramp[256 * 3];
566 // stuff to be filled in by the video format module
567 capturevideoformat_t format;
568 const char *formatextension;
571 // cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
572 void (*endvideo) (void);
573 void (*videoframes) (int num);
574 void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
576 // format specific data
577 void *formatspecific;
581 #define CL_MAX_DOWNLOADACKS 4
583 typedef struct cl_downloadack_s
589 typedef struct cl_soundstats_s
593 int latency_milliseconds;
598 // the client_static_t structure is persistent through an arbitrary number
599 // of server connections
601 typedef struct client_static_s
605 // all client memory allocations go in these pools
606 mempool_t *levelmempool;
607 mempool_t *permanentmempool;
610 // -1 = don't play demos
612 // list of demos in loop
613 char demos[MAX_DEMOS][MAX_DEMONAME];
614 // the actively playing demo (set by CL_PlayDemo_f)
615 char demoname[MAX_QPATH];
617 // demo recording info must be here, because record is started before
618 // entering a map (and clearing client_state_t)
619 qboolean demorecording;
620 fs_offset_t demo_lastcsprogssize;
621 int demo_lastcsprogscrc;
622 qboolean demoplayback;
624 // -1 = use normal cd track
627 // realtime at second frame of timedemo (LordHavoc: changed to double)
629 int td_frames; // total frames parsed
630 double td_onesecondnexttime;
631 double td_onesecondframes;
632 double td_onesecondrealtime;
633 double td_onesecondminfps;
634 double td_onesecondmaxfps;
635 double td_onesecondavgfps;
636 int td_onesecondavgcount;
637 // LordHavoc: pausedemo
640 // sound mixer statistics for showsound display
641 cl_soundstats_t soundstats;
643 qboolean connect_trying;
644 int connect_remainingtries;
645 double connect_nextsendtime;
646 lhnetsocket_t *connect_mysocket;
647 lhnetaddress_t connect_address;
648 // protocol version of the server we're connected to
649 // (kept outside client_state_t because it's used between levels)
650 protocolversion_t protocol;
654 lhnetaddress_t rcon_addresses[MAX_RCONS];
655 char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
656 double rcon_timeout[MAX_RCONS];
659 // connection information
662 // network connection
665 // download information
666 // (note: qw_download variables are also used)
667 cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
669 // input sequence numbers are not reset on level change, only connect
671 int servermovesequence;
673 // quakeworld stuff below
675 // value of "qport" cvar at time of connection
677 // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
678 int qw_incoming_sequence;
679 int qw_outgoing_sequence;
681 // current file download buffer (only saved when file is completed)
682 char qw_downloadname[MAX_QPATH];
683 unsigned char *qw_downloadmemory;
684 int qw_downloadmemorycursize;
685 int qw_downloadmemorymaxsize;
686 int qw_downloadnumber;
687 int qw_downloadpercent;
688 qw_downloadtype_t qw_downloadtype;
689 // transfer rate display
690 double qw_downloadspeedtime;
691 int qw_downloadspeedcount;
692 int qw_downloadspeedrate;
693 qboolean qw_download_deflate;
695 // current file upload buffer (for uploading screenshots to server)
696 unsigned char *qw_uploaddata;
701 // this normally contains the following keys in quakeworld:
702 // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
703 char userinfo[MAX_USERINFO_STRING];
705 // video capture stuff
706 capturevideostate_t capturevideo;
710 extern client_static_t cls;
712 typedef struct client_movementqueue_s
723 client_movementqueue_t;
729 qboolean drawenginesbar;
730 qboolean drawcrosshair;
735 PARTICLE_BILLBOARD = 0,
737 PARTICLE_ORIENTED_DOUBLESIDED = 2,
740 PARTICLE_INVALID = -1
753 typedef struct particletype_s
756 porientation_t orientation;
763 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
767 typedef struct decal_s
769 // fields used by rendering: (44 bytes)
770 unsigned short typeindex;
771 unsigned short texnum;
776 float alpha; // 0-255
777 unsigned char color[3];
778 unsigned char unused1;
779 int clusterindex; // cheap culling by pvs
781 // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
782 float time2; // used for decal fade
783 unsigned int owner; // decal stuck to this entity
784 dp_model_t *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
785 vec3_t relativeorigin; // decal at this location in entity's coordinate space
786 vec3_t relativenormal; // decal oriented this way relative to entity's coordinate space
790 typedef struct particle_s
792 // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
794 // fields used by rendering: (48 bytes)
795 vec3_t sortorigin; // sort by this group origin, not particle org
797 vec3_t vel; // velocity of particle, or orientation of decal, or end point of beam
799 float alpha; // 0-255
800 float stretch; // only for sparks
802 // fields not used by rendering: (44 bytes)
805 float sizeincrease; // rate of size change per second
806 float alphafade; // how much alpha reduces per second
807 float time2; // used for snow fluttering and decal fade
808 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)
809 float gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
810 float airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
811 float liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
812 // float delayedcollisions; // time that p->bounce becomes active
813 float delayedspawn; // time that particle appears and begins moving
814 float die; // time when this particle should be removed, regardless of alpha
816 // short variables grouped to save memory (4 bytes)
817 short angle; // base rotation of particle
818 short spin; // geometry rotation speed around the particle center normal
820 // byte variables grouped to save memory (12 bytes)
821 unsigned char color[3];
822 unsigned char qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
823 unsigned char typeindex;
824 unsigned char blendmode;
825 unsigned char orientation;
826 unsigned char texnum;
827 unsigned char staincolor[3];
828 signed char staintexnum;
832 typedef enum cl_parsingtextmode_e
834 CL_PARSETEXTMODE_NONE,
835 CL_PARSETEXTMODE_PING,
836 CL_PARSETEXTMODE_STATUS,
837 CL_PARSETEXTMODE_STATUS_PLAYERID,
838 CL_PARSETEXTMODE_STATUS_PLAYERIP
840 cl_parsingtextmode_t;
842 typedef struct cl_locnode_s
844 struct cl_locnode_s *next;
850 typedef struct showlmp_s
861 // the client_state_t structure is wiped completely at every
864 typedef struct client_state_s
866 // true if playing in a local game and no one else is connected
869 // send a clc_nop periodically until connected
872 // current input being accumulated by mouse/joystick/etc input
874 // latest moves sent to the server that have not been confirmed yet
875 usercmd_t movecmd[CL_MAX_USERCMDS];
877 // information for local display
879 int stats[MAX_CL_STATS];
880 float *statsf; // points to stats[] array
881 // last known inventory bit flags, for blinking
883 // cl.time of acquiring item, for blinking
884 float item_gettime[32];
885 // last known STAT_ACTIVEWEAPON
887 // cl.time of changing STAT_ACTIVEWEAPON
889 // use pain anim frame if cl.time < this
891 // for stair smoothing
893 double stairsmoothtime;
895 // color shifts for damage, powerups
896 cshift_t cshifts[NUM_CSHIFTS];
898 cshift_t prev_cshifts[NUM_CSHIFTS];
900 // the client maintains its own idea of view angles, which are
901 // sent to the server each frame. The server sets punchangle when
902 // the view is temporarily offset, and an angle reset commands at the start
903 // of each level and after teleporting.
905 // mviewangles is read from demo
906 // viewangles is either client controlled or lerped from mviewangles
907 vec3_t mviewangles[2], viewangles;
908 // update by server, used by qc to do weapon recoil
909 vec3_t mpunchangle[2], punchangle;
910 // update by server, can be used by mods to kick view around
911 vec3_t mpunchvector[2], punchvector;
912 // update by server, used for lean+bob (0 is newest)
913 vec3_t mvelocity[2], velocity;
914 // update by server, can be used by mods for zooming
915 vec_t mviewzoom[2], viewzoom;
916 // if true interpolation the mviewangles and other interpolation of the
917 // player is disabled until the next network packet
918 // this is used primarily by teleporters, and when spectating players
919 // special checking of the old fixangle[1] is used to differentiate
920 // between teleporting and spectating
921 qboolean fixangle[2];
923 // client movement simulation
924 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
925 // set by CL_ClientMovement_Replay functions
926 qboolean movement_predicted;
927 // if true the CL_ClientMovement_Replay function will update origin, etc
928 qboolean movement_replay;
929 // simulated data (this is valid even if cl.movement is false)
930 vec3_t movement_origin;
931 vec3_t movement_velocity;
932 // whether the replay should allow a jump at the first sequence
933 qboolean movement_replay_canjump;
935 // previous gun angles (for leaning effects)
936 vec3_t gunangles_prev;
937 vec3_t gunangles_highpass;
938 vec3_t gunangles_adjustment_lowpass;
939 vec3_t gunangles_adjustment_highpass;
940 // previous gun angles (for leaning effects)
942 vec3_t gunorg_highpass;
943 vec3_t gunorg_adjustment_lowpass;
944 vec3_t gunorg_adjustment_highpass;
946 // pitch drifting vars
953 //[515]: added for csqc purposes
954 float sensitivityscale;
955 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
956 qboolean csqc_wantsmousemove;
957 qboolean csqc_paused; // vortex: int because could be flags
958 struct model_s *csqc_model_precache[MAX_MODELS];
960 // local amount for smoothing stepups
969 qboolean oldonground;
970 double lastongroundtime;
971 double hitgroundtime;
973 // don't change view angle, full screen, etc
975 // latched at intermission start
976 double completed_time;
978 // the timestamp of the last two messages
981 // clients view of time, time should be between mtime[0] and mtime[1] to
982 // generate a lerp point for other data, oldtime is the previous frame's
983 // value of time, frametime is the difference between time and oldtime
984 // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
985 // is only forcefully limited when a packet is received
986 double time, oldtime;
987 // how long it has been since the previous client frame in real time
988 // (not game time, for that use cl.time - cl.oldtime)
989 double realframetime;
991 // fade var for fading while dead
994 // motionblur alpha level variable
995 float motionbluralpha;
997 // copy of realtime from last recieved message, for net trouble icon
998 float last_received_message;
1000 // information that is static for the entire time connected to a server
1001 struct model_s *model_precache[MAX_MODELS];
1002 struct sfx_s *sound_precache[MAX_SOUNDS];
1004 // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1005 char model_name[MAX_MODELS][MAX_QPATH];
1006 char sound_name[MAX_SOUNDS][MAX_QPATH];
1008 // for display on solo scoreboard
1010 // cl_entitites[cl.viewentity] = player
1012 // the real player entity (normally same as viewentity,
1013 // different than viewentity if mod uses chasecam or other tricks)
1014 int realplayerentity;
1015 // this is updated to match cl.viewentity whenever it is in the clients
1016 // range, basically this is used in preference to cl.realplayerentity for
1017 // most purposes because when spectating another player it should show
1018 // their information rather than yours
1020 // max players that can be in this game
1022 // type of game (deathmatch, coop, singleplayer)
1025 // models and sounds used by engine code (particularly cl_parse.c)
1026 dp_model_t *model_bolt;
1027 dp_model_t *model_bolt2;
1028 dp_model_t *model_bolt3;
1029 dp_model_t *model_beam;
1031 sfx_t *sfx_knighthit;
1037 // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1038 qboolean foundtalk2wav;
1040 // refresh related state
1042 // cl_entitites[0].model
1043 struct model_s *worldmodel;
1049 int cdtrack, looptrack;
1054 scoreboard_t *scores;
1056 // keep track of svc_print parsing state (analyzes ping reports and status reports)
1057 cl_parsingtextmode_t parsingtextmode;
1058 int parsingtextplayerindex;
1059 // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1060 // (which could eat the wrong ping report if the player issues one
1061 // manually, but they would still see a ping report, just a later one
1062 // caused by the scoreboard code rather than the one they intentionally
1064 int parsingtextexpectingpingforscores;
1066 // entity database stuff
1067 // latest received entity frame numbers
1068 #define LATESTFRAMENUMS 32
1069 int latestframenumsposition;
1070 int latestframenums[LATESTFRAMENUMS];
1071 int latestsendnums[LATESTFRAMENUMS];
1072 entityframe_database_t *entitydatabase;
1073 entityframe4_database_t *entitydatabase4;
1074 entityframeqw_database_t *entitydatabaseqw;
1076 // keep track of quake entities because they need to be killed if they get stale
1077 int lastquakeentity;
1078 unsigned char isquakeentity[MAX_EDICTS];
1080 // bounding boxes for clientside movement
1081 vec3_t playerstandmins;
1082 vec3_t playerstandmaxs;
1083 vec3_t playercrouchmins;
1084 vec3_t playercrouchmaxs;
1086 // old decals are killed based on this
1090 int max_csqcrenderentities;
1091 int max_static_entities;
1096 int max_brushmodel_entities;
1102 entity_render_t *csqcrenderentities;
1103 unsigned char *entities_active;
1104 entity_t *static_entities;
1105 cl_effect_t *effects;
1108 lightstyle_t *lightstyle;
1109 int *brushmodel_entities;
1110 particle_t *particles;
1112 showlmp_t *showlmps;
1115 int num_static_entities;
1116 int num_brushmodel_entities;
1124 double particles_updatetime;
1125 double decals_updatetime;
1129 // cl_serverextension_download feature
1130 int loadmodel_current;
1131 int downloadmodel_current;
1132 int loadmodel_total;
1133 int loadsound_current;
1134 int downloadsound_current;
1135 int loadsound_total;
1136 qboolean downloadcsqc;
1139 qboolean loadfinished;
1143 // local copy of the server infostring
1144 char qw_serverinfo[MAX_SERVERINFO_STRING];
1146 // time of last qw "pings" command sent to server while showing scores
1147 double last_ping_request;
1149 // used during connect
1152 // updated from serverinfo
1155 // unused: indicates whether the player is spectating
1156 // use cl.scores[cl.playerentity-1].qw_spectator instead
1157 //qboolean qw_spectator;
1159 // last time an input packet was sent
1160 double lastpackettime;
1162 // movement parameters for client prediction
1163 unsigned int moveflags;
1164 float movevars_wallfriction;
1165 float movevars_waterfriction;
1166 float movevars_friction;
1167 float movevars_timescale;
1168 float movevars_gravity;
1169 float movevars_stopspeed;
1170 float movevars_maxspeed;
1171 float movevars_spectatormaxspeed;
1172 float movevars_accelerate;
1173 float movevars_airaccelerate;
1174 float movevars_wateraccelerate;
1175 float movevars_entgravity;
1176 float movevars_jumpvelocity;
1177 float movevars_edgefriction;
1178 float movevars_maxairspeed;
1179 float movevars_stepheight;
1180 float movevars_airaccel_qw;
1181 float movevars_airaccel_sideways_friction;
1182 float movevars_airstopaccelerate;
1183 float movevars_airstrafeaccelerate;
1184 float movevars_maxairstrafespeed;
1185 float movevars_aircontrol;
1186 float movevars_aircontrol_power;
1187 float movevars_warsowbunny_airforwardaccel;
1188 float movevars_warsowbunny_accel;
1189 float movevars_warsowbunny_topspeed;
1190 float movevars_warsowbunny_turnaccel;
1191 float movevars_warsowbunny_backtosideratio;
1192 float movevars_ticrate;
1194 // models used by qw protocol
1195 int qw_modelindex_spike;
1196 int qw_modelindex_player;
1197 int qw_modelindex_flag;
1198 int qw_modelindex_s_explod;
1200 vec3_t qw_intermission_origin;
1201 vec3_t qw_intermission_angles;
1203 // 255 is the most nails the QW protocol could send
1205 vec_t qw_nails[255][6];
1207 float qw_weaponkick;
1209 int qw_validsequence;
1211 int qw_deltasequence[QW_UPDATE_BACKUP];
1214 // server entity number corresponding to a clientside entity
1215 unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1216 qboolean csqc_loaded;
1219 qboolean csqc_usecsqclistener;
1220 matrix4x4_t csqc_listenermatrix;
1221 char csqc_printtextbuf[MAX_INPUTLINE];
1223 // collision culling data
1226 // loc file stuff (points and boxes describing locations in the level)
1227 cl_locnode_t *locnodes;
1228 // this is updated to cl.movement_origin whenever health is < 1
1229 // used by %d print in say/say_team messages if cl_locs_enable is on
1230 vec3_t lastdeathorigin;
1232 // processing buffer used by R_BuildLightMap, reallocated as needed,
1233 // freed on each level change
1234 size_t buildlightmapmemorysize;
1235 unsigned char *buildlightmapmemory;
1242 extern cvar_t cl_name;
1243 extern cvar_t cl_color;
1244 extern cvar_t cl_rate;
1245 extern cvar_t cl_pmodel;
1246 extern cvar_t cl_playermodel;
1247 extern cvar_t cl_playerskin;
1249 extern cvar_t rcon_password;
1250 extern cvar_t rcon_address;
1252 extern cvar_t cl_upspeed;
1253 extern cvar_t cl_forwardspeed;
1254 extern cvar_t cl_backspeed;
1255 extern cvar_t cl_sidespeed;
1257 extern cvar_t cl_movespeedkey;
1259 extern cvar_t cl_yawspeed;
1260 extern cvar_t cl_pitchspeed;
1262 extern cvar_t cl_anglespeedkey;
1264 extern cvar_t cl_autofire;
1266 extern cvar_t cl_shownet;
1267 extern cvar_t cl_nolerp;
1268 extern cvar_t cl_nettimesyncfactor;
1269 extern cvar_t cl_nettimesyncboundmode;
1270 extern cvar_t cl_nettimesyncboundtolerance;
1272 extern cvar_t cl_pitchdriftspeed;
1273 extern cvar_t lookspring;
1274 extern cvar_t lookstrafe;
1275 extern cvar_t sensitivity;
1277 extern cvar_t freelook;
1279 extern cvar_t m_pitch;
1280 extern cvar_t m_yaw;
1281 extern cvar_t m_forward;
1282 extern cvar_t m_side;
1284 extern cvar_t cl_autodemo;
1285 extern cvar_t cl_autodemo_nameformat;
1286 extern cvar_t cl_autodemo_delete;
1288 extern cvar_t r_draweffects;
1290 extern cvar_t cl_explosions_alpha_start;
1291 extern cvar_t cl_explosions_alpha_end;
1292 extern cvar_t cl_explosions_size_start;
1293 extern cvar_t cl_explosions_size_end;
1294 extern cvar_t cl_explosions_lifetime;
1295 extern cvar_t cl_stainmaps;
1296 extern cvar_t cl_stainmaps_clearonload;
1298 extern cvar_t cl_prydoncursor;
1299 extern cvar_t cl_prydoncursor_notrace;
1301 extern cvar_t cl_locs_enable;
1303 extern client_state_t cl;
1305 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);
1307 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1308 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1310 //=============================================================================
1316 void CL_Shutdown (void);
1317 void CL_Init (void);
1319 void CL_EstablishConnection(const char *host);
1321 void CL_Disconnect (void);
1322 void CL_Disconnect_f (void);
1324 void CL_UpdateRenderEntity(entity_render_t *ent);
1325 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1326 void CL_UpdateViewEntities(void);
1331 typedef struct kbutton_s
1333 int down[2]; // key nums holding it down
1334 int state; // low bit is down state
1338 extern kbutton_t in_mlook, in_klook;
1339 extern kbutton_t in_strafe;
1340 extern kbutton_t in_speed;
1342 void CL_InitInput (void);
1343 void CL_SendMove (void);
1345 void CL_ValidateState(entity_state_t *s);
1346 void CL_MoveLerpEntityStates(entity_t *ent);
1347 void CL_LerpUpdate(entity_t *e);
1348 void CL_ParseTEnt (void);
1349 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1350 void CL_RelinkBeams (void);
1351 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1352 void CL_ClientMovement_Replay(void);
1354 void CL_ClearTempEntities (void);
1355 entity_render_t *CL_NewTempEntity (double shadertime);
1357 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1359 void CL_ClearState (void);
1360 void CL_ExpandEntities(int num);
1361 void CL_ExpandCSQCRenderEntities(int num);
1362 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1365 void CL_UpdateWorld (void);
1366 void CL_WriteToServer (void);
1367 void CL_Input (void);
1368 extern int cl_ignoremousemoves;
1371 float CL_KeyState (kbutton_t *key);
1372 const char *Key_KeynumToString (int keynum);
1373 int Key_StringToKeynum (const char *str);
1378 void CL_StopPlayback(void);
1379 void CL_ReadDemoMessage(void);
1380 void CL_WriteDemoMessage(sizebuf_t *mesage);
1382 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1383 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1385 void CL_NextDemo(void);
1386 void CL_Stop_f(void);
1387 void CL_Record_f(void);
1388 void CL_PlayDemo_f(void);
1389 void CL_TimeDemo_f(void);
1394 void CL_Parse_Init(void);
1395 void CL_Parse_Shutdown(void);
1396 void CL_ParseServerMessage(void);
1397 void CL_Parse_DumpPacket(void);
1398 void CL_Parse_ErrorCleanUp(void);
1399 void QW_CL_StartUpload(unsigned char *data, int size);
1400 extern cvar_t qport;
1401 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1406 void V_StartPitchDrift (void);
1407 void V_StopPitchDrift (void);
1410 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1411 void V_UpdateBlends (void);
1412 void V_ParseDamage (void);
1418 extern cvar_t cl_particles;
1419 extern cvar_t cl_particles_quality;
1420 extern cvar_t cl_particles_size;
1421 extern cvar_t cl_particles_quake;
1422 extern cvar_t cl_particles_blood;
1423 extern cvar_t cl_particles_blood_alpha;
1424 extern cvar_t cl_particles_blood_decal_alpha;
1425 extern cvar_t cl_particles_blood_decal_scalemin;
1426 extern cvar_t cl_particles_blood_decal_scalemax;
1427 extern cvar_t cl_particles_blood_bloodhack;
1428 extern cvar_t cl_particles_bulletimpacts;
1429 extern cvar_t cl_particles_explosions_sparks;
1430 extern cvar_t cl_particles_explosions_shell;
1431 extern cvar_t cl_particles_rain;
1432 extern cvar_t cl_particles_snow;
1433 extern cvar_t cl_particles_smoke;
1434 extern cvar_t cl_particles_smoke_alpha;
1435 extern cvar_t cl_particles_smoke_alphafade;
1436 extern cvar_t cl_particles_sparks;
1437 extern cvar_t cl_particles_bubbles;
1438 extern cvar_t cl_decals;
1439 extern cvar_t cl_decals_time;
1440 extern cvar_t cl_decals_fadetime;
1442 void CL_Particles_Clear(void);
1443 void CL_Particles_Init(void);
1444 void CL_Particles_Shutdown(void);
1445 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);
1447 typedef enum effectnameindex_s
1451 EFFECT_TE_GUNSHOTQUAD,
1453 EFFECT_TE_SPIKEQUAD,
1454 EFFECT_TE_SUPERSPIKE,
1455 EFFECT_TE_SUPERSPIKEQUAD,
1457 EFFECT_TE_KNIGHTSPIKE,
1458 EFFECT_TE_EXPLOSION,
1459 EFFECT_TE_EXPLOSIONQUAD,
1460 EFFECT_TE_TAREXPLOSION,
1462 EFFECT_TE_LAVASPLASH,
1463 EFFECT_TE_SMALLFLASH,
1468 EFFECT_TE_PLASMABURN,
1470 EFFECT_TE_TEI_SMOKE,
1471 EFFECT_TE_TEI_BIGEXPLOSION,
1472 EFFECT_TE_TEI_PLASMAHIT,
1478 EFFECT_TR_SLIGHTBLOOD,
1479 EFFECT_TR_KNIGHTSPIKE,
1480 EFFECT_TR_VORESPIKE,
1481 EFFECT_TR_NEHAHRASMOKE,
1482 EFFECT_TR_NEXUIZPLASMA,
1483 EFFECT_TR_GLOWTRAIL,
1484 EFFECT_SVC_PARTICLE,
1489 int CL_ParticleEffectIndexForName(const char *name);
1490 const char *CL_ParticleEffectNameForIndex(int i);
1491 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);
1492 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);
1493 void CL_ParseParticleEffect (void);
1494 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);
1495 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1496 void CL_EntityParticles (const entity_t *ent);
1497 void CL_ParticleExplosion (const vec3_t org);
1498 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1499 void R_NewExplosion(const vec3_t org);
1501 void Debug_PolygonBegin(const char *picname, int flags);
1502 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1503 void Debug_PolygonEnd(void);
1505 #include "cl_screen.h"
1507 extern qboolean sb_showscores;
1509 float RSurf_FogVertex(const vec3_t p);
1510 float RSurf_FogPoint(const vec3_t p);
1512 typedef struct r_refdef_stats_s
1516 int entities_surfaces;
1517 int entities_triangles;
1521 int world_triangles;
1522 int lightmapupdates;
1523 int lightmapupdatepixels;
1528 int meshes_elements;
1531 int lights_scissored;
1532 int lights_lighttriangles;
1533 int lights_shadowtriangles;
1534 int lights_dynamicshadowtriangles;
1536 int bloom_copypixels;
1537 int bloom_drawpixels;
1541 typedef enum r_viewport_type_e
1543 R_VIEWPORTTYPE_ORTHO,
1544 R_VIEWPORTTYPE_PERSPECTIVE,
1545 R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1546 R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1547 R_VIEWPORTTYPE_TOTAL
1551 typedef struct r_viewport_s
1553 matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1554 matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1555 matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1562 r_viewport_type_t type;
1563 float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1567 typedef struct r_refdef_view_s
1569 // view information (changes multiple times per frame)
1570 // if any of these variables change then r_refdef.viewcache must be regenerated
1571 // by calling R_View_Update
1572 // (which also updates viewport, scissor, colormask)
1574 // it is safe and expected to copy this into a structure on the stack and
1575 // call the renderer recursively, then restore from the stack afterward
1576 // (as long as R_View_Update is called)
1578 // eye position information
1579 matrix4x4_t matrix, inverse_matrix;
1585 int numfrustumplanes;
1586 mplane_t frustum[6];
1587 qboolean useclipplane;
1588 qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1590 float frustum_x, frustum_y;
1591 vec3_t frustumcorner[4];
1592 // if turned off it renders an ortho view
1594 float ortho_x, ortho_y;
1596 // screen area to render in
1603 r_viewport_t viewport;
1605 // which color components to allow (for anaglyph glasses)
1608 // global RGB color multiplier for rendering, this is required by HDR
1611 // whether to call R_ClearScreen before rendering stuff
1613 // if true, don't clear or do any post process effects (bloom, etc)
1616 // whether to draw r_showtris and such, this is only true for the main
1617 // view render, all secondary renders (HDR, mirrors, portals, cameras,
1618 // distortion effects, etc) omit such debugging information
1621 // these define which values to use in GL_CullFace calls to request frontface or backface culling
1625 // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1630 typedef struct r_refdef_viewcache_s
1632 // updated by gl_main_newmap()
1634 int world_numclusters;
1635 int world_numclusterbytes;
1637 int world_numsurfaces;
1639 // these properties are generated by R_View_Update()
1641 // which entities are currently visible for this viewpoint
1642 // (the used range is 0...r_refdef.scene.numentities)
1643 unsigned char *entityvisible;
1645 // flag arrays used for visibility checking on world model
1646 // (all other entities have no per-surface/per-leaf visibility checks)
1647 unsigned char *world_pvsbits;
1648 unsigned char *world_leafvisible;
1649 unsigned char *world_surfacevisible;
1650 // if true, the view is currently in a leaf without pvs data
1651 qboolean world_novis;
1653 r_refdef_viewcache_t;
1655 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1656 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1657 typedef struct r_refdef_scene_s {
1658 // whether to call S_ExtraUpdate during render to reduce sound chop
1659 qboolean extraupdate;
1661 // (client gameworld) time for rendering time based effects
1665 entity_render_t *worldentity;
1667 // same as worldentity->model
1668 dp_model_t *worldmodel;
1670 // renderable entities (excluding world)
1671 entity_render_t **entities;
1675 // field of temporary entities that is reset each (client) frame
1676 entity_render_t *tempentities;
1677 int numtempentities;
1678 int maxtempentities;
1680 // renderable dynamic lights
1681 rtlight_t *lights[MAX_DLIGHTS];
1682 rtlight_t templights[MAX_DLIGHTS];
1685 // intensities for light styles right now, controls rtlights
1686 float rtlightstylevalue[MAX_LIGHTSTYLES]; // float fraction of base light value
1687 // 8.8bit fixed point intensities for light styles
1688 // controls intensity lightmap layers
1689 unsigned short lightstylevalue[MAX_LIGHTSTYLES]; // 8.8 fraction of base light value
1694 qboolean rtworldshadows;
1696 qboolean rtdlightshadows;
1699 typedef struct r_refdef_s
1701 // these fields define the basic rendering information for the world
1702 // but not the view, which could change multiple times in one rendered
1703 // frame (for example when rendering textures for certain effects)
1705 // these are set for water warping before
1706 // frustum_x/frustum_y are calculated
1707 float frustumscale_x, frustumscale_y;
1709 // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1710 r_refdef_view_t view;
1711 r_refdef_viewcache_t viewcache;
1713 // minimum visible distance (pixels closer than this disappear)
1715 // maximum visible distance (pixels further than this disappear in 16bpp modes,
1716 // in 32bpp an infinite-farclip matrix is used instead)
1719 // fullscreen color blend
1722 r_refdef_scene_t scene;
1725 float fogplaneviewdist;
1726 qboolean fogplaneviewabove;
1727 float fogheightfade;
1730 float fograngerecip;
1731 float fogmasktabledistmultiplier;
1732 #define FOGMASKTABLEWIDTH 1024
1733 float fogmasktable[FOGMASKTABLEWIDTH];
1734 float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1743 float fog_fadedepth;
1744 qboolean fogenabled;
1745 qboolean oldgl_fogenable;
1747 // new flexible texture height fog (overrides normal fog)
1748 char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1749 unsigned char *fog_height_table1d;
1750 unsigned char *fog_height_table2d;
1751 int fog_height_tablesize; // enable
1752 float fog_height_tablescale;
1753 float fog_height_texcoordscale;
1754 char fogheighttexturename[64]; // detects changes to active fog height texture
1756 qboolean draw2dstage;
1758 // true during envmap command capture
1761 // brightness of world lightmaps and related lighting
1762 // (often reduced when world rtlights are enabled)
1763 float lightmapintensity;
1764 // whether to draw world lights realtime, dlights realtime, and their shadows
1765 float polygonfactor;
1766 float polygonoffset;
1767 float shadowpolygonfactor;
1768 float shadowpolygonoffset;
1770 // rendering stats for r_speeds display
1771 // (these are incremented in many places)
1772 r_refdef_stats_t stats;
1776 extern r_refdef_t r_refdef;