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 ==============================================================================
29 ==============================================================================
34 // in memory representation
48 typedef struct mplane_s
52 // for texture axis selection and fast side tests
58 #define SHADERSTAGE_SKY 0
59 #define SHADERSTAGE_NORMAL 1
60 #define SHADERSTAGE_COUNT 2
62 #define SURF_PLANEBACK 2
63 #define SURF_DRAWSKY 4
64 #define SURF_DRAWTURB 0x10
65 #define SURF_LIGHTMAP 0x20
66 #define SURF_DRAWNOALPHA 0x100
67 #define SURF_DRAWFULLBRIGHT 0x200
68 #define SURF_LIGHTBOTHSIDES 0x400
69 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
70 #define SURF_SOLIDCLIP 0x8000 // this polygon blocks movement
72 #define SURFRENDER_OPAQUE 0
73 #define SURFRENDER_ALPHA 1
74 #define SURFRENDER_ADD 2
76 struct entity_render_s;
80 typedef struct texture_s
85 unsigned int width, height;
89 // position in the model's textures array
92 // type of rendering (SURFRENDER_ value)
95 // loaded the same as model skins
98 // total frames in sequence and alternate sequence
100 // direct pointers to each of the frames in the sequences
101 // (indexed as [alternate][frame])
102 struct texture_s *anim_frames[2][10];
103 // set if animated or there is an alternate frame set
104 // (this is an optimization in the renderer)
106 // the current texture frame in animation
107 struct texture_s *currentframe;
108 // current alpha of the texture
127 typedef struct msurface_s
129 // bounding box for onscreen checks
133 // the node plane this is on, backwards if SURF_PLANEBACK flag set
137 // texture mapping properties used by this surface
140 // the lightmap texture fragment to use on the rendering mesh
141 rtexture_t *lightmaptexture;
142 // mesh for rendering
144 // if lightmap settings changed, this forces update
147 // surface number, to avoid having to do a divide to find the number of a surface from it's address
150 // center for sorting transparent meshes
153 // index into d_lightstylevalue array, 255 means not used (black)
154 qbyte styles[MAXLIGHTMAPS];
155 // RGB lighting data [numstyles][height][width][3]
157 // stain to apply on lightmap (soot/dirt/blood/whatever)
159 // the stride when building lightmaps to comply with fragment update
160 int lightmaptexturestride;
164 // if this == r_framecount there are dynamic lights on the surface
166 // which dynamic lights are touching this surface
167 // (only access this if dlightframe is current)
169 // avoid redundent addition of dlights
172 // avoid multiple collision traces with a surface polygon
175 // these are just 3D points defining the outline of the polygon,
176 // no texcoord info (that can be generated from these)
180 // index into model->brush.shadowmesh
181 int num_firstshadowmeshtriangle;
183 // neighboring surfaces (one per poly_numverts)
184 //struct msurface_s **neighborsurfaces;
185 // currently used only for generating static shadow volumes
186 int lighttemp_castshadow;
188 // avoid redundent surface shadows
193 typedef struct mnode_s
195 //this part shared between node and leaf
196 mplane_t *plane; // != NULL
197 struct mnode_s *parent;
198 struct mportal_s *portals;
199 // for bounding box culling
203 // this part unique to node
204 struct mnode_s *children[2];
205 unsigned short firstsurface;
206 unsigned short numsurfaces;
210 typedef struct mleaf_s
212 //this part shared between node and leaf
213 mplane_t *plane; // == NULL
214 struct mnode_s *parent;
215 struct mportal_s *portals;
216 // for bounding box culling
220 // this part unique to leaf
221 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
222 int contents; // TODO: remove (only used temporarily during loading when making collision hull 0)
223 int *firstmarksurface;
225 qbyte ambient_sound_level[NUM_AMBIENTS];
226 int portalmarkid; // used by see-polygon-through-portals visibility checker
232 dclipnode_t *clipnodes;
242 typedef struct mportal_s
244 struct mportal_s *next; // the next portal on this leaf
245 mleaf_t *here; // the leaf this portal is on
246 mleaf_t *past; // the leaf through this portal (infront)
249 vec3_t mins, maxs; // culling
254 typedef struct svbspmesh_s
256 struct svbspmesh_s *next;
257 int numverts, maxverts;
258 int numtriangles, maxtriangles;
264 typedef struct mlight_s
268 // distance attenuation scale (smaller is a larger light)
270 // color and brightness combined
272 // brightness bias, used for limiting radius without a hard edge
274 // spotlight direction
276 // cosine of spotlight cone angle (or 0 if not a spotlight)
278 // distance bias (larger value is softer and darker)
280 // light style controlling this light
282 // maximum extent of the light for shading purposes
284 // maximum extent of the light for culling purposes
288 // surfaces this shines on
290 msurface_t **surfaces;
293 // precomputed shadow volume meshs
294 //svbspmesh_t *shadowvolume;
295 //vec3_t shadowvolumemins, shadowvolumemaxs;
296 shadowmesh_t *shadowvolume;
301 extern rtexture_t *r_notexture;
302 extern texture_t r_notexture_mip;
305 void Mod_Q1BSP_Load(struct model_s *mod, void *buffer);
306 void Mod_IBSP_Load(struct model_s *mod, void *buffer);
307 void Mod_MAP_Load(struct model_s *mod, void *buffer);
308 void Mod_BrushInit(void);
312 #define Q2BSPVERSION 38
314 // leaffaces, leafbrushes, planes, and verts are still bounded by
315 // 16 bit short limits
317 //=============================================================================
319 #define Q2LUMP_ENTITIES 0
320 #define Q2LUMP_PLANES 1
321 #define Q2LUMP_VERTEXES 2
322 #define Q2LUMP_VISIBILITY 3
323 #define Q2LUMP_NODES 4
324 #define Q2LUMP_TEXINFO 5
325 #define Q2LUMP_FACES 6
326 #define Q2LUMP_LIGHTING 7
327 #define Q2LUMP_LEAFS 8
328 #define Q2LUMP_LEAFFACES 9
329 #define Q2LUMP_LEAFBRUSHES 10
330 #define Q2LUMP_EDGES 11
331 #define Q2LUMP_SURFEDGES 12
332 #define Q2LUMP_MODELS 13
333 #define Q2LUMP_BRUSHES 14
334 #define Q2LUMP_BRUSHSIDES 15
335 #define Q2LUMP_POP 16
336 #define Q2LUMP_AREAS 17
337 #define Q2LUMP_AREAPORTALS 18
338 #define Q2HEADER_LUMPS 19
344 lump_t lumps[HEADER_LUMPS];
349 float mins[3], maxs[3];
350 float origin[3]; // for sounds or lights
352 int firstface, numfaces; // submodels just draw faces
353 // without walking the bsp tree
356 // planes (x&~1) and (x&~1)+1 are always opposites
358 // contents flags are seperate bits
359 // a given brush can contribute multiple content bits
360 // multiple brushes can be in a single leaf
362 // these definitions also need to be in q_shared.h!
364 // lower bits are stronger, and will eat weaker brushes completely
365 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
366 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
367 #define Q2CONTENTS_AUX 4
368 #define Q2CONTENTS_LAVA 8
369 #define Q2CONTENTS_SLIME 16
370 #define Q2CONTENTS_WATER 32
371 #define Q2CONTENTS_MIST 64
372 #define Q2LAST_VISIBLE_CONTENTS 64
374 // remaining contents are non-visible, and don't eat brushes
376 #define Q2CONTENTS_AREAPORTAL 0x8000
378 #define Q2CONTENTS_PLAYERCLIP 0x10000
379 #define Q2CONTENTS_MONSTERCLIP 0x20000
381 // currents can be added to any other contents, and may be mixed
382 #define Q2CONTENTS_CURRENT_0 0x40000
383 #define Q2CONTENTS_CURRENT_90 0x80000
384 #define Q2CONTENTS_CURRENT_180 0x100000
385 #define Q2CONTENTS_CURRENT_270 0x200000
386 #define Q2CONTENTS_CURRENT_UP 0x400000
387 #define Q2CONTENTS_CURRENT_DOWN 0x800000
389 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
391 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
392 #define Q2CONTENTS_DEADMONSTER 0x4000000
393 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
394 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
395 #define Q2CONTENTS_LADDER 0x20000000
399 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
401 #define Q2SURF_SLICK 0x2 // effects game physics
403 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
404 #define Q2SURF_WARP 0x8 // turbulent water warp
405 #define Q2SURF_TRANS33 0x10
406 #define Q2SURF_TRANS66 0x20
407 #define Q2SURF_FLOWING 0x40 // scroll towards angle
408 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
416 int children[2]; // negative numbers are -(leafs+1), not nodes
417 short mins[3]; // for frustom culling
419 unsigned short firstface;
420 unsigned short numfaces; // counting both sides
426 float vecs[2][4]; // [s/t][xyz offset]
427 int flags; // miptex flags + overrides
428 int value; // light emission, etc
429 char texture[32]; // texture name (textures/*.wal)
430 int nexttexinfo; // for animations, -1 = end of chain
435 int contents; // OR of all brushes (not needed?)
440 short mins[3]; // for frustum culling
443 unsigned short firstleafface;
444 unsigned short numleaffaces;
446 unsigned short firstleafbrush;
447 unsigned short numleafbrushes;
452 unsigned short planenum; // facing out of the leaf
464 // the visibility lump consists of a header with a count, then
465 // byte offsets for the PVS and PHS of each cluster, then the raw
466 // compressed bit vectors
472 int bitofs[8][2]; // bitofs[numclusters][2]
475 // each area has a list of portals that lead into other areas
476 // when portals are closed, other areas may not be visible or
477 // hearable even if the vis info says that it should be
493 #define Q3BSPVERSION 46
495 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
496 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
497 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
498 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
499 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
500 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
501 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
502 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
503 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
504 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
505 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
506 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
507 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
508 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
509 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
510 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
511 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
512 #define Q3HEADER_LUMPS 17
514 #define Q3PATHLENGTH 64
520 lump_t lumps[HEADER_LUMPS];
525 char name[Q3PATHLENGTH];
531 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
542 int childrenindex[2];
550 int clusterindex; // pvs index
551 int areaindex; // area index
593 unsigned char color4ub[4];
599 int offset; // first vertex index of mesh
605 char shadername[Q3PATHLENGTH];
607 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
611 #define Q3FACETYPE_POLYGON 1 // common
612 #define Q3FACETYPE_PATCH 2 // common
613 #define Q3FACETYPE_MESH 3 // common
614 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
619 int effectindex; // -1 if none
620 int type; // Q3FACETYPE
625 int lightmapindex; // -1 if none
626 int lightmap_base[2];
627 int lightmap_size[2];
632 // corrupt or don't care
638 // Q3FACETYPE_POLYGON
639 // polygon is simply a convex polygon, renderable as a mesh
640 float lightmap_origin[3];
641 float lightmap_vectors[2][3];
649 // patch renders as a bezier mesh, with adjustable tesselation
650 // level (optionally based on LOD using the bbox and polygon
651 // count to choose a tesselation level)
652 // note: multiple patches may have the same bbox to cause them to
653 // be LOD adjusted together as a group
655 float mins[3]; // LOD bbox
656 float maxs[3]; // LOD bbox
658 int patchsize[2]; // dimensions of vertex grid
664 // mesh renders as simply a triangle mesh
674 // flare renders as a simple sprite at origin, no geometry
675 // exists, nor does it have a radius, a cvar controls the radius
676 // and another cvar controls distance fade
677 // (they were not used in Q3 I'm told)
689 unsigned char rgb[128*128*3];
695 unsigned char ambientrgb[3];
696 unsigned char diffusergb[3];
697 unsigned char diffusepitch;
698 unsigned char diffuseyaw;
706 // unsigned char chains[];
707 // containing bits in 0-7 order (not 7-0 order),
708 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
712 // surfaceflags from bsp
713 #define Q3SURFACEFLAG_NODAMAGE 1
714 #define Q3SURFACEFLAG_SLICK 2
715 #define Q3SURFACEFLAG_SKY 4
716 #define Q3SURFACEFLAG_LADDER 8
717 #define Q3SURFACEFLAG_NOIMPACT 16
718 #define Q3SURFACEFLAG_NOMARKS 32
719 #define Q3SURFACEFLAG_FLESH 64
720 #define Q3SURFACEFLAG_NODRAW 128
721 #define Q3SURFACEFLAG_HINT 256
722 #define Q3SURFACEFLAG_SKIP 512
723 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
724 #define Q3SURFACEFLAG_POINTLIGHT 2048
725 #define Q3SURFACEFLAG_METALSTEPS 4096
726 #define Q3SURFACEFLAG_NOSTEPS 8192
727 #define Q3SURFACEFLAG_NONSOLID 16384
728 #define Q3SURFACEFLAG_LIGHTFILTER 32768
729 #define Q3SURFACEFLAG_ALPHASHADOW 65536
730 #define Q3SURFACEFLAG_NODLIGHT 131072
731 #define Q3SURFACEFLAG_DUST 262144
733 // surfaceparms from shaders
734 #define Q3SURFACEPARM_ALPHASHADOW 1
735 #define Q3SURFACEPARM_AREAPORTAL 2
736 #define Q3SURFACEPARM_CLUSTERPORTAL 4
737 #define Q3SURFACEPARM_DETAIL 8
738 #define Q3SURFACEPARM_DONOTENTER 16
739 #define Q3SURFACEPARM_FOG 32
740 #define Q3SURFACEPARM_LAVA 64
741 #define Q3SURFACEPARM_LIGHTFILTER 128
742 #define Q3SURFACEPARM_METALSTEPS 256
743 #define Q3SURFACEPARM_NODAMAGE 512
744 #define Q3SURFACEPARM_NODLIGHT 1024
745 #define Q3SURFACEPARM_NODRAW 2048
746 #define Q3SURFACEPARM_NODROP 4096
747 #define Q3SURFACEPARM_NOIMPACT 8192
748 #define Q3SURFACEPARM_NOLIGHTMAP 16384
749 #define Q3SURFACEPARM_NOMARKS 32768
750 #define Q3SURFACEPARM_NOMIPMAPS 65536
751 #define Q3SURFACEPARM_NONSOLID 131072
752 #define Q3SURFACEPARM_ORIGIN 262144
753 #define Q3SURFACEPARM_PLAYERCLIP 524288
754 #define Q3SURFACEPARM_SKY 1048576
755 #define Q3SURFACEPARM_SLICK 2197152
756 #define Q3SURFACEPARM_SLIME 4194304
757 #define Q3SURFACEPARM_STRUCTURAL 8388608
758 #define Q3SURFACEPARM_TRANS 16777216
759 #define Q3SURFACEPARM_WATER 33554432
760 #define Q3SURFACEPARM_POINTLIGHT 67108864
762 // various flags from shaders
763 #define Q3TEXTUREFLAG_TWOSIDED 1
764 #define Q3TEXTUREFLAG_ADDITIVE 2
765 #define Q3TEXTUREFLAG_NOMIPMAPS 4
766 #define Q3TEXTUREFLAG_NOPICMIP 8
767 #define Q3TEXTUREFLAG_AUTOSPRITE 16
768 #define Q3TEXTUREFLAG_AUTOSPRITE2 32
769 #define Q3TEXTUREFLAG_ALPHATEST 64
772 typedef struct q3mtexture_s
774 char name[Q3PATHLENGTH];
775 char firstpasstexturename[Q3PATHLENGTH];
785 struct q3msurface_s **facelist;
790 typedef struct q3mnode_s
792 //this part shared between node and leaf
793 struct mplane_s *plane; // != NULL
794 struct q3mnode_s *parent;
798 // this part unique to node
799 struct q3mnode_s *children[2];
803 typedef struct q3mleaf_s
805 //this part shared between node and leaf
806 struct mplane_s *plane; // == NULL
807 struct q3mnode_s *parent;
811 // this part unique to leaf
812 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
821 typedef struct q3mmodel_s
826 struct q3msurface_s *firstface;
828 struct q3mbrush_s *firstbrush;
832 typedef struct q3mbrush_s
834 struct colbrushf_s *colbrushf;
836 struct q3mbrushside_s *firstbrushside;
837 struct q3mtexture_s *texture;
841 typedef struct q3mbrushside_s
843 struct mplane_s *plane;
844 struct q3mtexture_s *texture;
848 typedef struct q3meffect_s
850 char shadername[Q3PATHLENGTH];
851 struct q3mbrush_s *brush;
852 int unknown; // 5 or -1
856 typedef struct q3msurface_s
858 // FIXME: collisionmarkframe should be kept in a separate array
859 // FIXME: shadowmark should be kept in a separate array
861 struct q3mtexture_s *texture;
862 struct q3meffect_s *effect;
863 rtexture_t *lightmaptexture;
864 int collisionmarkframe; // don't collide twice in one trace
865 // bounding box for culling
871 // index into model->brush.shadowmesh
872 int num_firstshadowmeshtriangle;
874 // used for shadow volume generation
879 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
880 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
881 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)