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
38 typedef struct mvertex_s
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 // use alpha blend on this material
67 #define MATERIALFLAG_ALPHA 2
68 // use additive blend on this material
69 #define MATERIALFLAG_ADD 4
70 // turn off depth test on this material
71 #define MATERIALFLAG_NODEPTHTEST 8
72 // multiply alpha by r_wateralpha cvar
73 #define MATERIALFLAG_WATERALPHA 16
74 // draw with no lighting
75 #define MATERIALFLAG_FULLBRIGHT 32
76 // drawn as a normal lightmapped wall
77 #define MATERIALFLAG_WALL 64
78 // swirling water effect
79 #define MATERIALFLAG_WATER 128
80 // this surface shows the sky
81 // skipped if transparent
82 #define MATERIALFLAG_SKY 256
83 // skips drawing the surface
84 #define MATERIALFLAG_NODRAW 512
85 // probably used only on q1bsp water
86 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
87 // use alpha test on this material
88 #define MATERIALFLAG_ALPHATEST 2048
89 // treat this material as a blended transparency (as opposed to an alpha test
90 // transparency), this causes special fog behavior, and disables glDepthMask
91 #define MATERIALFLAG_BLENDED 4096
92 // render using a custom blendfunc
93 #define MATERIALFLAG_CUSTOMBLEND 8192
94 // do not cast shadows from this material
95 #define MATERIALFLAG_NOSHADOW 16384
96 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
97 #define MATERIALFLAG_VERTEXTEXTUREBLEND 32768
98 // disables GL_CULL_FACE on this texture (making it double sided)
99 #define MATERIALFLAG_NOCULLFACE 65536
100 // render with a very short depth range (like 10% of normal), this causes entities to appear infront of most of the scene
101 #define MATERIALFLAG_SHORTDEPTHRANGE 131072
102 // combined mask of all attributes that require depth sorted rendering
103 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
105 typedef struct medge_s
111 struct entity_render_s;
115 typedef struct mnode_s
117 //this part shared between node and leaf
118 mplane_t *plane; // != NULL
119 struct mnode_s *parent;
120 struct mportal_s *portals;
121 // for bounding box culling
124 // supercontents from all brushes inside this node or leaf
125 int combinedsupercontents;
127 // this part unique to node
128 struct mnode_s *children[2];
131 unsigned short firstsurface;
132 unsigned short numsurfaces;
136 typedef struct mleaf_s
138 //this part shared between node and leaf
139 mplane_t *plane; // == NULL
140 struct mnode_s *parent;
141 struct mportal_s *portals;
142 // for bounding box culling
145 // supercontents from all brushes inside this node or leaf
146 int combinedsupercontents;
148 // this part unique to leaf
150 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
151 int areaindex; // q3bsp
152 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
154 int *firstleafsurface;
155 int numleafbrushes; // q3bsp
156 int *firstleafbrush; // q3bsp
157 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
158 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
159 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
163 typedef struct hull_s
165 dclipnode_t *clipnodes;
175 typedef struct mportal_s
177 struct mportal_s *next; // the next portal on this leaf
178 mleaf_t *here; // the leaf this portal is on
179 mleaf_t *past; // the leaf through this portal (infront)
182 vec3_t mins, maxs; // culling
187 typedef struct svbspmesh_s
189 struct svbspmesh_s *next;
190 int numverts, maxverts;
191 int numtriangles, maxtriangles;
199 #define Q2BSPVERSION 38
201 // leaffaces, leafbrushes, planes, and verts are still bounded by
202 // 16 bit short limits
204 //=============================================================================
206 #define Q2LUMP_ENTITIES 0
207 #define Q2LUMP_PLANES 1
208 #define Q2LUMP_VERTEXES 2
209 #define Q2LUMP_VISIBILITY 3
210 #define Q2LUMP_NODES 4
211 #define Q2LUMP_TEXINFO 5
212 #define Q2LUMP_FACES 6
213 #define Q2LUMP_LIGHTING 7
214 #define Q2LUMP_LEAFS 8
215 #define Q2LUMP_LEAFFACES 9
216 #define Q2LUMP_LEAFBRUSHES 10
217 #define Q2LUMP_EDGES 11
218 #define Q2LUMP_SURFEDGES 12
219 #define Q2LUMP_MODELS 13
220 #define Q2LUMP_BRUSHES 14
221 #define Q2LUMP_BRUSHSIDES 15
222 #define Q2LUMP_POP 16
223 #define Q2LUMP_AREAS 17
224 #define Q2LUMP_AREAPORTALS 18
225 #define Q2HEADER_LUMPS 19
227 typedef struct q2dheader_s
231 lump_t lumps[Q2HEADER_LUMPS];
234 typedef struct q2dmodel_s
236 float mins[3], maxs[3];
237 float origin[3]; // for sounds or lights
239 int firstface, numfaces; // submodels just draw faces
240 // without walking the bsp tree
243 // planes (x&~1) and (x&~1)+1 are always opposites
245 // contents flags are seperate bits
246 // a given brush can contribute multiple content bits
247 // multiple brushes can be in a single leaf
249 // these definitions also need to be in q_shared.h!
251 // lower bits are stronger, and will eat weaker brushes completely
252 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
253 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
254 #define Q2CONTENTS_AUX 4
255 #define Q2CONTENTS_LAVA 8
256 #define Q2CONTENTS_SLIME 16
257 #define Q2CONTENTS_WATER 32
258 #define Q2CONTENTS_MIST 64
259 #define Q2LAST_VISIBLE_CONTENTS 64
261 // remaining contents are non-visible, and don't eat brushes
263 #define Q2CONTENTS_AREAPORTAL 0x8000
265 #define Q2CONTENTS_PLAYERCLIP 0x10000
266 #define Q2CONTENTS_MONSTERCLIP 0x20000
268 // currents can be added to any other contents, and may be mixed
269 #define Q2CONTENTS_CURRENT_0 0x40000
270 #define Q2CONTENTS_CURRENT_90 0x80000
271 #define Q2CONTENTS_CURRENT_180 0x100000
272 #define Q2CONTENTS_CURRENT_270 0x200000
273 #define Q2CONTENTS_CURRENT_UP 0x400000
274 #define Q2CONTENTS_CURRENT_DOWN 0x800000
276 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
278 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
279 #define Q2CONTENTS_DEADMONSTER 0x4000000
280 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
281 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
282 #define Q2CONTENTS_LADDER 0x20000000
286 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
288 #define Q2SURF_SLICK 0x2 // effects game physics
290 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
291 #define Q2SURF_WARP 0x8 // turbulent water warp
292 #define Q2SURF_TRANS33 0x10
293 #define Q2SURF_TRANS66 0x20
294 #define Q2SURF_FLOWING 0x40 // scroll towards angle
295 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
300 typedef struct q2dnode_s
303 int children[2]; // negative numbers are -(leafs+1), not nodes
304 short mins[3]; // for frustom culling
306 unsigned short firstface;
307 unsigned short numfaces; // counting both sides
311 typedef struct q2texinfo_s
313 float vecs[2][4]; // [s/t][xyz offset]
314 int flags; // miptex flags + overrides
315 int value; // light emission, etc
316 char texture[32]; // texture name (textures/*.wal)
317 int nexttexinfo; // for animations, -1 = end of chain
320 typedef struct q2dleaf_s
322 int contents; // OR of all brushes (not needed?)
327 short mins[3]; // for frustum culling
330 unsigned short firstleafface;
331 unsigned short numleaffaces;
333 unsigned short firstleafbrush;
334 unsigned short numleafbrushes;
337 typedef struct q2dbrushside_s
339 unsigned short planenum; // facing out of the leaf
343 typedef struct q2dbrush_s
351 // the visibility lump consists of a header with a count, then
352 // byte offsets for the PVS and PHS of each cluster, then the raw
353 // compressed bit vectors
356 typedef struct q2dvis_s
359 int bitofs[8][2]; // bitofs[numclusters][2]
362 // each area has a list of portals that lead into other areas
363 // when portals are closed, other areas may not be visible or
364 // hearable even if the vis info says that it should be
365 typedef struct q2dareaportal_s
371 typedef struct q2darea_s
380 #define Q3BSPVERSION 46
382 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
383 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
384 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
385 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
386 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
387 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
388 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
389 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
390 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
391 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
392 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
393 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
394 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
395 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
396 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
397 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
398 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
399 #define Q3HEADER_LUMPS 17
401 typedef struct q3dheader_s
405 lump_t lumps[Q3HEADER_LUMPS];
408 typedef struct q3dtexture_s
410 char name[Q3PATHLENGTH];
416 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
417 typedef struct q3dplane_s
424 typedef struct q3dnode_s
427 int childrenindex[2];
433 typedef struct q3dleaf_s
435 int clusterindex; // pvs index
436 int areaindex; // area index
446 typedef struct q3dmodel_s
457 typedef struct q3dbrush_s
465 typedef struct q3dbrushside_s
472 typedef struct q3dvertex_s
478 unsigned char color4ub[4];
482 typedef struct q3dmeshvertex_s
484 int offset; // first vertex index of mesh
488 typedef struct q3deffect_s
490 char shadername[Q3PATHLENGTH];
492 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
496 #define Q3FACETYPE_POLYGON 1 // common
497 #define Q3FACETYPE_PATCH 2 // common
498 #define Q3FACETYPE_MESH 3 // common
499 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
501 typedef struct q3dface_s
504 int effectindex; // -1 if none
505 int type; // Q3FACETYPE
510 int lightmapindex; // -1 if none
511 int lightmap_base[2];
512 int lightmap_size[2];
517 // corrupt or don't care
523 // Q3FACETYPE_POLYGON
524 // polygon is simply a convex polygon, renderable as a mesh
525 float lightmap_origin[3];
526 float lightmap_vectors[2][3];
534 // patch renders as a bezier mesh, with adjustable tesselation
535 // level (optionally based on LOD using the bbox and polygon
536 // count to choose a tesselation level)
537 // note: multiple patches may have the same bbox to cause them to
538 // be LOD adjusted together as a group
540 float mins[3]; // LOD bbox
541 float maxs[3]; // LOD bbox
543 int patchsize[2]; // dimensions of vertex grid
549 // mesh renders as simply a triangle mesh
559 // flare renders as a simple sprite at origin, no geometry
560 // exists, nor does it have a radius, a cvar controls the radius
561 // and another cvar controls distance fade
562 // (they were not used in Q3 I'm told)
572 typedef struct q3dlightmap_s
574 unsigned char rgb[128*128*3];
578 typedef struct q3dlightgrid_s
580 unsigned char ambientrgb[3];
581 unsigned char diffusergb[3];
582 unsigned char diffusepitch;
583 unsigned char diffuseyaw;
587 typedef struct q3dpvs_s
591 // unsigned char chains[];
592 // containing bits in 0-7 order (not 7-0 order),
593 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
597 // surfaceflags from bsp
598 #define Q3SURFACEFLAG_NODAMAGE 1
599 #define Q3SURFACEFLAG_SLICK 2
600 #define Q3SURFACEFLAG_SKY 4
601 #define Q3SURFACEFLAG_LADDER 8
602 #define Q3SURFACEFLAG_NOIMPACT 16
603 #define Q3SURFACEFLAG_NOMARKS 32
604 #define Q3SURFACEFLAG_FLESH 64
605 #define Q3SURFACEFLAG_NODRAW 128
606 #define Q3SURFACEFLAG_HINT 256
607 #define Q3SURFACEFLAG_SKIP 512
608 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
609 #define Q3SURFACEFLAG_POINTLIGHT 2048
610 #define Q3SURFACEFLAG_METALSTEPS 4096
611 #define Q3SURFACEFLAG_NOSTEPS 8192
612 #define Q3SURFACEFLAG_NONSOLID 16384
613 #define Q3SURFACEFLAG_LIGHTFILTER 32768
614 #define Q3SURFACEFLAG_ALPHASHADOW 65536
615 #define Q3SURFACEFLAG_NODLIGHT 131072
616 #define Q3SURFACEFLAG_DUST 262144
618 // surfaceparms from shaders
619 #define Q3SURFACEPARM_ALPHASHADOW 1
620 #define Q3SURFACEPARM_AREAPORTAL 2
621 #define Q3SURFACEPARM_CLUSTERPORTAL 4
622 #define Q3SURFACEPARM_DETAIL 8
623 #define Q3SURFACEPARM_DONOTENTER 16
624 #define Q3SURFACEPARM_FOG 32
625 #define Q3SURFACEPARM_LAVA 64
626 #define Q3SURFACEPARM_LIGHTFILTER 128
627 #define Q3SURFACEPARM_METALSTEPS 256
628 #define Q3SURFACEPARM_NODAMAGE 512
629 #define Q3SURFACEPARM_NODLIGHT 1024
630 #define Q3SURFACEPARM_NODRAW 2048
631 #define Q3SURFACEPARM_NODROP 4096
632 #define Q3SURFACEPARM_NOIMPACT 8192
633 #define Q3SURFACEPARM_NOLIGHTMAP 16384
634 #define Q3SURFACEPARM_NOMARKS 32768
635 #define Q3SURFACEPARM_NOMIPMAPS 65536
636 #define Q3SURFACEPARM_NONSOLID 131072
637 #define Q3SURFACEPARM_ORIGIN 262144
638 #define Q3SURFACEPARM_PLAYERCLIP 524288
639 #define Q3SURFACEPARM_SKY 1048576
640 #define Q3SURFACEPARM_SLICK 2197152
641 #define Q3SURFACEPARM_SLIME 4194304
642 #define Q3SURFACEPARM_STRUCTURAL 8388608
643 #define Q3SURFACEPARM_TRANS 16777216
644 #define Q3SURFACEPARM_WATER 33554432
645 #define Q3SURFACEPARM_POINTLIGHT 67108864
646 #define Q3SURFACEPARM_HINT 134217728
647 #define Q3SURFACEPARM_DUST 268435456
648 #define Q3SURFACEPARM_BOTCLIP 536870912
649 #define Q3SURFACEPARM_LIGHTGRID 1073741824
650 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
652 // various flags from shaders, used for special effects not otherwise classified
653 #define Q3TEXTUREFLAG_TWOSIDED 1
654 #define Q3TEXTUREFLAG_AUTOSPRITE 2
655 #define Q3TEXTUREFLAG_AUTOSPRITE2 4
656 #define Q3TEXTUREFLAG_NOPICMIP 16
658 typedef struct q3mbrush_s
660 struct colbrushf_s *colbrushf;
662 struct q3mbrushside_s *firstbrushside;
663 struct texture_s *texture;
667 typedef struct q3mbrushside_s
669 struct mplane_s *plane;
670 struct texture_s *texture;
674 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
675 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
676 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)