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 ==============================================================================
35 // in memory representation
37 typedef struct mvertex_s
49 typedef struct mplane_s
53 // for texture axis selection and fast side tests
59 #define SHADERSTAGE_SKY 0
60 #define SHADERSTAGE_NORMAL 1
61 #define SHADERSTAGE_COUNT 2
63 //#define SURF_PLANEBACK 2
65 // use alpha blend on this material
66 #define MATERIALFLAG_ALPHA 2
67 // use additive blend on this material
68 #define MATERIALFLAG_ADD 4
69 // turn off depth test on this material
70 #define MATERIALFLAG_NODEPTHTEST 8
71 // multiply alpha by r_wateralpha cvar
72 #define MATERIALFLAG_WATERALPHA 16
73 // draw with no lighting
74 #define MATERIALFLAG_FULLBRIGHT 32
75 // drawn as a normal lightmapped wall
76 #define MATERIALFLAG_WALL 64
77 // swirling water effect
78 #define MATERIALFLAG_WATER 128
79 // this surface shows the sky
80 // skipped if transparent
81 #define MATERIALFLAG_SKY 256
82 // skips drawing the surface
83 #define MATERIALFLAG_NODRAW 512
84 // probably used only on q1bsp water
85 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
86 // use alpha test on this material
87 #define MATERIALFLAG_ALPHATEST 2048
88 // treat this material as a blended transparency (as opposed to an alpha test
89 // transparency), this causes special fog behavior, and disables glDepthMask
90 #define MATERIALFLAG_BLENDED 4096
91 // render using a custom blendfunc
92 #define MATERIALFLAG_CUSTOMBLEND 8192
93 // do not cast shadows from this material
94 #define MATERIALFLAG_NOSHADOW 16384
95 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
96 #define MATERIALFLAG_VERTEXTEXTUREBLEND 32768
97 // disables GL_CULL_FACE on this texture (making it double sided)
98 #define MATERIALFLAG_NOCULLFACE 65536
99 // render with a very short depth range (like 10% of normal), this causes entities to appear infront of most of the scene
100 #define MATERIALFLAG_SHORTDEPTHRANGE 131072
101 // combined mask of all attributes that require depth sorted rendering
102 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
104 typedef struct medge_s
110 struct entity_render_s;
114 typedef struct mnode_s
116 //this part shared between node and leaf
117 mplane_t *plane; // != NULL
118 struct mnode_s *parent;
119 struct mportal_s *portals;
120 // for bounding box culling
123 // supercontents from all brushes inside this node or leaf
124 int combinedsupercontents;
126 // this part unique to node
127 struct mnode_s *children[2];
130 unsigned short firstsurface;
131 unsigned short numsurfaces;
135 typedef struct mleaf_s
137 //this part shared between node and leaf
138 mplane_t *plane; // == NULL
139 struct mnode_s *parent;
140 struct mportal_s *portals;
141 // for bounding box culling
144 // supercontents from all brushes inside this node or leaf
145 int combinedsupercontents;
147 // this part unique to leaf
149 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
150 int areaindex; // q3bsp
151 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
153 int *firstleafsurface;
154 int numleafbrushes; // q3bsp
155 int *firstleafbrush; // q3bsp
156 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
157 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
158 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
162 typedef struct hull_s
164 dclipnode_t *clipnodes;
174 typedef struct mportal_s
176 struct mportal_s *next; // the next portal on this leaf
177 mleaf_t *here; // the leaf this portal is on
178 mleaf_t *past; // the leaf through this portal (infront)
181 vec3_t mins, maxs; // culling
186 typedef struct svbspmesh_s
188 struct svbspmesh_s *next;
189 int numverts, maxverts;
190 int numtriangles, maxtriangles;
198 #define Q2BSPVERSION 38
200 // leaffaces, leafbrushes, planes, and verts are still bounded by
201 // 16 bit short limits
203 //=============================================================================
205 #define Q2LUMP_ENTITIES 0
206 #define Q2LUMP_PLANES 1
207 #define Q2LUMP_VERTEXES 2
208 #define Q2LUMP_VISIBILITY 3
209 #define Q2LUMP_NODES 4
210 #define Q2LUMP_TEXINFO 5
211 #define Q2LUMP_FACES 6
212 #define Q2LUMP_LIGHTING 7
213 #define Q2LUMP_LEAFS 8
214 #define Q2LUMP_LEAFFACES 9
215 #define Q2LUMP_LEAFBRUSHES 10
216 #define Q2LUMP_EDGES 11
217 #define Q2LUMP_SURFEDGES 12
218 #define Q2LUMP_MODELS 13
219 #define Q2LUMP_BRUSHES 14
220 #define Q2LUMP_BRUSHSIDES 15
221 #define Q2LUMP_POP 16
222 #define Q2LUMP_AREAS 17
223 #define Q2LUMP_AREAPORTALS 18
224 #define Q2HEADER_LUMPS 19
226 typedef struct q2dheader_s
230 lump_t lumps[Q2HEADER_LUMPS];
233 typedef struct q2dmodel_s
235 float mins[3], maxs[3];
236 float origin[3]; // for sounds or lights
238 int firstface, numfaces; // submodels just draw faces
239 // without walking the bsp tree
242 // planes (x&~1) and (x&~1)+1 are always opposites
244 // contents flags are seperate bits
245 // a given brush can contribute multiple content bits
246 // multiple brushes can be in a single leaf
248 // these definitions also need to be in q_shared.h!
250 // lower bits are stronger, and will eat weaker brushes completely
251 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
252 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
253 #define Q2CONTENTS_AUX 4
254 #define Q2CONTENTS_LAVA 8
255 #define Q2CONTENTS_SLIME 16
256 #define Q2CONTENTS_WATER 32
257 #define Q2CONTENTS_MIST 64
258 #define Q2LAST_VISIBLE_CONTENTS 64
260 // remaining contents are non-visible, and don't eat brushes
262 #define Q2CONTENTS_AREAPORTAL 0x8000
264 #define Q2CONTENTS_PLAYERCLIP 0x10000
265 #define Q2CONTENTS_MONSTERCLIP 0x20000
267 // currents can be added to any other contents, and may be mixed
268 #define Q2CONTENTS_CURRENT_0 0x40000
269 #define Q2CONTENTS_CURRENT_90 0x80000
270 #define Q2CONTENTS_CURRENT_180 0x100000
271 #define Q2CONTENTS_CURRENT_270 0x200000
272 #define Q2CONTENTS_CURRENT_UP 0x400000
273 #define Q2CONTENTS_CURRENT_DOWN 0x800000
275 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
277 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
278 #define Q2CONTENTS_DEADMONSTER 0x4000000
279 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
280 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
281 #define Q2CONTENTS_LADDER 0x20000000
285 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
287 #define Q2SURF_SLICK 0x2 // effects game physics
289 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
290 #define Q2SURF_WARP 0x8 // turbulent water warp
291 #define Q2SURF_TRANS33 0x10
292 #define Q2SURF_TRANS66 0x20
293 #define Q2SURF_FLOWING 0x40 // scroll towards angle
294 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
299 typedef struct q2dnode_s
302 int children[2]; // negative numbers are -(leafs+1), not nodes
303 short mins[3]; // for frustom culling
305 unsigned short firstface;
306 unsigned short numfaces; // counting both sides
310 typedef struct q2texinfo_s
312 float vecs[2][4]; // [s/t][xyz offset]
313 int flags; // miptex flags + overrides
314 int value; // light emission, etc
315 char texture[32]; // texture name (textures/*.wal)
316 int nexttexinfo; // for animations, -1 = end of chain
319 typedef struct q2dleaf_s
321 int contents; // OR of all brushes (not needed?)
326 short mins[3]; // for frustum culling
329 unsigned short firstleafface;
330 unsigned short numleaffaces;
332 unsigned short firstleafbrush;
333 unsigned short numleafbrushes;
336 typedef struct q2dbrushside_s
338 unsigned short planenum; // facing out of the leaf
342 typedef struct q2dbrush_s
350 // the visibility lump consists of a header with a count, then
351 // byte offsets for the PVS and PHS of each cluster, then the raw
352 // compressed bit vectors
355 typedef struct q2dvis_s
358 int bitofs[8][2]; // bitofs[numclusters][2]
361 // each area has a list of portals that lead into other areas
362 // when portals are closed, other areas may not be visible or
363 // hearable even if the vis info says that it should be
364 typedef struct q2dareaportal_s
370 typedef struct q2darea_s
379 #define Q3BSPVERSION 46
381 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
382 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
383 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
384 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
385 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
386 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
387 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
388 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
389 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
390 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
391 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
392 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
393 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
394 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
395 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
396 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
397 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
398 #define Q3HEADER_LUMPS 17
400 typedef struct q3dheader_s
404 lump_t lumps[Q3HEADER_LUMPS];
407 typedef struct q3dtexture_s
409 char name[Q3PATHLENGTH];
415 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
416 typedef struct q3dplane_s
423 typedef struct q3dnode_s
426 int childrenindex[2];
432 typedef struct q3dleaf_s
434 int clusterindex; // pvs index
435 int areaindex; // area index
445 typedef struct q3dmodel_s
456 typedef struct q3dbrush_s
464 typedef struct q3dbrushside_s
471 typedef struct q3dvertex_s
477 unsigned char color4ub[4];
481 typedef struct q3dmeshvertex_s
483 int offset; // first vertex index of mesh
487 typedef struct q3deffect_s
489 char shadername[Q3PATHLENGTH];
491 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
495 #define Q3FACETYPE_POLYGON 1 // common
496 #define Q3FACETYPE_PATCH 2 // common
497 #define Q3FACETYPE_MESH 3 // common
498 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
500 typedef struct q3dface_s
503 int effectindex; // -1 if none
504 int type; // Q3FACETYPE
509 int lightmapindex; // -1 if none
510 int lightmap_base[2];
511 int lightmap_size[2];
516 // corrupt or don't care
522 // Q3FACETYPE_POLYGON
523 // polygon is simply a convex polygon, renderable as a mesh
524 float lightmap_origin[3];
525 float lightmap_vectors[2][3];
533 // patch renders as a bezier mesh, with adjustable tesselation
534 // level (optionally based on LOD using the bbox and polygon
535 // count to choose a tesselation level)
536 // note: multiple patches may have the same bbox to cause them to
537 // be LOD adjusted together as a group
539 float mins[3]; // LOD bbox
540 float maxs[3]; // LOD bbox
542 int patchsize[2]; // dimensions of vertex grid
548 // mesh renders as simply a triangle mesh
558 // flare renders as a simple sprite at origin, no geometry
559 // exists, nor does it have a radius, a cvar controls the radius
560 // and another cvar controls distance fade
561 // (they were not used in Q3 I'm told)
571 typedef struct q3dlightmap_s
573 unsigned char rgb[128*128*3];
577 typedef struct q3dlightgrid_s
579 unsigned char ambientrgb[3];
580 unsigned char diffusergb[3];
581 unsigned char diffusepitch;
582 unsigned char diffuseyaw;
586 typedef struct q3dpvs_s
590 // unsigned char chains[];
591 // containing bits in 0-7 order (not 7-0 order),
592 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
596 // surfaceflags from bsp
597 #define Q3SURFACEFLAG_NODAMAGE 1
598 #define Q3SURFACEFLAG_SLICK 2
599 #define Q3SURFACEFLAG_SKY 4
600 #define Q3SURFACEFLAG_LADDER 8
601 #define Q3SURFACEFLAG_NOIMPACT 16
602 #define Q3SURFACEFLAG_NOMARKS 32
603 #define Q3SURFACEFLAG_FLESH 64
604 #define Q3SURFACEFLAG_NODRAW 128
605 #define Q3SURFACEFLAG_HINT 256
606 #define Q3SURFACEFLAG_SKIP 512
607 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
608 #define Q3SURFACEFLAG_POINTLIGHT 2048
609 #define Q3SURFACEFLAG_METALSTEPS 4096
610 #define Q3SURFACEFLAG_NOSTEPS 8192
611 #define Q3SURFACEFLAG_NONSOLID 16384
612 #define Q3SURFACEFLAG_LIGHTFILTER 32768
613 #define Q3SURFACEFLAG_ALPHASHADOW 65536
614 #define Q3SURFACEFLAG_NODLIGHT 131072
615 #define Q3SURFACEFLAG_DUST 262144
617 // surfaceparms from shaders
618 #define Q3SURFACEPARM_ALPHASHADOW 1
619 #define Q3SURFACEPARM_AREAPORTAL 2
620 #define Q3SURFACEPARM_CLUSTERPORTAL 4
621 #define Q3SURFACEPARM_DETAIL 8
622 #define Q3SURFACEPARM_DONOTENTER 16
623 #define Q3SURFACEPARM_FOG 32
624 #define Q3SURFACEPARM_LAVA 64
625 #define Q3SURFACEPARM_LIGHTFILTER 128
626 #define Q3SURFACEPARM_METALSTEPS 256
627 #define Q3SURFACEPARM_NODAMAGE 512
628 #define Q3SURFACEPARM_NODLIGHT 1024
629 #define Q3SURFACEPARM_NODRAW 2048
630 #define Q3SURFACEPARM_NODROP 4096
631 #define Q3SURFACEPARM_NOIMPACT 8192
632 #define Q3SURFACEPARM_NOLIGHTMAP 16384
633 #define Q3SURFACEPARM_NOMARKS 32768
634 #define Q3SURFACEPARM_NOMIPMAPS 65536
635 #define Q3SURFACEPARM_NONSOLID 131072
636 #define Q3SURFACEPARM_ORIGIN 262144
637 #define Q3SURFACEPARM_PLAYERCLIP 524288
638 #define Q3SURFACEPARM_SKY 1048576
639 #define Q3SURFACEPARM_SLICK 2197152
640 #define Q3SURFACEPARM_SLIME 4194304
641 #define Q3SURFACEPARM_STRUCTURAL 8388608
642 #define Q3SURFACEPARM_TRANS 16777216
643 #define Q3SURFACEPARM_WATER 33554432
644 #define Q3SURFACEPARM_POINTLIGHT 67108864
645 #define Q3SURFACEPARM_HINT 134217728
646 #define Q3SURFACEPARM_DUST 268435456
647 #define Q3SURFACEPARM_BOTCLIP 536870912
648 #define Q3SURFACEPARM_LIGHTGRID 1073741824
649 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
651 typedef struct q3mbrush_s
653 struct colbrushf_s *colbrushf;
655 struct q3mbrushside_s *firstbrushside;
656 struct texture_s *texture;
660 typedef struct q3mbrushside_s
662 struct mplane_s *plane;
663 struct texture_s *texture;
667 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
668 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
669 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)