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_Shadow_Cubemap(rtlight->cubemapname)
145 rtexture_t *currentcubemap;
146 /// set by R_CacheRTLight to decide whether R_DrawRTLight should draw it
148 /// these fields are set by R_CacheRTLight 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 index
368 // current lighting from map (updated ONLY by client code, not renderer)
369 vec3_t modellight_ambient;
370 vec3_t modellight_diffuse; // q3bsp
371 vec3_t modellight_lightdir; // q3bsp
373 // storage of decals on this entity
374 // (note: if allowdecals is set, be sure to call R_DecalSystem_Reset on removal!)
376 decalsystem_t decalsystem;
378 // FIELDS UPDATED BY RENDERER:
379 // last time visible during trace culling
380 double last_trace_visibility;
384 typedef struct entity_persistent_s
390 qboolean trail_allowed; // set to false by teleports, true by update code, prevents bad lerps
392 // muzzleflash fading
395 // interpolated movement
397 // start time of move
399 // time difference from start to end of move
401 // the move itself, start and end
409 typedef struct entity_s
411 // baseline state (default values)
412 entity_state_t state_baseline;
413 // previous state (interpolating from this)
414 entity_state_t state_previous;
415 // current state (interpolating to this)
416 entity_state_t state_current;
418 // used for regenerating parts of render
419 entity_persistent_t persistent;
421 // the only data the renderer should know about
422 entity_render_t render;
426 typedef struct usercmd_s
430 // intended velocities
435 vec3_t cursor_screen;
438 vec3_t cursor_impact;
439 vec3_t cursor_normal;
440 vec_t cursor_fraction;
441 int cursor_entitynumber;
443 double time; // time the move is executed for (cl_movement: clienttime, non-cl_movement: receivetime)
444 double receivetime; // time the move was received at
445 double clienttime; // time to which server state the move corresponds to
446 int msec; // for predicted moves
450 qboolean applied; // if false we're still accumulating a move
451 qboolean predicted; // if true the sequence should be sent as 0
453 // derived properties
460 typedef struct lightstyle_s
463 char map[MAX_STYLESTRING];
466 typedef struct scoreboard_s
468 char name[MAX_SCOREBOARDNAME];
470 int colors; // two 4 bit fields
473 char qw_userinfo[MAX_USERINFO_STRING];
479 char qw_skin[MAX_QPATH];
482 typedef struct cshift_s
485 float percent; // 0-255
486 float alphafade; // (any speed)
489 #define CSHIFT_CONTENTS 0
490 #define CSHIFT_DAMAGE 1
491 #define CSHIFT_BONUS 2
492 #define CSHIFT_POWERUP 3
493 #define CSHIFT_VCSHIFT 4
494 #define NUM_CSHIFTS 5
496 #define NAME_LENGTH 64
500 // client_state_t should hold all pieces of the client state
503 #define SIGNONS 4 // signon messages to receive before connected
505 typedef enum cactive_e
507 ca_uninitialized, // during early startup
508 ca_dedicated, // a dedicated server with no ability to start a client
509 ca_disconnected, // full screen console with no connection
510 ca_connected // valid netcon, talking to a server
514 typedef enum qw_downloadtype_e
524 typedef enum capturevideoformat_e
526 CAPTUREVIDEOFORMAT_AVI_I420,
527 CAPTUREVIDEOFORMAT_OGG_VORBIS_THEORA,
529 capturevideoformat_t;
531 typedef struct capturevideostate_s
533 double startrealtime;
546 int soundsampleframe;
547 unsigned char *screenbuffer;
548 unsigned char *outbuffer;
549 char basename[MAX_QPATH];
552 // precomputed RGB to YUV tables
553 // converts the RGB values to YUV (see cap_avi.c for how to use them)
554 short rgbtoyuvscaletable[3][3][256];
555 unsigned char yuvnormalizetable[3][256];
557 // precomputed gamma ramp (only needed if the capturevideo module uses RGB output)
558 // 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
559 unsigned short vidramp[256 * 3];
561 // stuff to be filled in by the video format module
562 capturevideoformat_t format;
563 const char *formatextension;
566 // cls.capturevideo.videofile = FS_OpenRealFile(va("%s.%s", cls.capturevideo.basename, cls.capturevideo.formatextension), "wb", false);
567 void (*endvideo) (void);
568 void (*videoframes) (int num);
569 void (*soundframe) (const portable_sampleframe_t *paintbuffer, size_t length);
571 // format specific data
572 void *formatspecific;
576 #define CL_MAX_DOWNLOADACKS 4
578 typedef struct cl_downloadack_s
584 typedef struct cl_soundstats_s
588 int latency_milliseconds;
593 // the client_static_t structure is persistent through an arbitrary number
594 // of server connections
596 typedef struct client_static_s
600 // all client memory allocations go in these pools
601 mempool_t *levelmempool;
602 mempool_t *permanentmempool;
605 // -1 = don't play demos
607 // list of demos in loop
608 char demos[MAX_DEMOS][MAX_DEMONAME];
609 // the actively playing demo (set by CL_PlayDemo_f)
610 char demoname[MAX_QPATH];
612 // demo recording info must be here, because record is started before
613 // entering a map (and clearing client_state_t)
614 qboolean demorecording;
615 fs_offset_t demo_lastcsprogssize;
616 int demo_lastcsprogscrc;
617 qboolean demoplayback;
619 // -1 = use normal cd track
622 // realtime at second frame of timedemo (LordHavoc: changed to double)
624 int td_frames; // total frames parsed
625 double td_onesecondnexttime;
626 double td_onesecondframes;
627 double td_onesecondrealtime;
628 double td_onesecondminfps;
629 double td_onesecondmaxfps;
630 double td_onesecondavgfps;
631 int td_onesecondavgcount;
632 // LordHavoc: pausedemo
635 // sound mixer statistics for showsound display
636 cl_soundstats_t soundstats;
638 qboolean connect_trying;
639 int connect_remainingtries;
640 double connect_nextsendtime;
641 lhnetsocket_t *connect_mysocket;
642 lhnetaddress_t connect_address;
643 // protocol version of the server we're connected to
644 // (kept outside client_state_t because it's used between levels)
645 protocolversion_t protocol;
649 lhnetaddress_t rcon_addresses[MAX_RCONS];
650 char rcon_commands[MAX_RCONS][MAX_INPUTLINE];
651 double rcon_timeout[MAX_RCONS];
654 // connection information
657 // network connection
660 // download information
661 // (note: qw_download variables are also used)
662 cl_downloadack_t dp_downloadack[CL_MAX_DOWNLOADACKS];
664 // input sequence numbers are not reset on level change, only connect
666 int servermovesequence;
668 // quakeworld stuff below
670 // value of "qport" cvar at time of connection
672 // copied from cls.netcon->qw. variables every time they change, or set by demos (which have no cls.netcon)
673 int qw_incoming_sequence;
674 int qw_outgoing_sequence;
676 // current file download buffer (only saved when file is completed)
677 char qw_downloadname[MAX_QPATH];
678 unsigned char *qw_downloadmemory;
679 int qw_downloadmemorycursize;
680 int qw_downloadmemorymaxsize;
681 int qw_downloadnumber;
682 int qw_downloadpercent;
683 qw_downloadtype_t qw_downloadtype;
684 // transfer rate display
685 double qw_downloadspeedtime;
686 int qw_downloadspeedcount;
687 int qw_downloadspeedrate;
688 qboolean qw_download_deflate;
690 // current file upload buffer (for uploading screenshots to server)
691 unsigned char *qw_uploaddata;
696 // this normally contains the following keys in quakeworld:
697 // password spectator name team skin topcolor bottomcolor rate noaim msg *ver *ip
698 char userinfo[MAX_USERINFO_STRING];
700 // video capture stuff
701 capturevideostate_t capturevideo;
705 extern client_static_t cls;
707 typedef struct client_movementqueue_s
718 client_movementqueue_t;
724 qboolean drawenginesbar;
725 qboolean drawcrosshair;
730 PARTICLE_BILLBOARD = 0,
732 PARTICLE_ORIENTED_DOUBLESIDED = 2,
735 PARTICLE_INVALID = -1
748 typedef struct particletype_s
751 porientation_t orientation;
758 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
762 typedef struct decal_s
764 // fields used by rendering: (44 bytes)
765 unsigned short typeindex;
766 unsigned short texnum;
771 float alpha; // 0-255
772 unsigned char color[3];
773 unsigned char unused1;
774 int clusterindex; // cheap culling by pvs
776 // fields not used by rendering: (36 bytes in 32bit, 40 bytes in 64bit)
777 float time2; // used for decal fade
778 unsigned int owner; // decal stuck to this entity
779 dp_model_t *ownermodel; // model the decal is stuck to (used to make sure the entity is still alive)
780 vec3_t relativeorigin; // decal at this location in entity's coordinate space
781 vec3_t relativenormal; // decal oriented this way relative to entity's coordinate space
785 typedef struct particle_s
787 // fields used by rendering: (40 bytes)
788 unsigned char typeindex;
790 porientation_t orientation;
791 unsigned char texnum;
793 vec3_t vel; // velocity of particle, or orientation of decal, or end point of beam
795 float alpha; // 0-255
796 unsigned char color[3];
797 unsigned char qualityreduction; // enables skipping of this particle according to r_refdef.view.qualityreduction
798 float stretch; // only for sparks
800 signed char staintexnum;
801 float stainsizefactor;
803 // fields not used by rendering: (40 bytes)
804 float sizeincrease; // rate of size change per second
805 float alphafade; // how much alpha reduces per second
806 float time2; // used for snow fluttering and decal fade
807 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)
808 float gravity; // how much gravity affects this particle (1.0 = normal gravity, 0.0 = none)
809 float airfriction; // how much air friction affects this object (objects with a low mass/size ratio tend to get more air friction)
810 float liquidfriction; // how much liquid friction affects this object (objects with a low mass/size ratio tend to get more liquid friction)
811 float delayedcollisions; // time that p->bounce becomes active
812 float delayedspawn; // time that particle appears and begins moving
813 float die; // time when this particle should be removed, regardless of alpha
817 typedef enum cl_parsingtextmode_e
819 CL_PARSETEXTMODE_NONE,
820 CL_PARSETEXTMODE_PING,
821 CL_PARSETEXTMODE_STATUS,
822 CL_PARSETEXTMODE_STATUS_PLAYERID,
823 CL_PARSETEXTMODE_STATUS_PLAYERIP
825 cl_parsingtextmode_t;
827 typedef struct cl_locnode_s
829 struct cl_locnode_s *next;
835 typedef struct showlmp_s
846 // the client_state_t structure is wiped completely at every
849 typedef struct client_state_s
851 // true if playing in a local game and no one else is connected
854 // send a clc_nop periodically until connected
857 // current input being accumulated by mouse/joystick/etc input
859 // latest moves sent to the server that have not been confirmed yet
860 usercmd_t movecmd[CL_MAX_USERCMDS];
862 // information for local display
864 int stats[MAX_CL_STATS];
865 float *statsf; // points to stats[] array
866 // last known inventory bit flags, for blinking
868 // cl.time of acquiring item, for blinking
869 float item_gettime[32];
870 // last known STAT_ACTIVEWEAPON
872 // cl.time of changing STAT_ACTIVEWEAPON
874 // use pain anim frame if cl.time < this
876 // for stair smoothing
878 double stairsmoothtime;
880 // color shifts for damage, powerups
881 cshift_t cshifts[NUM_CSHIFTS];
883 cshift_t prev_cshifts[NUM_CSHIFTS];
885 // the client maintains its own idea of view angles, which are
886 // sent to the server each frame. The server sets punchangle when
887 // the view is temporarily offset, and an angle reset commands at the start
888 // of each level and after teleporting.
890 // mviewangles is read from demo
891 // viewangles is either client controlled or lerped from mviewangles
892 vec3_t mviewangles[2], viewangles;
893 // update by server, used by qc to do weapon recoil
894 vec3_t mpunchangle[2], punchangle;
895 // update by server, can be used by mods to kick view around
896 vec3_t mpunchvector[2], punchvector;
897 // update by server, used for lean+bob (0 is newest)
898 vec3_t mvelocity[2], velocity;
899 // update by server, can be used by mods for zooming
900 vec_t mviewzoom[2], viewzoom;
901 // if true interpolation the mviewangles and other interpolation of the
902 // player is disabled until the next network packet
903 // this is used primarily by teleporters, and when spectating players
904 // special checking of the old fixangle[1] is used to differentiate
905 // between teleporting and spectating
906 qboolean fixangle[2];
908 // client movement simulation
909 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
910 // set by CL_ClientMovement_Replay functions
911 qboolean movement_predicted;
912 // if true the CL_ClientMovement_Replay function will update origin, etc
913 qboolean movement_replay;
914 // simulated data (this is valid even if cl.movement is false)
915 vec3_t movement_origin;
916 vec3_t movement_velocity;
917 // whether the replay should allow a jump at the first sequence
918 qboolean movement_replay_canjump;
920 // pitch drifting vars
927 //[515]: added for csqc purposes
928 float sensitivityscale;
929 csqc_vidvars_t csqc_vidvars; //[515]: these parms must be set to true by default
930 qboolean csqc_wantsmousemove;
931 struct model_s *csqc_model_precache[MAX_MODELS];
933 // local amount for smoothing stepups
942 qboolean oldonground;
943 double lastongroundtime;
944 double hitgroundtime;
946 // don't change view angle, full screen, etc
948 // latched at intermission start
949 double completed_time;
951 // the timestamp of the last two messages
954 // clients view of time, time should be between mtime[0] and mtime[1] to
955 // generate a lerp point for other data, oldtime is the previous frame's
956 // value of time, frametime is the difference between time and oldtime
957 // note: cl.time may be beyond cl.mtime[0] if packet loss is occuring, it
958 // is only forcefully limited when a packet is received
959 double time, oldtime;
960 // how long it has been since the previous client frame in real time
961 // (not game time, for that use cl.time - cl.oldtime)
962 double realframetime;
964 // fade var for fading while dead
967 // motionblur alpha level variable
968 float motionbluralpha;
970 // copy of realtime from last recieved message, for net trouble icon
971 float last_received_message;
973 // information that is static for the entire time connected to a server
974 struct model_s *model_precache[MAX_MODELS];
975 struct sfx_s *sound_precache[MAX_SOUNDS];
977 // FIXME: this is a lot of memory to be keeping around, this really should be dynamically allocated and freed somehow
978 char model_name[MAX_MODELS][MAX_QPATH];
979 char sound_name[MAX_SOUNDS][MAX_QPATH];
981 // for display on solo scoreboard
983 // cl_entitites[cl.viewentity] = player
985 // the real player entity (normally same as viewentity,
986 // different than viewentity if mod uses chasecam or other tricks)
987 int realplayerentity;
988 // this is updated to match cl.viewentity whenever it is in the clients
989 // range, basically this is used in preference to cl.realplayerentity for
990 // most purposes because when spectating another player it should show
991 // their information rather than yours
993 // max players that can be in this game
995 // type of game (deathmatch, coop, singleplayer)
998 // models and sounds used by engine code (particularly cl_parse.c)
999 dp_model_t *model_bolt;
1000 dp_model_t *model_bolt2;
1001 dp_model_t *model_bolt3;
1002 dp_model_t *model_beam;
1004 sfx_t *sfx_knighthit;
1010 // indicates that the file "sound/misc/talk2.wav" was found (for use by team chat messages)
1011 qboolean foundtalk2wav;
1013 // refresh related state
1015 // cl_entitites[0].model
1016 struct model_s *worldmodel;
1022 int cdtrack, looptrack;
1027 scoreboard_t *scores;
1029 // keep track of svc_print parsing state (analyzes ping reports and status reports)
1030 cl_parsingtextmode_t parsingtextmode;
1031 int parsingtextplayerindex;
1032 // set by scoreboard code when sending ping command, this causes the next ping results to be hidden
1033 // (which could eat the wrong ping report if the player issues one
1034 // manually, but they would still see a ping report, just a later one
1035 // caused by the scoreboard code rather than the one they intentionally
1037 int parsingtextexpectingpingforscores;
1039 // entity database stuff
1040 // latest received entity frame numbers
1041 #define LATESTFRAMENUMS 3
1042 int latestframenums[LATESTFRAMENUMS];
1043 entityframe_database_t *entitydatabase;
1044 entityframe4_database_t *entitydatabase4;
1045 entityframeqw_database_t *entitydatabaseqw;
1047 // keep track of quake entities because they need to be killed if they get stale
1048 int lastquakeentity;
1049 unsigned char isquakeentity[MAX_EDICTS];
1051 // bounding boxes for clientside movement
1052 vec3_t playerstandmins;
1053 vec3_t playerstandmaxs;
1054 vec3_t playercrouchmins;
1055 vec3_t playercrouchmaxs;
1057 // old decals are killed based on this
1061 int max_csqcrenderentities;
1062 int max_static_entities;
1067 int max_brushmodel_entities;
1073 entity_render_t *csqcrenderentities;
1074 unsigned char *entities_active;
1075 entity_t *static_entities;
1076 cl_effect_t *effects;
1079 lightstyle_t *lightstyle;
1080 int *brushmodel_entities;
1081 particle_t *particles;
1083 showlmp_t *showlmps;
1086 int num_static_entities;
1087 int num_brushmodel_entities;
1095 double particles_updatetime;
1096 double decals_updatetime;
1100 // cl_serverextension_download feature
1101 int loadmodel_current;
1102 int downloadmodel_current;
1103 int loadmodel_total;
1104 int loadsound_current;
1105 int downloadsound_current;
1106 int loadsound_total;
1107 qboolean downloadcsqc;
1110 qboolean loadfinished;
1114 // local copy of the server infostring
1115 char qw_serverinfo[MAX_SERVERINFO_STRING];
1117 // time of last qw "pings" command sent to server while showing scores
1118 double last_ping_request;
1120 // used during connect
1123 // updated from serverinfo
1126 // unused: indicates whether the player is spectating
1127 // use cl.scores[cl.playerentity-1].qw_spectator instead
1128 //qboolean qw_spectator;
1130 // last time an input packet was sent
1131 double lastpackettime;
1133 // movement parameters for client prediction
1134 unsigned int moveflags;
1135 float movevars_wallfriction;
1136 float movevars_waterfriction;
1137 float movevars_friction;
1138 float movevars_timescale;
1139 float movevars_gravity;
1140 float movevars_stopspeed;
1141 float movevars_maxspeed;
1142 float movevars_spectatormaxspeed;
1143 float movevars_accelerate;
1144 float movevars_airaccelerate;
1145 float movevars_wateraccelerate;
1146 float movevars_entgravity;
1147 float movevars_jumpvelocity;
1148 float movevars_edgefriction;
1149 float movevars_maxairspeed;
1150 float movevars_stepheight;
1151 float movevars_airaccel_qw;
1152 float movevars_airaccel_sideways_friction;
1153 float movevars_airstopaccelerate;
1154 float movevars_airstrafeaccelerate;
1155 float movevars_maxairstrafespeed;
1156 float movevars_aircontrol;
1157 float movevars_warsowbunny_airforwardaccel;
1158 float movevars_warsowbunny_accel;
1159 float movevars_warsowbunny_topspeed;
1160 float movevars_warsowbunny_turnaccel;
1161 float movevars_warsowbunny_backtosideratio;
1162 float movevars_ticrate;
1164 // models used by qw protocol
1165 int qw_modelindex_spike;
1166 int qw_modelindex_player;
1167 int qw_modelindex_flag;
1168 int qw_modelindex_s_explod;
1170 vec3_t qw_intermission_origin;
1171 vec3_t qw_intermission_angles;
1173 // 255 is the most nails the QW protocol could send
1175 vec_t qw_nails[255][6];
1177 float qw_weaponkick;
1179 int qw_validsequence;
1181 int qw_deltasequence[QW_UPDATE_BACKUP];
1184 // server entity number corresponding to a clientside entity
1185 unsigned short csqc_server2csqcentitynumber[MAX_EDICTS];
1186 qboolean csqc_loaded;
1189 qboolean csqc_usecsqclistener;
1190 matrix4x4_t csqc_listenermatrix;
1191 char csqc_printtextbuf[MAX_INPUTLINE];
1193 // collision culling data
1196 // loc file stuff (points and boxes describing locations in the level)
1197 cl_locnode_t *locnodes;
1198 // this is updated to cl.movement_origin whenever health is < 1
1199 // used by %d print in say/say_team messages if cl_locs_enable is on
1200 vec3_t lastdeathorigin;
1202 // processing buffer used by R_BuildLightMap, reallocated as needed,
1203 // freed on each level change
1204 size_t buildlightmapmemorysize;
1205 unsigned char *buildlightmapmemory;
1212 extern cvar_t cl_name;
1213 extern cvar_t cl_color;
1214 extern cvar_t cl_rate;
1215 extern cvar_t cl_pmodel;
1216 extern cvar_t cl_playermodel;
1217 extern cvar_t cl_playerskin;
1219 extern cvar_t rcon_password;
1220 extern cvar_t rcon_address;
1222 extern cvar_t cl_upspeed;
1223 extern cvar_t cl_forwardspeed;
1224 extern cvar_t cl_backspeed;
1225 extern cvar_t cl_sidespeed;
1227 extern cvar_t cl_movespeedkey;
1229 extern cvar_t cl_yawspeed;
1230 extern cvar_t cl_pitchspeed;
1232 extern cvar_t cl_anglespeedkey;
1234 extern cvar_t cl_autofire;
1236 extern cvar_t cl_shownet;
1237 extern cvar_t cl_nolerp;
1238 extern cvar_t cl_nettimesyncfactor;
1239 extern cvar_t cl_nettimesyncboundmode;
1240 extern cvar_t cl_nettimesyncboundtolerance;
1242 extern cvar_t cl_pitchdriftspeed;
1243 extern cvar_t lookspring;
1244 extern cvar_t lookstrafe;
1245 extern cvar_t sensitivity;
1247 extern cvar_t freelook;
1249 extern cvar_t m_pitch;
1250 extern cvar_t m_yaw;
1251 extern cvar_t m_forward;
1252 extern cvar_t m_side;
1254 extern cvar_t cl_autodemo;
1255 extern cvar_t cl_autodemo_nameformat;
1257 extern cvar_t r_draweffects;
1259 extern cvar_t cl_explosions_alpha_start;
1260 extern cvar_t cl_explosions_alpha_end;
1261 extern cvar_t cl_explosions_size_start;
1262 extern cvar_t cl_explosions_size_end;
1263 extern cvar_t cl_explosions_lifetime;
1264 extern cvar_t cl_stainmaps;
1265 extern cvar_t cl_stainmaps_clearonload;
1267 extern cvar_t cl_prydoncursor;
1269 extern cvar_t cl_locs_enable;
1271 extern client_state_t cl;
1273 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);
1275 cl_locnode_t *CL_Locs_FindNearest(const vec3_t point);
1276 void CL_Locs_FindLocationName(char *buffer, size_t buffersize, vec3_t point);
1278 //=============================================================================
1284 void CL_Shutdown (void);
1285 void CL_Init (void);
1287 void CL_EstablishConnection(const char *host);
1289 void CL_Disconnect (void);
1290 void CL_Disconnect_f (void);
1292 void CL_UpdateRenderEntity(entity_render_t *ent);
1293 void CL_SetEntityColormapColors(entity_render_t *ent, int colormap);
1294 void CL_UpdateViewEntities(void);
1299 typedef struct kbutton_s
1301 int down[2]; // key nums holding it down
1302 int state; // low bit is down state
1306 extern kbutton_t in_mlook, in_klook;
1307 extern kbutton_t in_strafe;
1308 extern kbutton_t in_speed;
1310 void CL_InitInput (void);
1311 void CL_SendMove (void);
1313 void CL_ValidateState(entity_state_t *s);
1314 void CL_MoveLerpEntityStates(entity_t *ent);
1315 void CL_LerpUpdate(entity_t *e);
1316 void CL_ParseTEnt (void);
1317 void CL_NewBeam (int ent, vec3_t start, vec3_t end, dp_model_t *m, int lightning);
1318 void CL_RelinkBeams (void);
1319 void CL_Beam_CalculatePositions (const beam_t *b, vec3_t start, vec3_t end);
1320 void CL_ClientMovement_Replay(void);
1322 void CL_ClearTempEntities (void);
1323 entity_render_t *CL_NewTempEntity (double shadertime);
1325 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
1327 void CL_ClearState (void);
1328 void CL_ExpandEntities(int num);
1329 void CL_ExpandCSQCRenderEntities(int num);
1330 void CL_SetInfo(const char *key, const char *value, qboolean send, qboolean allowstarkey, qboolean allowmodel, qboolean quiet);
1333 void CL_UpdateWorld (void);
1334 void CL_WriteToServer (void);
1335 void CL_Input (void);
1336 extern int cl_ignoremousemoves;
1339 float CL_KeyState (kbutton_t *key);
1340 const char *Key_KeynumToString (int keynum);
1341 int Key_StringToKeynum (const char *str);
1346 void CL_StopPlayback(void);
1347 void CL_ReadDemoMessage(void);
1348 void CL_WriteDemoMessage(sizebuf_t *mesage);
1350 void CL_CutDemo(unsigned char **buf, fs_offset_t *filesize);
1351 void CL_PasteDemo(unsigned char **buf, fs_offset_t *filesize);
1353 void CL_NextDemo(void);
1354 void CL_Stop_f(void);
1355 void CL_Record_f(void);
1356 void CL_PlayDemo_f(void);
1357 void CL_TimeDemo_f(void);
1362 void CL_Parse_Init(void);
1363 void CL_Parse_Shutdown(void);
1364 void CL_ParseServerMessage(void);
1365 void CL_Parse_DumpPacket(void);
1366 void CL_Parse_ErrorCleanUp(void);
1367 void QW_CL_StartUpload(unsigned char *data, int size);
1368 extern cvar_t qport;
1369 void CL_KeepaliveMessage(qboolean readmessages); // call this during loading of large content
1374 void V_StartPitchDrift (void);
1375 void V_StopPitchDrift (void);
1378 float V_CalcRoll (vec3_t angles, vec3_t velocity);
1379 void V_UpdateBlends (void);
1380 void V_ParseDamage (void);
1386 extern cvar_t cl_particles;
1387 extern cvar_t cl_particles_quality;
1388 extern cvar_t cl_particles_size;
1389 extern cvar_t cl_particles_quake;
1390 extern cvar_t cl_particles_blood;
1391 extern cvar_t cl_particles_blood_alpha;
1392 extern cvar_t cl_particles_blood_bloodhack;
1393 extern cvar_t cl_particles_bulletimpacts;
1394 extern cvar_t cl_particles_explosions_sparks;
1395 extern cvar_t cl_particles_explosions_shell;
1396 extern cvar_t cl_particles_rain;
1397 extern cvar_t cl_particles_snow;
1398 extern cvar_t cl_particles_smoke;
1399 extern cvar_t cl_particles_smoke_alpha;
1400 extern cvar_t cl_particles_smoke_alphafade;
1401 extern cvar_t cl_particles_sparks;
1402 extern cvar_t cl_particles_bubbles;
1403 extern cvar_t cl_decals;
1404 extern cvar_t cl_decals_time;
1405 extern cvar_t cl_decals_fadetime;
1407 void CL_Particles_Clear(void);
1408 void CL_Particles_Init(void);
1409 void CL_Particles_Shutdown(void);
1410 particle_t *CL_NewParticle(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);
1412 typedef enum effectnameindex_s
1416 EFFECT_TE_GUNSHOTQUAD,
1418 EFFECT_TE_SPIKEQUAD,
1419 EFFECT_TE_SUPERSPIKE,
1420 EFFECT_TE_SUPERSPIKEQUAD,
1422 EFFECT_TE_KNIGHTSPIKE,
1423 EFFECT_TE_EXPLOSION,
1424 EFFECT_TE_EXPLOSIONQUAD,
1425 EFFECT_TE_TAREXPLOSION,
1427 EFFECT_TE_LAVASPLASH,
1428 EFFECT_TE_SMALLFLASH,
1433 EFFECT_TE_PLASMABURN,
1435 EFFECT_TE_TEI_SMOKE,
1436 EFFECT_TE_TEI_BIGEXPLOSION,
1437 EFFECT_TE_TEI_PLASMAHIT,
1443 EFFECT_TR_SLIGHTBLOOD,
1444 EFFECT_TR_KNIGHTSPIKE,
1445 EFFECT_TR_VORESPIKE,
1446 EFFECT_TR_NEHAHRASMOKE,
1447 EFFECT_TR_NEXUIZPLASMA,
1448 EFFECT_TR_GLOWTRAIL,
1449 EFFECT_SVC_PARTICLE,
1454 int CL_ParticleEffectIndexForName(const char *name);
1455 const char *CL_ParticleEffectNameForIndex(int i);
1456 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);
1457 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);
1458 void CL_ParseParticleEffect (void);
1459 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);
1460 void CL_ParticleRain (const vec3_t mins, const vec3_t maxs, const vec3_t dir, int count, int colorbase, int type);
1461 void CL_EntityParticles (const entity_t *ent);
1462 void CL_ParticleExplosion (const vec3_t org);
1463 void CL_ParticleExplosion2 (const vec3_t org, int colorStart, int colorLength);
1464 void R_NewExplosion(const vec3_t org);
1466 void Debug_PolygonBegin(const char *picname, int flags);
1467 void Debug_PolygonVertex(float x, float y, float z, float s, float t, float r, float g, float b, float a);
1468 void Debug_PolygonEnd(void);
1470 #include "cl_screen.h"
1472 extern qboolean sb_showscores;
1474 float RSurf_FogVertex(const vec3_t p);
1475 float RSurf_FogPoint(const vec3_t p);
1477 typedef struct r_refdef_stats_s
1481 int entities_surfaces;
1482 int entities_triangles;
1486 int world_triangles;
1487 int lightmapupdates;
1488 int lightmapupdatepixels;
1493 int meshes_elements;
1496 int lights_scissored;
1497 int lights_lighttriangles;
1498 int lights_shadowtriangles;
1499 int lights_dynamicshadowtriangles;
1501 int bloom_copypixels;
1502 int bloom_drawpixels;
1506 typedef enum r_viewport_type_e
1508 R_VIEWPORTTYPE_ORTHO,
1509 R_VIEWPORTTYPE_PERSPECTIVE,
1510 R_VIEWPORTTYPE_PERSPECTIVE_INFINITEFARCLIP,
1511 R_VIEWPORTTYPE_PERSPECTIVECUBESIDE,
1512 R_VIEWPORTTYPE_TOTAL
1516 typedef struct r_viewport_s
1519 matrix4x4_t cameramatrix; // from entity (transforms from camera entity to world)
1520 matrix4x4_t viewmatrix; // actual matrix for rendering (transforms to viewspace)
1521 matrix4x4_t projectmatrix; // actual projection matrix (transforms from viewspace to screen)
1528 r_viewport_type_t type;
1532 typedef struct r_refdef_view_s
1534 // view information (changes multiple times per frame)
1535 // if any of these variables change then r_refdef.viewcache must be regenerated
1536 // by calling R_View_Update
1537 // (which also updates viewport, scissor, colormask)
1539 // it is safe and expected to copy this into a structure on the stack and
1540 // call the renderer recursively, then restore from the stack afterward
1541 // (as long as R_View_Update is called)
1543 // eye position information
1544 matrix4x4_t matrix, inverse_matrix;
1550 int numfrustumplanes;
1551 mplane_t frustum[6];
1552 qboolean useclipplane;
1553 qboolean usecustompvs; // uses r_refdef.viewcache.pvsbits as-is rather than computing it
1555 float frustum_x, frustum_y;
1556 vec3_t frustumcorner[4];
1557 // if turned off it renders an ortho view
1559 float ortho_x, ortho_y;
1561 // screen area to render in
1568 r_viewport_t viewport;
1570 // which color components to allow (for anaglyph glasses)
1573 // global RGB color multiplier for rendering, this is required by HDR
1576 // whether to call R_ClearScreen before rendering stuff
1578 // if true, don't clear or do any post process effects (bloom, etc)
1581 // whether to draw r_showtris and such, this is only true for the main
1582 // view render, all secondary renders (HDR, mirrors, portals, cameras,
1583 // distortion effects, etc) omit such debugging information
1586 // these define which values to use in GL_CullFace calls to request frontface or backface culling
1590 // render quality (0 to 1) - affects r_drawparticles_drawdistance and others
1595 typedef struct r_refdef_viewcache_s
1597 // updated by gl_main_newmap()
1599 int world_numclusters;
1600 int world_numclusterbytes;
1602 int world_numsurfaces;
1604 // these properties are generated by R_View_Update()
1606 // which entities are currently visible for this viewpoint
1607 // (the used range is 0...r_refdef.scene.numentities)
1608 unsigned char *entityvisible;
1610 // flag arrays used for visibility checking on world model
1611 // (all other entities have no per-surface/per-leaf visibility checks)
1612 unsigned char *world_pvsbits;
1613 unsigned char *world_leafvisible;
1614 unsigned char *world_surfacevisible;
1615 // if true, the view is currently in a leaf without pvs data
1616 qboolean world_novis;
1618 r_refdef_viewcache_t;
1620 // TODO: really think about which fields should go into scene and which one should stay in refdef [1/7/2008 Black]
1621 // maybe also refactor some of the functions to support different setting sources (ie. fogenabled, etc.) for different scenes
1622 typedef struct r_refdef_scene_s {
1623 // whether to call S_ExtraUpdate during render to reduce sound chop
1624 qboolean extraupdate;
1626 // (client gameworld) time for rendering time based effects
1630 entity_render_t *worldentity;
1632 // same as worldentity->model
1633 dp_model_t *worldmodel;
1635 // renderable entities (excluding world)
1636 entity_render_t **entities;
1640 // field of temporary entities that is reset each (client) frame
1641 entity_render_t *tempentities;
1642 int numtempentities;
1643 int maxtempentities;
1645 // renderable dynamic lights
1646 rtlight_t *lights[MAX_DLIGHTS];
1647 rtlight_t templights[MAX_DLIGHTS];
1650 // intensities for light styles right now, controls rtlights
1651 float rtlightstylevalue[MAX_LIGHTSTYLES]; // float fraction of base light value
1652 // 8.8bit fixed point intensities for light styles
1653 // controls intensity lightmap layers
1654 unsigned short lightstylevalue[MAX_LIGHTSTYLES]; // 8.8 fraction of base light value
1659 qboolean rtworldshadows;
1661 qboolean rtdlightshadows;
1664 typedef struct r_refdef_s
1666 // these fields define the basic rendering information for the world
1667 // but not the view, which could change multiple times in one rendered
1668 // frame (for example when rendering textures for certain effects)
1670 // these are set for water warping before
1671 // frustum_x/frustum_y are calculated
1672 float frustumscale_x, frustumscale_y;
1674 // current view settings (these get reset a few times during rendering because of water rendering, reflections, etc)
1675 r_refdef_view_t view;
1676 r_refdef_viewcache_t viewcache;
1678 // minimum visible distance (pixels closer than this disappear)
1680 // maximum visible distance (pixels further than this disappear in 16bpp modes,
1681 // in 32bpp an infinite-farclip matrix is used instead)
1684 // fullscreen color blend
1687 r_refdef_scene_t scene;
1690 float fogplaneviewdist;
1691 qboolean fogplaneviewabove;
1692 float fogheightfade;
1695 float fograngerecip;
1696 float fogmasktabledistmultiplier;
1697 #define FOGMASKTABLEWIDTH 1024
1698 float fogmasktable[FOGMASKTABLEWIDTH];
1699 float fogmasktable_start, fogmasktable_alpha, fogmasktable_range, fogmasktable_density;
1708 float fog_fadedepth;
1709 qboolean fogenabled;
1710 qboolean oldgl_fogenable;
1712 qboolean draw2dstage;
1714 // true during envmap command capture
1717 // brightness of world lightmaps and related lighting
1718 // (often reduced when world rtlights are enabled)
1719 float lightmapintensity;
1720 // whether to draw world lights realtime, dlights realtime, and their shadows
1721 float polygonfactor;
1722 float polygonoffset;
1723 float shadowpolygonfactor;
1724 float shadowpolygonoffset;
1726 // rendering stats for r_speeds display
1727 // (these are incremented in many places)
1728 r_refdef_stats_t stats;
1732 extern r_refdef_t r_refdef;