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;
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;
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
382 // storage of decals on this entity
383 // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
385 decalsystem_t decalsystem;
387 // FIELDS UPDATED BY RENDERER:
388 // last time visible during trace culling
389 double last_trace_visibility;
393 typedef struct entity_persistent_s
399 qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
401 // muzzleflash fading
404 // interpolated movement
406 // start time of move
408 // time difference from start to end of move
410 // the move itself, start and end
418 typedef struct entity_s
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;
427 // used for regenerating parts of render
428 entity_persistent_t persistent;
430 // the only data the renderer should know about
431 entity_render_t render;
435 typedef struct usercmd_s
439 // intended velocities
444 vec3_t cursor_screen;
447 vec3_t cursor_impact;
448 vec3_t cursor_normal;
449 vec_t cursor_fraction;
450 int cursor_entitynumber;
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
459 qboolean applied; // if false we're still accumulating a move
460 qboolean predicted; // if true the sequence should be sent as 0
462 // derived properties
469 typedef struct lightstyle_s
472 char map[MAX_STYLESTRING];
475 typedef struct scoreboard_s
477 char name[MAX_SCOREBOARDNAME];
479 int colors; // two 4 bit fields
482 char qw_userinfo[MAX_USERINFO_STRING];
489 char qw_skin[MAX_QPATH];
492 typedef struct cshift_s
495 float percent; // 0-255
496 float alphafade; // (any speed)
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
506 #define NAME_LENGTH 64
510 // client_state_t should hold all pieces of the client state
513 #define SIGNONS 4 // signon messages to receive before connected
515 typedef enum cactive_e
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
524 typedef enum qw_downloadtype_e
534 typedef enum capturevideoformat_e
536 CAPTUREVIDEOFORMAT_AVI_I420,
537 CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
539 capturevideoformat_t;
541 typedef struct capturevideostate_s
543 double startrealtime;
556 int soundsampleframe;
557 unsigned char *screenbuffer;
558 unsigned char *outbuffer;
559 char basename[MAX_QPATH];
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];
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];
571 // stuff to be filled in by the video format module
572 capturevideoformat_t format;
573 const char *formatextension;
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);
581 // format specific data
582 void *formatspecific;
586 #define CL_MAX_DOWNLOADACKS 4
588 typedef struct cl_downloadack_s
594 typedef struct cl_soundstats_s
598 int latency_milliseconds;
603 // the client_static_t structure is persistent through an arbitrary number
604 // of server connections
606 typedef struct client_static_s
610 // all client memory allocations go in these pools
611 mempool_t *levelmempool;
612 mempool_t *permanentmempool;
615 // -1 = don't play demos
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];
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;
629 // -1 = use normal cd track
632 // realtime at second frame of timedemo (LordHavoc: changed to double)
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
645 // sound mixer statistics for showsound display
646 cl_soundstats_t soundstats;
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;
659 lhnetaddress_t rcon_addresses[MAX_RCONS];
660 char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
661 double rcon_timeout[MAX_RCONS];
664 // connection information
667 // network connection
670 // download information
671 // (note: qw_download variables are also used)
672 cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
674 // input sequence numbers are not reset on level change, only connect
676 int servermovesequence;
678 // quakeworld stuff below
680 // value of "qport" cvar at time of connection
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;
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;
700 // current file upload buffer (for uploading screenshots to server)
701 unsigned char *qw_uploaddata;
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];
710 // video capture stuff
711 capturevideostate_t capturevideo;
715 extern client_static_t cls;
717 typedef struct client_movementqueue_s
728 client_movementqueue_t;
734 qboolean drawenginesbar;
735 qboolean drawcrosshair;
740 PARTICLE_BILLBOARD = 0,
742 PARTICLE_ORIENTED_DOUBLESIDED = 2,
745 PARTICLE_INVALID = -1
758 typedef struct particletype_s
761 porientation_t orientation;
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
772 typedef struct decal_s
774 // fields used by rendering: (44 bytes)
775 unsigned short typeindex;
776 unsigned short texnum;
781 float alpha; // 0-255
782 unsigned char color[3];
783 unsigned char unused1;
784 int clusterindex; // cheap culling by pvs
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
795 typedef struct particle_s
797 // for faster batch rendering, particles are rendered in groups by effect (resulting in less perfect sorting but far less state changes)
799 // fields used by rendering: (48 bytes)
800 vec3_t sortorigin; // sort by this group origin, not particle org
802 vec3_t vel; // velocity of particle, or orientation of decal, or end point of beam
804 float alpha; // 0-255
805 float stretch; // only for sparks
807 // fields not used by rendering: (44 bytes)
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
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
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;
837 typedef enum cl_parsingtextmode_e
839 CL_PARSETEXTMODE_NONE,
840 CL_PARSETEXTMODE_PING,
841 CL_PARSETEXTMODE_STATUS,
842 CL_PARSETEXTMODE_STATUS_PLAYERID,
843 CL_PARSETEXTMODE_STATUS_PLAYERIP
845 cl_parsingtextmode_t;
847 typedef struct cl_locnode_s
849 struct cl_locnode_s *next;
855 typedef struct showlmp_s
866 // the client_state_t structure is wiped completely at every
869 typedef struct client_state_s
871 // true if playing in a local game and no one else is connected
874 // send a clc_nop periodically until connected
877 // current input being accumulated by mouse/joystick/etc input
879 // latest moves sent to the server that have not been confirmed yet
880 usercmd_t movecmd[CL_MAX_USERCMDS];
882 // information for local display
884 int stats[MAX_CL_STATS];
885 float *statsf; // points to stats[] array
886 // last known inventory bit flags, for blinking
888 // cl.time of acquiring item, for blinking
889 float item_gettime[32];
890 // last known STAT_ACTIVEWEAPON
892 // cl.time of changing STAT_ACTIVEWEAPON
894 // use pain anim frame if cl.time < this
896 // for stair smoothing
898 double stairsmoothtime;
900 // color shifts for damage, powerups
901 cshift_t cshifts[NUM_CSHIFTS];
903 cshift_t prev_cshifts[NUM_CSHIFTS];
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.
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];
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;
940 // previous gun angles (for leaning effects)
941 vec3_t gunangles_lowpass;
942 // highpass store for highpassing the origin (for following effect)
943 vec3_t gunorg_minus_vieworg_diff_highpass;
945 // pitch drifting vars
952 //[515]: added for csqc purposes
953 float sensitivityscale;
954 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
955 qboolean csqc_wantsmousemove;
956 qboolean csqc_paused; // vortex: int because could be flags
957 struct model_s *csqc_model_precache[MAX_MODELS];
959 // local amount for smoothing stepups
968 qboolean oldonground;
969 double lastongroundtime;
970 double hitgroundtime;
972 // don't change view angle, full screen, etc
974 // latched at intermission start
975 double completed_time;
977 // the timestamp of the last two messages
980 // clients view of time, time should be between mtime[0] and mtime[1] to
981 // generate a lerp point for other data, oldtime is the previous frame's
982 // value of time, frametime is the difference between time and oldtime
983 // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
984 // is only forcefully limited when a packet is received
985 double time, oldtime;
986 // how long it has been since the previous client frame in real time
987 // (not game time, for that use cl.time - cl.oldtime)
988 double realframetime;
990 // fade var for fading while dead
993 // motionblur alpha level variable
994 float motionbluralpha;
996 // copy of realtime from last recieved message, for net trouble icon
997 float last_received_message;
999 // information that is static for the entire time connected to a server
1000 struct model_s *model_precache[MAX_MODELS];
1001 struct sfx_s *sound_precache[MAX_SOUNDS];
1003 // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
1004 char model_name[MAX_MODELS][MAX_QPATH];
1005 char sound_name[MAX_SOUNDS][MAX_QPATH];
1007 // for display on solo scoreboard
1009 // cl_entitites[cl.viewentity] = player
1011 // the real player entity (normally same as viewentity,
1012 // different than viewentity if mod uses chasecam or other tricks)
1013 int realplayerentity;
1014 // this is updated to match cl.viewentity whenever it is in the clients
1015 // range, basically this is used in preference to cl.realplayerentity for
1016 // most purposes because when spectating another player it should show
1017 // their information rather than yours
1019 // max players that can be in this game
1021 // type of game (deathmatch, coop, singleplayer)
1024 // models and sounds used by engine code (particularly cl_parse.c)
1025 dp_model_t *model_bolt;
1026 dp_model_t *model_bolt2;
1027 dp_model_t *model_bolt3;
1028 dp_model_t *model_beam;
1030 sfx_t *sfx_knighthit;
1036 // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1037 qboolean foundtalk2wav;
1039 // refresh related state
1041 // cl_entitites[0].model
1042 struct model_s *worldmodel;
1048 int cdtrack, looptrack;
1053 scoreboard_t *scores;
1055 // keep track of svc_print parsing state (analyzes ping reports and status reports)
1056 cl_parsingtextmode_t parsingtextmode;
1057 int parsingtextplayerindex;
1058 // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1059 // (which could eat the wrong ping report if the player issues one
1060 // manually, but they would still see a ping report, just a later one
1061 // caused by the scoreboard code rather than the one they intentionally
1063 int parsingtextexpectingpingforscores;
1065 // entity database stuff
1066 // latest received entity frame numbers
1067 #define LATESTFRAMENUMS 32
1068 int latestframenumsposition;
1069 int latestframenums[LATESTFRAMENUMS];
1070 int latestsendnums[LATESTFRAMENUMS];
1071 entityframe_database_t *entitydatabase;
1072 entityframe4_database_t *entitydatabase4;
1073 entityframeqw_database_t *entitydatabaseqw;
1075 // keep track of quake entities because they need to be killed if they get stale
1076 int lastquakeentity;
1077 unsigned char isquakeentity[MAX_EDICTS];
1079 // bounding boxes for clientside movement
1080 vec3_t playerstandmins;
1081 vec3_t playerstandmaxs;
1082 vec3_t playercrouchmins;
1083 vec3_t playercrouchmaxs;
1085 // old decals are killed based on this
1089 int max_csqcrenderentities;
1090 int max_static_entities;
1095 int max_brushmodel_entities;
1101 entity_render_t *csqcrenderentities;
1102 unsigned char *entities_active;
1103 entity_t *static_entities;
1104 cl_effect_t *effects;
1107 lightstyle_t *lightstyle;
1108 int *brushmodel_entities;
1109 particle_t *particles;
1111 showlmp_t *showlmps;
1114 int num_static_entities;
1115 int num_brushmodel_entities;
1123 double particles_updatetime;
1124 double decals_updatetime;
1128 // cl_serverextension_download feature
1129 int loadmodel_current;
1130 int downloadmodel_current;
1131 int loadmodel_total;
1132 int loadsound_current;
1133 int downloadsound_current;
1134 int loadsound_total;
1135 qboolean downloadcsqc;
1138 qboolean loadfinished;
1142 // local copy of the server infostring
1143 char qw_serverinfo[MAX_SERVERINFO_STRING];
1145 // time of last qw "pings" command sent to server while showing scores
1146 double last_ping_request;
1148 // used during connect
1151 // updated from serverinfo
1154 // unused: indicates whether the player is spectating
1155 // use cl.scores[cl.playerentity-1].qw_spectator instead
1156 //qboolean qw_spectator;
1158 // last time an input packet was sent
1159 double lastpackettime;
1161 // movement parameters for client prediction
1162 unsigned int moveflags;
1163 float movevars_wallfriction;
1164 float movevars_waterfriction;
1165 float movevars_friction;
1166 float movevars_timescale;
1167 float movevars_gravity;
1168 float movevars_stopspeed;
1169 float movevars_maxspeed;
1170 float movevars_spectatormaxspeed;
1171 float movevars_accelerate;
1172 float movevars_airaccelerate;
1173 float movevars_wateraccelerate;
1174 float movevars_entgravity;
1175 float movevars_jumpvelocity;
1176 float movevars_edgefriction;
1177 float movevars_maxairspeed;
1178 float movevars_stepheight;
1179 float movevars_airaccel_qw;
1180 float movevars_airaccel_sideways_friction;
1181 float movevars_airstopaccelerate;
1182 float movevars_airstrafeaccelerate;
1183 float movevars_maxairstrafespeed;
1184 float movevars_aircontrol;
1185 float movevars_warsowbunny_airforwardaccel;
1186 float movevars_warsowbunny_accel;
1187 float movevars_warsowbunny_topspeed;
1188 float movevars_warsowbunny_turnaccel;
1189 float movevars_warsowbunny_backtosideratio;
1190 float movevars_ticrate;
1192 // models used by qw protocol
1193 int qw_modelindex_spike;
1194 int qw_modelindex_player;
1195 int qw_modelindex_flag;
1196 int qw_modelindex_s_explod;
1198 vec3_t qw_intermission_origin;
1199 vec3_t qw_intermission_angles;
1201 // 255 is the most nails the QW protocol could send
1203 vec_t qw_nails[255][6];
1205 float qw_weaponkick;
1207 int qw_validsequence;
1209 int qw_deltasequence[QW_UPDATE_BACKUP];
1212 // server entity number corresponding to a clientside entity
1213 unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1214 qboolean csqc_loaded;
1217 qboolean csqc_usecsqclistener;
1218 matrix4x4_t csqc_listenermatrix;
1219 char csqc_printtextbuf[MAX_INPUTLINE];
1221 // collision culling data
1224 // loc file stuff (points and boxes describing locations in the level)
1225 cl_locnode_t *locnodes;
1226 // this is updated to cl.movement_origin whenever health is < 1
1227 // used by %d print in say/say_team messages if cl_locs_enable is on
1228 vec3_t lastdeathorigin;
1230 // processing buffer used by R_BuildLightMap, reallocated as needed,
1231 // freed on each level change
1232 size_t buildlightmapmemorysize;
1233 unsigned char *buildlightmapmemory;
1240 extern cvar_t cl_name;
1241 extern cvar_t cl_color;
1242 extern cvar_t cl_rate;
1243 extern cvar_t cl_pmodel;
1244 extern cvar_t cl_playermodel;
1245 extern cvar_t cl_playerskin;
1247 extern cvar_t rcon_password;
1248 extern cvar_t rcon_address;
1250 extern cvar_t cl_upspeed;
1251 extern cvar_t cl_forwardspeed;
1252 extern cvar_t cl_backspeed;
1253 extern cvar_t cl_sidespeed;
1255 extern cvar_t cl_movespeedkey;
1257 extern cvar_t cl_yawspeed;
1258 extern cvar_t cl_pitchspeed;
1260 extern cvar_t cl_anglespeedkey;
1262 extern cvar_t cl_autofire;
1264 extern cvar_t cl_shownet;
1265 extern cvar_t cl_nolerp;
1266 extern cvar_t cl_nettimesyncfactor;
1267 extern cvar_t cl_nettimesyncboundmode;
1268 extern cvar_t cl_nettimesyncboundtolerance;
1270 extern cvar_t cl_pitchdriftspeed;
1271 extern cvar_t lookspring;
1272 extern cvar_t lookstrafe;
1273 extern cvar_t sensitivity;
1275 extern cvar_t freelook;
1277 extern cvar_t m_pitch;
1278 extern cvar_t m_yaw;
1279 extern cvar_t m_forward;
1280 extern cvar_t m_side;
1282 extern cvar_t cl_autodemo;
1283 extern cvar_t cl_autodemo_nameformat;
1284 extern cvar_t cl_autodemo_delete;
1286 extern cvar_t r_draweffects;
1288 extern cvar_t cl_explosions_alpha_start;
1289 extern cvar_t cl_explosions_alpha_end;
1290 extern cvar_t cl_explosions_size_start;
1291 extern cvar_t cl_explosions_size_end;
1292 extern cvar_t cl_explosions_lifetime;
1293 extern cvar_t cl_stainmaps;
1294 extern cvar_t cl_stainmaps_clearonload;
1296 extern cvar_t cl_prydoncursor;
1297 extern cvar_t cl_prydoncursor_notrace;
1299 extern cvar_t cl_locs_enable;
1301 extern client_state_t cl;
1303 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);
1305 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1306 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1308 //=============================================================================
1314 void CL_Shutdown (void);
1315 void CL_Init (void);
1317 void CL_EstablishConnection(const char *host);
1319 void CL_Disconnect (void);
1320 void CL_Disconnect_f (void);
1322 void CL_UpdateRenderEntity(entity_render_t *ent);
1323 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1324 void CL_UpdateViewEntities(void);
1329 typedef struct kbutton_s
1331 int down[2]; // key nums holding it down
1332 int state; // low bit is down state
1336 extern kbutton_t in_mlook, in_klook;
1337 extern kbutton_t in_strafe;
1338 extern kbutton_t in_speed;
1340 void CL_InitInput (void);
1341 void CL_SendMove (void);
1343 void CL_ValidateState(entity_state_t *s);
1344 void CL_MoveLerpEntityStates(entity_t *ent);
1345 void CL_LerpUpdate(entity_t *e);
1346 void CL_ParseTEnt (void);
1347 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1348 void CL_RelinkBeams (void);
1349 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1350 void CL_ClientMovement_Replay(void);
1352 void CL_ClearTempEntities (void);
1353 entity_render_t *CL_NewTempEntity (double shadertime);
1355 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1357 void CL_ClearState (void);
1358 void CL_ExpandEntities(int num);
1359 void CL_ExpandCSQCRenderEntities(int num);
1360 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1363 void CL_UpdateWorld (void);
1364 void CL_WriteToServer (void);
1365 void CL_Input (void);
1366 extern int cl_ignoremousemoves;
1369 float CL_KeyState (kbutton_t *key);
1370 const char *Key_KeynumToString (int keynum);
1371 int Key_StringToKeynum (const char *str);
1376 void CL_StopPlayback(void);
1377 void CL_ReadDemoMessage(void);
1378 void CL_WriteDemoMessage(sizebuf_t *mesage);
1380 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1381 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1383 void CL_NextDemo(void);
1384 void CL_Stop_f(void);
1385 void CL_Record_f(void);
1386 void CL_PlayDemo_f(void);
1387 void CL_TimeDemo_f(void);
1392 void CL_Parse_Init(void);
1393 void CL_Parse_Shutdown(void);
1394 void CL_ParseServerMessage(void);
1395 void CL_Parse_DumpPacket(void);
1396 void CL_Parse_ErrorCleanUp(void);
1397 void QW_CL_StartUpload(unsigned char *data, int size);
1398 extern cvar_t qport;
1399 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1404 void V_StartPitchDrift (void);
1405 void V_StopPitchDrift (void);
1408 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1409 void V_UpdateBlends (void);
1410 void V_ParseDamage (void);
1416 extern cvar_t cl_particles;
1417 extern cvar_t cl_particles_quality;
1418 extern cvar_t cl_particles_size;
1419 extern cvar_t cl_particles_quake;
1420 extern cvar_t cl_particles_blood;
1421 extern cvar_t cl_particles_blood_alpha;
1422 extern cvar_t cl_particles_blood_decal_alpha;
1423 extern cvar_t cl_particles_blood_decal_scalemin;
1424 extern cvar_t cl_particles_blood_decal_scalemax;
1425 extern cvar_t cl_particles_blood_bloodhack;
1426 extern cvar_t cl_particles_bulletimpacts;
1427 extern cvar_t cl_particles_explosions_sparks;
1428 extern cvar_t cl_particles_explosions_shell;
1429 extern cvar_t cl_particles_rain;
1430 extern cvar_t cl_particles_snow;
1431 extern cvar_t cl_particles_smoke;
1432 extern cvar_t cl_particles_smoke_alpha;
1433 extern cvar_t cl_particles_smoke_alphafade;
1434 extern cvar_t cl_particles_sparks;
1435 extern cvar_t cl_particles_bubbles;
1436 extern cvar_t cl_decals;
1437 extern cvar_t cl_decals_time;
1438 extern cvar_t cl_decals_fadetime;
1440 void CL_Particles_Clear(void);
1441 void CL_Particles_Init(void);
1442 void CL_Particles_Shutdown(void);
1443 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);
1445 typedef enum effectnameindex_s
1449 EFFECT_TE_GUNSHOTQUAD,
1451 EFFECT_TE_SPIKEQUAD,
1452 EFFECT_TE_SUPERSPIKE,
1453 EFFECT_TE_SUPERSPIKEQUAD,
1455 EFFECT_TE_KNIGHTSPIKE,
1456 EFFECT_TE_EXPLOSION,
1457 EFFECT_TE_EXPLOSIONQUAD,
1458 EFFECT_TE_TAREXPLOSION,
1460 EFFECT_TE_LAVASPLASH,
1461 EFFECT_TE_SMALLFLASH,
1466 EFFECT_TE_PLASMABURN,
1468 EFFECT_TE_TEI_SMOKE,
1469 EFFECT_TE_TEI_BIGEXPLOSION,
1470 EFFECT_TE_TEI_PLASMAHIT,
1476 EFFECT_TR_SLIGHTBLOOD,
1477 EFFECT_TR_KNIGHTSPIKE,
1478 EFFECT_TR_VORESPIKE,
1479 EFFECT_TR_NEHAHRASMOKE,
1480 EFFECT_TR_NEXUIZPLASMA,
1481 EFFECT_TR_GLOWTRAIL,
1482 EFFECT_SVC_PARTICLE,
1487 int CL_ParticleEffectIndexForName(const char *name);
1488 const char *CL_ParticleEffectNameForIndex(int i);
1489 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);
1490 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);
1491 void CL_ParseParticleEffect (void);
1492 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);
1493 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1494 void CL_EntityParticles (const entity_t *ent);
1495 void CL_ParticleExplosion (const vec3_t org);
1496 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1497 void R_NewExplosion(const vec3_t org);
1499 void Debug_PolygonBegin(const char *picname, int flags);
1500 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1501 void Debug_PolygonEnd(void);
1503 #include "cl_screen.h"
1505 extern qboolean sb_showscores;
1507 float RSurf_FogVertex(const vec3_t p);
1508 float RSurf_FogPoint(const vec3_t p);
1510 typedef struct r_refdef_stats_s
1514 int entities_surfaces;
1515 int entities_triangles;
1519 int world_triangles;
1520 int lightmapupdates;
1521 int lightmapupdatepixels;
1526 int meshes_elements;
1529 int lights_scissored;
1530 int lights_lighttriangles;
1531 int lights_shadowtriangles;
1532 int lights_dynamicshadowtriangles;
1534 int bloom_copypixels;
1535 int bloom_drawpixels;
1536 int indexbufferuploadcount;
1537 int indexbufferuploadsize;
1538 int vertexbufferuploadcount;
1539 int vertexbufferuploadsize;
1543 typedef enum r_viewport_type_e
1545 R_VIEWPORTTYPE_ORTHO,
1546 R_VIEWPORTTYPE_PERSPECTIVE,
1547 R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1548 R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1549 R_VIEWPORTTYPE_TOTAL
1553 typedef struct r_viewport_s
1555 matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1556 matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1557 matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1564 r_viewport_type_t type;
1565 float screentodepth[2]; // used by deferred renderer to calculate linear depth from device depth coordinates
1569 typedef struct r_refdef_view_s
1571 // view information (changes multiple times per frame)
1572 // if any of these variables change then r_refdef.viewcache must be regenerated
1573 // by calling R_View_Update
1574 // (which also updates viewport, scissor, colormask)
1576 // it is safe and expected to copy this into a structure on the stack and
1577 // call the renderer recursively, then restore from the stack afterward
1578 // (as long as R_View_Update is called)
1580 // eye position information
1581 matrix4x4_t matrix, inverse_matrix;
1587 int numfrustumplanes;
1588 mplane_t frustum[6];
1589 qboolean useclipplane;
1590 qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1592 float frustum_x, frustum_y;
1593 vec3_t frustumcorner[4];
1594 // if turned off it renders an ortho view
1596 float ortho_x, ortho_y;
1598 // screen area to render in
1605 r_viewport_t viewport;
1607 // which color components to allow (for anaglyph glasses)
1610 // global RGB color multiplier for rendering, this is required by HDR
1613 // whether to call R_ClearScreen before rendering stuff
1615 // if true, don't clear or do any post process effects (bloom, etc)
1618 // whether to draw r_showtris and such, this is only true for the main
1619 // view render, all secondary renders (HDR, mirrors, portals, cameras,
1620 // distortion effects, etc) omit such debugging information
1623 // these define which values to use in GL_CullFace calls to request frontface or backface culling
1627 // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1632 typedef struct r_refdef_viewcache_s
1634 // updated by gl_main_newmap()
1636 int world_numclusters;
1637 int world_numclusterbytes;
1639 int world_numsurfaces;
1641 // these properties are generated by R_View_Update()
1643 // which entities are currently visible for this viewpoint
1644 // (the used range is 0...r_refdef.scene.numentities)
1645 unsigned char *entityvisible;
1647 // flag arrays used for visibility checking on world model
1648 // (all other entities have no per-surface/per-leaf visibility checks)
1649 unsigned char *world_pvsbits;
1650 unsigned char *world_leafvisible;
1651 unsigned char *world_surfacevisible;
1652 // if true, the view is currently in a leaf without pvs data
1653 qboolean world_novis;
1655 r_refdef_viewcache_t;
1657 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1658 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1659 typedef struct r_refdef_scene_s {
1660 // whether to call S_ExtraUpdate during render to reduce sound chop
1661 qboolean extraupdate;
1663 // (client gameworld) time for rendering time based effects
1667 entity_render_t *worldentity;
1669 // same as worldentity->model
1670 dp_model_t *worldmodel;
1672 // renderable entities (excluding world)
1673 entity_render_t **entities;
1677 // field of temporary entities that is reset each (client) frame
1678 entity_render_t *tempentities;
1679 int numtempentities;
1680 int maxtempentities;
1682 // renderable dynamic lights
1683 rtlight_t *lights[MAX_DLIGHTS];
1684 rtlight_t templights[MAX_DLIGHTS];
1687 // intensities for light styles right now, controls rtlights
1688 float rtlightstylevalue[MAX_LIGHTSTYLES]; // float fraction of base light value
1689 // 8.8bit fixed point intensities for light styles
1690 // controls intensity lightmap layers
1691 unsigned short lightstylevalue[MAX_LIGHTSTYLES]; // 8.8 fraction of base light value
1696 qboolean rtworldshadows;
1698 qboolean rtdlightshadows;
1701 typedef struct r_refdef_s
1703 // these fields define the basic rendering information for the world
1704 // but not the view, which could change multiple times in one rendered
1705 // frame (for example when rendering textures for certain effects)
1707 // these are set for water warping before
1708 // frustum_x/frustum_y are calculated
1709 float frustumscale_x, frustumscale_y;
1711 // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1712 r_refdef_view_t view;
1713 r_refdef_viewcache_t viewcache;
1715 // minimum visible distance (pixels closer than this disappear)
1717 // maximum visible distance (pixels further than this disappear in 16bpp modes,
1718 // in 32bpp an infinite-farclip matrix is used instead)
1721 // fullscreen color blend
1724 r_refdef_scene_t scene;
1727 float fogplaneviewdist;
1728 qboolean fogplaneviewabove;
1729 float fogheightfade;
1732 float fograngerecip;
1733 float fogmasktabledistmultiplier;
1734 #define FOGMASKTABLEWIDTH 1024
1735 float fogmasktable[FOGMASKTABLEWIDTH];
1736 float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1745 float fog_fadedepth;
1746 qboolean fogenabled;
1747 qboolean oldgl_fogenable;
1749 // new flexible texture height fog (overrides normal fog)
1750 char fog_height_texturename[64]; // note: must be 64 for the sscanf code
1751 unsigned char *fog_height_table1d;
1752 unsigned char *fog_height_table2d;
1753 int fog_height_tablesize; // enable
1754 float fog_height_tablescale;
1755 float fog_height_texcoordscale;
1756 char fogheighttexturename[64]; // detects changes to active fog height texture
1758 qboolean draw2dstage;
1760 // true during envmap command capture
1763 // brightness of world lightmaps and related lighting
1764 // (often reduced when world rtlights are enabled)
1765 float lightmapintensity;
1766 // whether to draw world lights realtime, dlights realtime, and their shadows
1767 float polygonfactor;
1768 float polygonoffset;
1769 float shadowpolygonfactor;
1770 float shadowpolygonoffset;
1772 // rendering stats for r_speeds display
1773 // (these are incremented in many places)
1774 r_refdef_stats_t stats;
1778 extern r_refdef_t r_refdef;