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 ==============================================================================
32 #define Q3PATHLENGTH 64
36 // in memory representation
50 typedef struct mplane_s
54 // for texture axis selection and fast side tests
60 #define SHADERSTAGE_SKY 0
61 #define SHADERSTAGE_NORMAL 1
62 #define SHADERSTAGE_COUNT 2
64 //#define SURF_PLANEBACK 2
66 // set for anything to be transparent sorted
67 #define MATERIALFLAG_TRANSPARENT 1
68 // use alpha blend on this material
69 #define MATERIALFLAG_ALPHA 2
70 // use additive blend on this material
71 #define MATERIALFLAG_ADD 4
72 // turn off depth test on this material
73 #define MATERIALFLAG_NODEPTHTEST 8
74 // multiply alpha by r_wateralpha cvar
75 #define MATERIALFLAG_WATERALPHA 16
76 // draw with no lighting
77 #define MATERIALFLAG_FULLBRIGHT 32
78 // drawn as a normal lightmapped wall
79 #define MATERIALFLAG_WALL 64
80 // swirling water effect
81 #define MATERIALFLAG_WATER 128
82 // this surface shows the sky
83 // skipped if transparent
84 #define MATERIALFLAG_SKY 256
85 // skips drawing the surface
86 #define MATERIALFLAG_NODRAW 512
87 // probably used only on q1bsp water
88 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
90 struct entity_render_s;
94 typedef struct texture_s
100 unsigned int width, height;
102 //unsigned int flags;
104 // base material flags
105 int basematerialflags;
106 // current material flags (updated each bmodel render)
107 int currentmaterialflags;
109 // loaded the same as model skins
112 // total frames in sequence and alternate sequence
114 // direct pointers to each of the frames in the sequences
115 // (indexed as [alternate][frame])
116 struct texture_s *anim_frames[2][10];
117 // set if animated or there is an alternate frame set
118 // (this is an optimization in the renderer)
120 // the current texture frame in animation
121 struct texture_s *currentframe;
122 // current alpha of the texture
126 char name[Q3PATHLENGTH];
127 char firstpasstexturename[Q3PATHLENGTH]; // used only during loading
151 typedef struct msurface_lightmapinfo_s
153 // texture mapping properties used by this surface
154 mtexinfo_t *texinfo; // q1bsp
155 // index into d_lightstylevalue array, 255 means not used (black)
156 qbyte styles[MAXLIGHTMAPS]; // q1bsp
157 // RGB lighting data [numstyles][height][width][3]
158 qbyte *samples; // q1bsp
159 // stain to apply on lightmap (soot/dirt/blood/whatever)
160 qbyte *stainsamples; // q1bsp
161 // the stride when building lightmaps to comply with fragment update
162 int lightmaptexturestride; // q1bsp
163 int texturemins[2]; // q1bsp
164 int extents[2]; // q1bsp
166 msurface_lightmapinfo_t;
169 typedef struct msurface_s
171 // bounding box for onscreen checks
174 // the texture to use on the surface
176 // the lightmap texture fragment to use on the rendering mesh
177 rtexture_t *lightmaptexture;
179 // this surface is part of this mesh
180 surfmesh_t *groupmesh;
181 int num_triangles; // number of triangles in the mesh
182 int num_firsttriangle; // first triangle in the mesh (index into groupmesh)
183 int num_vertices; // number of vertices in the mesh
184 int num_firstvertex; // first vertex in the mesh (index into groupmesh)
186 // shadow volume building information
187 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
189 // lightmaptexture rebuild information not used in q3bsp
190 int cached_dlight; // q1bsp // forces rebuild of lightmaptexture
191 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
193 // mesh information for collisions (only used by q3bsp curves)
194 int num_collisiontriangles; // q3bsp
195 int *data_collisionelement3i; // q3bsp
196 int num_collisionvertices; // q3bsp
197 float *data_collisionvertex3f; // q3bsp
198 struct q3deffect_s *effect; // q3bsp
199 // FIXME: collisionmarkframe should be kept in a separate array
200 int collisionmarkframe; // q3bsp // don't collide twice in one trace
204 typedef struct mnode_s
206 //this part shared between node and leaf
207 mplane_t *plane; // != NULL
208 struct mnode_s *parent;
209 struct mportal_s *portals;
210 // for bounding box culling
214 // this part unique to node
215 struct mnode_s *children[2];
218 unsigned short firstsurface;
219 unsigned short numsurfaces;
223 typedef struct mleaf_s
225 //this part shared between node and leaf
226 mplane_t *plane; // == NULL
227 struct mnode_s *parent;
228 struct mportal_s *portals;
229 // for bounding box culling
233 // this part unique to leaf
235 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
236 int areaindex; // q3bsp
238 int *firstleafsurface;
239 int numleafbrushes; // q3bsp
240 int *firstleafbrush; // q3bsp
241 qbyte ambient_sound_level[NUM_AMBIENTS]; // q1bsp
242 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
243 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
249 dclipnode_t *clipnodes;
259 typedef struct mportal_s
261 struct mportal_s *next; // the next portal on this leaf
262 mleaf_t *here; // the leaf this portal is on
263 mleaf_t *past; // the leaf through this portal (infront)
266 vec3_t mins, maxs; // culling
271 typedef struct svbspmesh_s
273 struct svbspmesh_s *next;
274 int numverts, maxverts;
275 int numtriangles, maxtriangles;
281 typedef struct mlight_s
285 // distance attenuation scale (smaller is a larger light)
287 // color and brightness combined
289 // brightness bias, used for limiting radius without a hard edge
291 // spotlight direction
293 // cosine of spotlight cone angle (or 0 if not a spotlight)
295 // distance bias (larger value is softer and darker)
297 // light style controlling this light
299 // maximum extent of the light for shading purposes
301 // maximum extent of the light for culling purposes
305 // surfaces this shines on
307 msurface_t **surfaces;
310 // precomputed shadow volume meshs
311 //svbspmesh_t *shadowvolume;
312 //vec3_t shadowvolumemins, shadowvolumemaxs;
313 shadowmesh_t *shadowvolume;
319 void Mod_Q1BSP_Load(struct model_s *mod, void *buffer);
320 void Mod_IBSP_Load(struct model_s *mod, void *buffer);
321 void Mod_MAP_Load(struct model_s *mod, void *buffer);
322 void Mod_BrushInit(void);
326 #define Q2BSPVERSION 38
328 // leaffaces, leafbrushes, planes, and verts are still bounded by
329 // 16 bit short limits
331 //=============================================================================
333 #define Q2LUMP_ENTITIES 0
334 #define Q2LUMP_PLANES 1
335 #define Q2LUMP_VERTEXES 2
336 #define Q2LUMP_VISIBILITY 3
337 #define Q2LUMP_NODES 4
338 #define Q2LUMP_TEXINFO 5
339 #define Q2LUMP_FACES 6
340 #define Q2LUMP_LIGHTING 7
341 #define Q2LUMP_LEAFS 8
342 #define Q2LUMP_LEAFFACES 9
343 #define Q2LUMP_LEAFBRUSHES 10
344 #define Q2LUMP_EDGES 11
345 #define Q2LUMP_SURFEDGES 12
346 #define Q2LUMP_MODELS 13
347 #define Q2LUMP_BRUSHES 14
348 #define Q2LUMP_BRUSHSIDES 15
349 #define Q2LUMP_POP 16
350 #define Q2LUMP_AREAS 17
351 #define Q2LUMP_AREAPORTALS 18
352 #define Q2HEADER_LUMPS 19
358 lump_t lumps[HEADER_LUMPS];
363 float mins[3], maxs[3];
364 float origin[3]; // for sounds or lights
366 int firstface, numfaces; // submodels just draw faces
367 // without walking the bsp tree
370 // planes (x&~1) and (x&~1)+1 are always opposites
372 // contents flags are seperate bits
373 // a given brush can contribute multiple content bits
374 // multiple brushes can be in a single leaf
376 // these definitions also need to be in q_shared.h!
378 // lower bits are stronger, and will eat weaker brushes completely
379 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
380 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
381 #define Q2CONTENTS_AUX 4
382 #define Q2CONTENTS_LAVA 8
383 #define Q2CONTENTS_SLIME 16
384 #define Q2CONTENTS_WATER 32
385 #define Q2CONTENTS_MIST 64
386 #define Q2LAST_VISIBLE_CONTENTS 64
388 // remaining contents are non-visible, and don't eat brushes
390 #define Q2CONTENTS_AREAPORTAL 0x8000
392 #define Q2CONTENTS_PLAYERCLIP 0x10000
393 #define Q2CONTENTS_MONSTERCLIP 0x20000
395 // currents can be added to any other contents, and may be mixed
396 #define Q2CONTENTS_CURRENT_0 0x40000
397 #define Q2CONTENTS_CURRENT_90 0x80000
398 #define Q2CONTENTS_CURRENT_180 0x100000
399 #define Q2CONTENTS_CURRENT_270 0x200000
400 #define Q2CONTENTS_CURRENT_UP 0x400000
401 #define Q2CONTENTS_CURRENT_DOWN 0x800000
403 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
405 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
406 #define Q2CONTENTS_DEADMONSTER 0x4000000
407 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
408 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
409 #define Q2CONTENTS_LADDER 0x20000000
413 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
415 #define Q2SURF_SLICK 0x2 // effects game physics
417 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
418 #define Q2SURF_WARP 0x8 // turbulent water warp
419 #define Q2SURF_TRANS33 0x10
420 #define Q2SURF_TRANS66 0x20
421 #define Q2SURF_FLOWING 0x40 // scroll towards angle
422 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
430 int children[2]; // negative numbers are -(leafs+1), not nodes
431 short mins[3]; // for frustom culling
433 unsigned short firstface;
434 unsigned short numfaces; // counting both sides
440 float vecs[2][4]; // [s/t][xyz offset]
441 int flags; // miptex flags + overrides
442 int value; // light emission, etc
443 char texture[32]; // texture name (textures/*.wal)
444 int nexttexinfo; // for animations, -1 = end of chain
449 int contents; // OR of all brushes (not needed?)
454 short mins[3]; // for frustum culling
457 unsigned short firstleafface;
458 unsigned short numleaffaces;
460 unsigned short firstleafbrush;
461 unsigned short numleafbrushes;
466 unsigned short planenum; // facing out of the leaf
478 // the visibility lump consists of a header with a count, then
479 // byte offsets for the PVS and PHS of each cluster, then the raw
480 // compressed bit vectors
486 int bitofs[8][2]; // bitofs[numclusters][2]
489 // each area has a list of portals that lead into other areas
490 // when portals are closed, other areas may not be visible or
491 // hearable even if the vis info says that it should be
507 #define Q3BSPVERSION 46
509 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
510 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
511 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
512 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
513 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
514 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
515 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
516 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
517 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
518 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
519 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
520 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
521 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
522 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
523 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
524 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
525 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
526 #define Q3HEADER_LUMPS 17
532 lump_t lumps[HEADER_LUMPS];
537 char name[Q3PATHLENGTH];
543 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
554 int childrenindex[2];
562 int clusterindex; // pvs index
563 int areaindex; // area index
605 unsigned char color4ub[4];
611 int offset; // first vertex index of mesh
615 typedef struct q3deffect_s
617 char shadername[Q3PATHLENGTH];
619 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
623 #define Q3FACETYPE_POLYGON 1 // common
624 #define Q3FACETYPE_PATCH 2 // common
625 #define Q3FACETYPE_MESH 3 // common
626 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
631 int effectindex; // -1 if none
632 int type; // Q3FACETYPE
637 int lightmapindex; // -1 if none
638 int lightmap_base[2];
639 int lightmap_size[2];
644 // corrupt or don't care
650 // Q3FACETYPE_POLYGON
651 // polygon is simply a convex polygon, renderable as a mesh
652 float lightmap_origin[3];
653 float lightmap_vectors[2][3];
661 // patch renders as a bezier mesh, with adjustable tesselation
662 // level (optionally based on LOD using the bbox and polygon
663 // count to choose a tesselation level)
664 // note: multiple patches may have the same bbox to cause them to
665 // be LOD adjusted together as a group
667 float mins[3]; // LOD bbox
668 float maxs[3]; // LOD bbox
670 int patchsize[2]; // dimensions of vertex grid
676 // mesh renders as simply a triangle mesh
686 // flare renders as a simple sprite at origin, no geometry
687 // exists, nor does it have a radius, a cvar controls the radius
688 // and another cvar controls distance fade
689 // (they were not used in Q3 I'm told)
701 unsigned char rgb[128*128*3];
707 unsigned char ambientrgb[3];
708 unsigned char diffusergb[3];
709 unsigned char diffusepitch;
710 unsigned char diffuseyaw;
718 // unsigned char chains[];
719 // containing bits in 0-7 order (not 7-0 order),
720 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
724 // surfaceflags from bsp
725 #define Q3SURFACEFLAG_NODAMAGE 1
726 #define Q3SURFACEFLAG_SLICK 2
727 #define Q3SURFACEFLAG_SKY 4
728 #define Q3SURFACEFLAG_LADDER 8
729 #define Q3SURFACEFLAG_NOIMPACT 16
730 #define Q3SURFACEFLAG_NOMARKS 32
731 #define Q3SURFACEFLAG_FLESH 64
732 #define Q3SURFACEFLAG_NODRAW 128
733 #define Q3SURFACEFLAG_HINT 256
734 #define Q3SURFACEFLAG_SKIP 512
735 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
736 #define Q3SURFACEFLAG_POINTLIGHT 2048
737 #define Q3SURFACEFLAG_METALSTEPS 4096
738 #define Q3SURFACEFLAG_NOSTEPS 8192
739 #define Q3SURFACEFLAG_NONSOLID 16384
740 #define Q3SURFACEFLAG_LIGHTFILTER 32768
741 #define Q3SURFACEFLAG_ALPHASHADOW 65536
742 #define Q3SURFACEFLAG_NODLIGHT 131072
743 #define Q3SURFACEFLAG_DUST 262144
745 // surfaceparms from shaders
746 #define Q3SURFACEPARM_ALPHASHADOW 1
747 #define Q3SURFACEPARM_AREAPORTAL 2
748 #define Q3SURFACEPARM_CLUSTERPORTAL 4
749 #define Q3SURFACEPARM_DETAIL 8
750 #define Q3SURFACEPARM_DONOTENTER 16
751 #define Q3SURFACEPARM_FOG 32
752 #define Q3SURFACEPARM_LAVA 64
753 #define Q3SURFACEPARM_LIGHTFILTER 128
754 #define Q3SURFACEPARM_METALSTEPS 256
755 #define Q3SURFACEPARM_NODAMAGE 512
756 #define Q3SURFACEPARM_NODLIGHT 1024
757 #define Q3SURFACEPARM_NODRAW 2048
758 #define Q3SURFACEPARM_NODROP 4096
759 #define Q3SURFACEPARM_NOIMPACT 8192
760 #define Q3SURFACEPARM_NOLIGHTMAP 16384
761 #define Q3SURFACEPARM_NOMARKS 32768
762 #define Q3SURFACEPARM_NOMIPMAPS 65536
763 #define Q3SURFACEPARM_NONSOLID 131072
764 #define Q3SURFACEPARM_ORIGIN 262144
765 #define Q3SURFACEPARM_PLAYERCLIP 524288
766 #define Q3SURFACEPARM_SKY 1048576
767 #define Q3SURFACEPARM_SLICK 2197152
768 #define Q3SURFACEPARM_SLIME 4194304
769 #define Q3SURFACEPARM_STRUCTURAL 8388608
770 #define Q3SURFACEPARM_TRANS 16777216
771 #define Q3SURFACEPARM_WATER 33554432
772 #define Q3SURFACEPARM_POINTLIGHT 67108864
774 // various flags from shaders
775 #define Q3TEXTUREFLAG_TWOSIDED 1
776 #define Q3TEXTUREFLAG_ADDITIVE 2
777 #define Q3TEXTUREFLAG_NOMIPMAPS 4
778 #define Q3TEXTUREFLAG_NOPICMIP 8
779 #define Q3TEXTUREFLAG_AUTOSPRITE 16
780 #define Q3TEXTUREFLAG_AUTOSPRITE2 32
781 #define Q3TEXTUREFLAG_ALPHATEST 64
783 typedef struct q3mbrush_s
785 struct colbrushf_s *colbrushf;
787 struct q3mbrushside_s *firstbrushside;
788 struct texture_s *texture;
792 typedef struct q3mbrushside_s
794 struct mplane_s *plane;
795 struct texture_s *texture;
799 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
800 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
801 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)