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 // 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
89 // use alpha test on this material
90 #define MATERIALFLAG_ALPHATEST 2048
91 // treat this material as a blended transparency (as opposed to an alpha test
92 // transparency), this causes special fog behavior, and disables glDepthMask
93 #define MATERIALFLAG_BLENDED 4096
94 // render using a custom blendfunc
95 #define MATERIALFLAG_CUSTOMBLEND 8192
97 typedef struct medge_s
103 struct entity_render_s;
107 typedef struct mnode_s
109 //this part shared between node and leaf
110 mplane_t *plane; // != NULL
111 struct mnode_s *parent;
112 struct mportal_s *portals;
113 // for bounding box culling
117 // this part unique to node
118 struct mnode_s *children[2];
121 unsigned short firstsurface;
122 unsigned short numsurfaces;
126 typedef struct mleaf_s
128 //this part shared between node and leaf
129 mplane_t *plane; // == NULL
130 struct mnode_s *parent;
131 struct mportal_s *portals;
132 // for bounding box culling
136 // this part unique to leaf
138 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
139 int areaindex; // q3bsp
141 int *firstleafsurface;
142 int numleafbrushes; // q3bsp
143 int *firstleafbrush; // q3bsp
144 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
145 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
146 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
150 typedef struct hull_s
152 dclipnode_t *clipnodes;
162 typedef struct mportal_s
164 struct mportal_s *next; // the next portal on this leaf
165 mleaf_t *here; // the leaf this portal is on
166 mleaf_t *past; // the leaf through this portal (infront)
169 vec3_t mins, maxs; // culling
174 typedef struct svbspmesh_s
176 struct svbspmesh_s *next;
177 int numverts, maxverts;
178 int numtriangles, maxtriangles;
186 #define Q2BSPVERSION 38
188 // leaffaces, leafbrushes, planes, and verts are still bounded by
189 // 16 bit short limits
191 //=============================================================================
193 #define Q2LUMP_ENTITIES 0
194 #define Q2LUMP_PLANES 1
195 #define Q2LUMP_VERTEXES 2
196 #define Q2LUMP_VISIBILITY 3
197 #define Q2LUMP_NODES 4
198 #define Q2LUMP_TEXINFO 5
199 #define Q2LUMP_FACES 6
200 #define Q2LUMP_LIGHTING 7
201 #define Q2LUMP_LEAFS 8
202 #define Q2LUMP_LEAFFACES 9
203 #define Q2LUMP_LEAFBRUSHES 10
204 #define Q2LUMP_EDGES 11
205 #define Q2LUMP_SURFEDGES 12
206 #define Q2LUMP_MODELS 13
207 #define Q2LUMP_BRUSHES 14
208 #define Q2LUMP_BRUSHSIDES 15
209 #define Q2LUMP_POP 16
210 #define Q2LUMP_AREAS 17
211 #define Q2LUMP_AREAPORTALS 18
212 #define Q2HEADER_LUMPS 19
214 typedef struct q2dheader_s
218 lump_t lumps[Q2HEADER_LUMPS];
221 typedef struct q2dmodel_s
223 float mins[3], maxs[3];
224 float origin[3]; // for sounds or lights
226 int firstface, numfaces; // submodels just draw faces
227 // without walking the bsp tree
230 // planes (x&~1) and (x&~1)+1 are always opposites
232 // contents flags are seperate bits
233 // a given brush can contribute multiple content bits
234 // multiple brushes can be in a single leaf
236 // these definitions also need to be in q_shared.h!
238 // lower bits are stronger, and will eat weaker brushes completely
239 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
240 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
241 #define Q2CONTENTS_AUX 4
242 #define Q2CONTENTS_LAVA 8
243 #define Q2CONTENTS_SLIME 16
244 #define Q2CONTENTS_WATER 32
245 #define Q2CONTENTS_MIST 64
246 #define Q2LAST_VISIBLE_CONTENTS 64
248 // remaining contents are non-visible, and don't eat brushes
250 #define Q2CONTENTS_AREAPORTAL 0x8000
252 #define Q2CONTENTS_PLAYERCLIP 0x10000
253 #define Q2CONTENTS_MONSTERCLIP 0x20000
255 // currents can be added to any other contents, and may be mixed
256 #define Q2CONTENTS_CURRENT_0 0x40000
257 #define Q2CONTENTS_CURRENT_90 0x80000
258 #define Q2CONTENTS_CURRENT_180 0x100000
259 #define Q2CONTENTS_CURRENT_270 0x200000
260 #define Q2CONTENTS_CURRENT_UP 0x400000
261 #define Q2CONTENTS_CURRENT_DOWN 0x800000
263 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
265 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
266 #define Q2CONTENTS_DEADMONSTER 0x4000000
267 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
268 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
269 #define Q2CONTENTS_LADDER 0x20000000
273 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
275 #define Q2SURF_SLICK 0x2 // effects game physics
277 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
278 #define Q2SURF_WARP 0x8 // turbulent water warp
279 #define Q2SURF_TRANS33 0x10
280 #define Q2SURF_TRANS66 0x20
281 #define Q2SURF_FLOWING 0x40 // scroll towards angle
282 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
287 typedef struct q2dnode_s
290 int children[2]; // negative numbers are -(leafs+1), not nodes
291 short mins[3]; // for frustom culling
293 unsigned short firstface;
294 unsigned short numfaces; // counting both sides
298 typedef struct q2texinfo_s
300 float vecs[2][4]; // [s/t][xyz offset]
301 int flags; // miptex flags + overrides
302 int value; // light emission, etc
303 char texture[32]; // texture name (textures/*.wal)
304 int nexttexinfo; // for animations, -1 = end of chain
307 typedef struct q2dleaf_s
309 int contents; // OR of all brushes (not needed?)
314 short mins[3]; // for frustum culling
317 unsigned short firstleafface;
318 unsigned short numleaffaces;
320 unsigned short firstleafbrush;
321 unsigned short numleafbrushes;
324 typedef struct q2dbrushside_s
326 unsigned short planenum; // facing out of the leaf
330 typedef struct q2dbrush_s
338 // the visibility lump consists of a header with a count, then
339 // byte offsets for the PVS and PHS of each cluster, then the raw
340 // compressed bit vectors
343 typedef struct q2dvis_s
346 int bitofs[8][2]; // bitofs[numclusters][2]
349 // each area has a list of portals that lead into other areas
350 // when portals are closed, other areas may not be visible or
351 // hearable even if the vis info says that it should be
352 typedef struct q2dareaportal_s
358 typedef struct q2darea_s
367 #define Q3BSPVERSION 46
369 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
370 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
371 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
372 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
373 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
374 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
375 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
376 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
377 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
378 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
379 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
380 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
381 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
382 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
383 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
384 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
385 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
386 #define Q3HEADER_LUMPS 17
388 typedef struct q3dheader_s
392 lump_t lumps[Q3HEADER_LUMPS];
395 typedef struct q3dtexture_s
397 char name[Q3PATHLENGTH];
403 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
404 typedef struct q3dplane_s
411 typedef struct q3dnode_s
414 int childrenindex[2];
420 typedef struct q3dleaf_s
422 int clusterindex; // pvs index
423 int areaindex; // area index
433 typedef struct q3dmodel_s
444 typedef struct q3dbrush_s
452 typedef struct q3dbrushside_s
459 typedef struct q3dvertex_s
465 unsigned char color4ub[4];
469 typedef struct q3dmeshvertex_s
471 int offset; // first vertex index of mesh
475 typedef struct q3deffect_s
477 char shadername[Q3PATHLENGTH];
479 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
483 #define Q3FACETYPE_POLYGON 1 // common
484 #define Q3FACETYPE_PATCH 2 // common
485 #define Q3FACETYPE_MESH 3 // common
486 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
488 typedef struct q3dface_s
491 int effectindex; // -1 if none
492 int type; // Q3FACETYPE
497 int lightmapindex; // -1 if none
498 int lightmap_base[2];
499 int lightmap_size[2];
504 // corrupt or don't care
510 // Q3FACETYPE_POLYGON
511 // polygon is simply a convex polygon, renderable as a mesh
512 float lightmap_origin[3];
513 float lightmap_vectors[2][3];
521 // patch renders as a bezier mesh, with adjustable tesselation
522 // level (optionally based on LOD using the bbox and polygon
523 // count to choose a tesselation level)
524 // note: multiple patches may have the same bbox to cause them to
525 // be LOD adjusted together as a group
527 float mins[3]; // LOD bbox
528 float maxs[3]; // LOD bbox
530 int patchsize[2]; // dimensions of vertex grid
536 // mesh renders as simply a triangle mesh
546 // flare renders as a simple sprite at origin, no geometry
547 // exists, nor does it have a radius, a cvar controls the radius
548 // and another cvar controls distance fade
549 // (they were not used in Q3 I'm told)
559 typedef struct q3dlightmap_s
561 unsigned char rgb[128*128*3];
565 typedef struct q3dlightgrid_s
567 unsigned char ambientrgb[3];
568 unsigned char diffusergb[3];
569 unsigned char diffusepitch;
570 unsigned char diffuseyaw;
574 typedef struct q3dpvs_s
578 // unsigned char chains[];
579 // containing bits in 0-7 order (not 7-0 order),
580 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
584 // surfaceflags from bsp
585 #define Q3SURFACEFLAG_NODAMAGE 1
586 #define Q3SURFACEFLAG_SLICK 2
587 #define Q3SURFACEFLAG_SKY 4
588 #define Q3SURFACEFLAG_LADDER 8
589 #define Q3SURFACEFLAG_NOIMPACT 16
590 #define Q3SURFACEFLAG_NOMARKS 32
591 #define Q3SURFACEFLAG_FLESH 64
592 #define Q3SURFACEFLAG_NODRAW 128
593 #define Q3SURFACEFLAG_HINT 256
594 #define Q3SURFACEFLAG_SKIP 512
595 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
596 #define Q3SURFACEFLAG_POINTLIGHT 2048
597 #define Q3SURFACEFLAG_METALSTEPS 4096
598 #define Q3SURFACEFLAG_NOSTEPS 8192
599 #define Q3SURFACEFLAG_NONSOLID 16384
600 #define Q3SURFACEFLAG_LIGHTFILTER 32768
601 #define Q3SURFACEFLAG_ALPHASHADOW 65536
602 #define Q3SURFACEFLAG_NODLIGHT 131072
603 #define Q3SURFACEFLAG_DUST 262144
605 // surfaceparms from shaders
606 #define Q3SURFACEPARM_ALPHASHADOW 1
607 #define Q3SURFACEPARM_AREAPORTAL 2
608 #define Q3SURFACEPARM_CLUSTERPORTAL 4
609 #define Q3SURFACEPARM_DETAIL 8
610 #define Q3SURFACEPARM_DONOTENTER 16
611 #define Q3SURFACEPARM_FOG 32
612 #define Q3SURFACEPARM_LAVA 64
613 #define Q3SURFACEPARM_LIGHTFILTER 128
614 #define Q3SURFACEPARM_METALSTEPS 256
615 #define Q3SURFACEPARM_NODAMAGE 512
616 #define Q3SURFACEPARM_NODLIGHT 1024
617 #define Q3SURFACEPARM_NODRAW 2048
618 #define Q3SURFACEPARM_NODROP 4096
619 #define Q3SURFACEPARM_NOIMPACT 8192
620 #define Q3SURFACEPARM_NOLIGHTMAP 16384
621 #define Q3SURFACEPARM_NOMARKS 32768
622 #define Q3SURFACEPARM_NOMIPMAPS 65536
623 #define Q3SURFACEPARM_NONSOLID 131072
624 #define Q3SURFACEPARM_ORIGIN 262144
625 #define Q3SURFACEPARM_PLAYERCLIP 524288
626 #define Q3SURFACEPARM_SKY 1048576
627 #define Q3SURFACEPARM_SLICK 2197152
628 #define Q3SURFACEPARM_SLIME 4194304
629 #define Q3SURFACEPARM_STRUCTURAL 8388608
630 #define Q3SURFACEPARM_TRANS 16777216
631 #define Q3SURFACEPARM_WATER 33554432
632 #define Q3SURFACEPARM_POINTLIGHT 67108864
633 #define Q3SURFACEPARM_HINT 134217728
634 #define Q3SURFACEPARM_DUST 268435456
635 #define Q3SURFACEPARM_BOTCLIP 536870912
636 #define Q3SURFACEPARM_LIGHTGRID 1073741824
638 // various flags from shaders, used for special effects not otherwise classified
639 #define Q3TEXTUREFLAG_TWOSIDED 1
640 #define Q3TEXTUREFLAG_AUTOSPRITE 2
641 #define Q3TEXTUREFLAG_AUTOSPRITE2 4
642 #define Q3TEXTUREFLAG_ALPHATEST 8
643 #define Q3TEXTUREFLAG_NOPICMIP 16
645 typedef struct q3mbrush_s
647 struct colbrushf_s *colbrushf;
649 struct q3mbrushside_s *firstbrushside;
650 struct texture_s *texture;
654 typedef struct q3mbrushside_s
656 struct mplane_s *plane;
657 struct texture_s *texture;
661 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
662 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
663 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)