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
58 vec4_t normal_and_dist;
60 // for texture axis selection and fast side tests
61 int type; // set by PlaneClassify()
62 int signbits; // set by PlaneClassify()
66 #define SHADERSTAGE_SKY 0
67 #define SHADERSTAGE_NORMAL 1
68 #define SHADERSTAGE_COUNT 2
70 //#define SURF_PLANEBACK 2
72 // indicates that all triangles of the surface should be added to the BIH collision system
73 #define MATERIALFLAG_MESHCOLLISIONS 0x00000001
74 // use alpha blend on this material
75 #define MATERIALFLAG_ALPHA 0x00000002
76 // use additive blend on this material
77 #define MATERIALFLAG_ADD 0x00000004
78 // turn off depth test on this material
79 #define MATERIALFLAG_NODEPTHTEST 0x00000008
80 // multiply alpha by r_wateralpha cvar
81 #define MATERIALFLAG_WATERALPHA 0x00000010
82 // draw with no lighting
83 #define MATERIALFLAG_FULLBRIGHT 0x00000020
84 // drawn as a normal surface (alternative to SKY)
85 #define MATERIALFLAG_WALL 0x00000040
86 // this surface shows the sky in its place, alternative to WALL
87 // skipped if transparent
88 #define MATERIALFLAG_SKY 0x00000080
89 // swirling water effect (used with MATERIALFLAG_WALL)
90 #define MATERIALFLAG_WATERSCROLL 0x00000100
91 // skips drawing the surface
92 #define MATERIALFLAG_NODRAW 0x00000200
93 // probably used only on q1bsp water
94 #define MATERIALFLAG_LIGHTBOTHSIDES 0x00000400
95 // use alpha test on this material
96 #define MATERIALFLAG_ALPHATEST 0x00000800
97 // treat this material as a blended transparency (as opposed to an alpha test
98 // transparency), this causes special fog behavior, and disables glDepthMask
99 #define MATERIALFLAG_BLENDED 0x00001000
100 // render using a custom blendfunc
101 #define MATERIALFLAG_CUSTOMBLEND 0x00002000
102 // do not cast shadows from this material
103 #define MATERIALFLAG_NOSHADOW 0x00004000
104 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
105 #define MATERIALFLAG_VERTEXTEXTUREBLEND 0x00008000
106 // disables GL_CULL_FACE on this texture (making it double sided)
107 #define MATERIALFLAG_NOCULLFACE 0x00010000
108 // render with a very short depth range (like 10% of normal), this causes entities to appear infront of most of the scene
109 #define MATERIALFLAG_SHORTDEPTHRANGE 0x00020000
110 // render water, comprising refraction and reflection (note: this is always opaque, the shader does the alpha effect)
111 #define MATERIALFLAG_WATERSHADER 0x00040000
112 // render refraction (note: this is just a way to distort the background, otherwise useless)
113 #define MATERIALFLAG_REFRACTION 0x00080000
115 #define MATERIALFLAG_REFLECTION 0x00100000
116 // use model lighting on this material (q1bsp lightmap sampling or q3bsp lightgrid, implies FULLBRIGHT is false)
117 #define MATERIALFLAG_MODELLIGHT 0x00200000
118 // causes RSurf_GetCurrentTexture to leave alone certain fields
119 #define MATERIALFLAG_CUSTOMSURFACE 0x00800000
120 // causes MATERIALFLAG_BLENDED to render a depth pass before rendering, hiding backfaces and other hidden geometry
121 #define MATERIALFLAG_TRANSDEPTH 0x01000000
122 // like refraction, but doesn't distort etc.
123 #define MATERIALFLAG_CAMERA 0x02000000
124 // disable rtlight on surface - does not disable other types of lighting (LIGHTMAP, MODELLIGHT)
125 #define MATERIALFLAG_NORTLIGHT 0x04000000
126 // alphagen vertex - should always be used with MATERIALFLAG_ALPHA | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW (or MATERIALFLAG_ADD instead of MATERIALFLAG_ALPHA)
127 #define MATERIALFLAG_ALPHAGEN_VERTEX 0x08000000
128 // use occlusion buffer for corona
129 #define MATERIALFLAG_OCCLUDE 0x10000000
130 // use vertex color instead of lighting (e.g. particles and other glowy stuff), use with MATERIALFLAG_FULLBRIGHT
131 #define MATERIALFLAG_VERTEXCOLOR 0x20000000
132 // sample the q3bsp lightgrid in the shader rather than relying on MATERIALFLAG_MODELLIGHT
133 #define MATERIALFLAG_LIGHTGRID 0x40000000
134 // combined mask of all attributes that require depth sorted rendering
135 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
136 // combined mask of all attributes that cause some sort of transparency
137 #define MATERIALFLAGMASK_TRANSLUCENT (MATERIALFLAG_WATERALPHA | MATERIALFLAG_SKY | MATERIALFLAG_NODRAW | MATERIALFLAG_ALPHATEST | MATERIALFLAG_BLENDED | MATERIALFLAG_WATERSHADER | MATERIALFLAG_REFRACTION)
139 typedef struct medge_s
145 struct entity_render_s;
149 typedef struct mnode_s
151 //this part shared between node and leaf
152 mplane_t *plane; // != NULL
153 struct mnode_s *parent;
154 struct mportal_s *portals;
155 // for bounding box culling
158 // supercontents from all brushes inside this node or leaf
159 int combinedsupercontents;
161 // this part unique to node
162 struct mnode_s *children[2];
165 unsigned int firstsurface;
166 unsigned int numsurfaces;
170 typedef struct mleaf_s
172 //this part shared between node and leaf
173 mplane_t *plane; // == NULL
174 struct mnode_s *parent;
175 struct mportal_s *portals;
176 // for bounding box culling
179 // supercontents from all brushes inside this node or leaf
180 int combinedsupercontents;
182 // this part unique to leaf
184 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
185 int areaindex; // q3bsp
186 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
188 int *firstleafsurface;
189 int numleafbrushes; // q3bsp
190 int *firstleafbrush; // q3bsp
191 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
192 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
193 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
197 typedef struct mclipnode_s
200 int children[2]; // negative numbers are contents
203 typedef struct hull_s
205 mclipnode_t *clipnodes;
215 typedef struct mportal_s
217 struct mportal_s *next; // the next portal on this leaf
218 mleaf_t *here; // the leaf this portal is on
219 mleaf_t *past; // the leaf through this portal (infront)
222 vec3_t mins, maxs; // culling
224 double tracetime; // refreshed to realtime by traceline tests
228 typedef struct svbspmesh_s
230 struct svbspmesh_s *next;
231 int numverts, maxverts;
232 int numtriangles, maxtriangles;
240 #define Q2BSPMAGIC ('I' + 'B' * 256 + 'S' * 65536 + 'P' * 16777216)
241 #define Q2BSPVERSION 38
243 // leaffaces, leafbrushes, planes, and verts are still bounded by
244 // 16 bit short limits
246 //=============================================================================
248 #define Q2LUMP_ENTITIES 0
249 #define Q2LUMP_PLANES 1
250 #define Q2LUMP_VERTEXES 2
251 #define Q2LUMP_VISIBILITY 3
252 #define Q2LUMP_NODES 4
253 #define Q2LUMP_TEXINFO 5
254 #define Q2LUMP_FACES 6
255 #define Q2LUMP_LIGHTING 7
256 #define Q2LUMP_LEAFS 8
257 #define Q2LUMP_LEAFFACES 9
258 #define Q2LUMP_LEAFBRUSHES 10
259 #define Q2LUMP_EDGES 11
260 #define Q2LUMP_SURFEDGES 12
261 #define Q2LUMP_MODELS 13
262 #define Q2LUMP_BRUSHES 14
263 #define Q2LUMP_BRUSHSIDES 15
264 #define Q2LUMP_POP 16
265 #define Q2LUMP_AREAS 17
266 #define Q2LUMP_AREAPORTALS 18
267 #define Q2HEADER_LUMPS 19
269 typedef struct q2dheader_s
273 lump_t lumps[Q2HEADER_LUMPS];
276 typedef struct q2dmodel_s
278 float mins[3], maxs[3];
279 float origin[3]; // for sounds or lights
281 int firstface, numfaces; // submodels just draw faces
282 // without walking the bsp tree
285 // planes (x&~1) and (x&~1)+1 are always opposites
287 // contents flags are seperate bits
288 // a given brush can contribute multiple content bits
289 // multiple brushes can be in a single leaf
291 // these definitions also need to be in q_shared.h!
293 // lower bits are stronger, and will eat weaker brushes completely
294 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
295 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
296 #define Q2CONTENTS_AUX 4
297 #define Q2CONTENTS_LAVA 8
298 #define Q2CONTENTS_SLIME 16
299 #define Q2CONTENTS_WATER 32
300 #define Q2CONTENTS_MIST 64
301 #define Q2LAST_VISIBLE_CONTENTS 64
303 // remaining contents are non-visible, and don't eat brushes
305 #define Q2CONTENTS_AREAPORTAL 0x8000
307 #define Q2CONTENTS_PLAYERCLIP 0x10000
308 #define Q2CONTENTS_MONSTERCLIP 0x20000
310 // currents can be added to any other contents, and may be mixed
311 #define Q2CONTENTS_CURRENT_0 0x40000
312 #define Q2CONTENTS_CURRENT_90 0x80000
313 #define Q2CONTENTS_CURRENT_180 0x100000
314 #define Q2CONTENTS_CURRENT_270 0x200000
315 #define Q2CONTENTS_CURRENT_UP 0x400000
316 #define Q2CONTENTS_CURRENT_DOWN 0x800000
318 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
320 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
321 #define Q2CONTENTS_DEADMONSTER 0x4000000
322 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
323 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
324 #define Q2CONTENTS_LADDER 0x20000000
328 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
330 #define Q2SURF_SLICK 0x2 // effects game physics
332 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
333 #define Q2SURF_WARP 0x8 // turbulent water warp
334 #define Q2SURF_TRANS33 0x10
335 #define Q2SURF_TRANS66 0x20
336 #define Q2SURF_FLOWING 0x40 // scroll towards angle
337 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
339 #define Q2SURF_HINT 0x100 // make a primary bsp splitter
340 #define Q2SURF_SKIP 0x200 // completely ignore, allowing non-closed brushes
342 #define Q2SURF_ALPHATEST 0x02000000 // alpha test masking of color 255 in wal textures (supported by modded engines)
346 typedef struct q2dnode_s
349 int children[2]; // negative numbers are -(leafs+1), not nodes
350 short mins[3]; // for frustom culling
352 unsigned short firstface;
353 unsigned short numfaces; // counting both sides
356 typedef struct q2texinfo_s
358 float vecs[2][4]; // [s/t][xyz offset]
359 int flags; // miptex flags + overrides
360 int value; // light emission, etc
361 char texture[32]; // texture name (textures/something.wal)
362 int nexttexinfo; // for animations, -1 = end of chain
365 typedef struct q2dleaf_s
367 int contents; // OR of all brushes (not needed?)
372 short mins[3]; // for frustum culling
375 unsigned short firstleafface;
376 unsigned short numleaffaces;
378 unsigned short firstleafbrush;
379 unsigned short numleafbrushes;
382 typedef struct q2dbrushside_s
384 unsigned short planenum; // facing out of the leaf
388 typedef struct q2dbrush_s
396 // the visibility lump consists of a header with a count, then
397 // byte offsets for the PVS and PHS of each cluster, then the raw
398 // compressed bit vectors
401 typedef struct q2dvis_s
404 int bitofs[8][2]; // bitofs[numclusters][2]
407 // each area has a list of portals that lead into other areas
408 // when portals are closed, other areas may not be visible or
409 // hearable even if the vis info says that it should be
410 typedef struct q2dareaportal_s
416 typedef struct q2darea_s
426 #define Q3BSPVERSION 46
427 #define Q3BSPVERSION_LIVE 47
428 #define Q3BSPVERSION_IG 48
430 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
431 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
432 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
433 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
434 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
435 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
436 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
437 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
438 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
439 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
440 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
441 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
442 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
443 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
444 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
445 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
446 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
447 #define Q3HEADER_LUMPS 17
448 #define Q3LUMP_ADVERTISEMENTS 17 // quake live stuff written by zeroradiant's q3map2 (ignored by DP)
449 #define Q3HEADER_LUMPS_LIVE 18
450 #define Q3HEADER_LUMPS_MAX 18
452 typedef struct q3dheader_s
456 lump_t lumps[Q3HEADER_LUMPS_MAX];
459 typedef struct q3dtexture_s
461 char name[Q3PATHLENGTH];
467 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
468 typedef struct q3dplane_s
475 typedef struct q3dnode_s
478 int childrenindex[2];
484 typedef struct q3dleaf_s
486 int clusterindex; // pvs index
487 int areaindex; // area index
497 typedef struct q3dmodel_s
508 typedef struct q3dbrush_s
516 typedef struct q3dbrushside_s
523 typedef struct q3dbrushside_ig_s
531 typedef struct q3dvertex_s
537 unsigned char color4ub[4];
541 typedef struct q3dmeshvertex_s
543 int offset; // first vertex index of mesh
547 typedef struct q3deffect_s
549 char shadername[Q3PATHLENGTH];
551 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
555 #define Q3FACETYPE_FLAT 1 // common
556 #define Q3FACETYPE_PATCH 2 // common
557 #define Q3FACETYPE_MESH 3 // common
558 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
560 typedef struct q3dface_s
563 int effectindex; // -1 if none
564 int type; // Q3FACETYPE
569 int lightmapindex; // -1 if none
570 int lightmap_base[2];
571 int lightmap_size[2];
576 // corrupt or don't care
583 // mesh is a collection of triangles on a plane, renderable as a mesh (NOT a polygon)
584 float lightmap_origin[3];
585 float lightmap_vectors[2][3];
593 // patch renders as a bezier mesh, with adjustable tesselation
594 // level (optionally based on LOD using the bbox and polygon
595 // count to choose a tesselation level)
596 // note: multiple patches may have the same bbox to cause them to
597 // be LOD adjusted together as a group
599 float mins[3]; // LOD bbox
600 float maxs[3]; // LOD bbox
602 int patchsize[2]; // dimensions of vertex grid
608 // mesh renders as simply a triangle mesh
618 // flare renders as a simple sprite at origin, no geometry
619 // exists, nor does it have a radius, a cvar controls the radius
620 // and another cvar controls distance fade
621 // (they were not used in Q3 I'm told)
631 typedef struct q3dlightmap_s
633 unsigned char rgb[128*128*3];
637 typedef struct q3dlightgrid_s
639 unsigned char ambientrgb[3];
640 unsigned char diffusergb[3];
641 unsigned char diffusepitch;
642 unsigned char diffuseyaw;
646 typedef struct q3dpvs_s
650 // unsigned char chains[];
651 // containing bits in 0-7 order (not 7-0 order),
652 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
656 // surfaceflags from bsp
657 #define Q3SURFACEFLAG_NODAMAGE 1
658 #define Q3SURFACEFLAG_SLICK 2
659 #define Q3SURFACEFLAG_SKY 4
660 #define Q3SURFACEFLAG_LADDER 8 // has no surfaceparm
661 #define Q3SURFACEFLAG_NOIMPACT 16
662 #define Q3SURFACEFLAG_NOMARKS 32
663 #define Q3SURFACEFLAG_FLESH 64 // has no surfaceparm
664 #define Q3SURFACEFLAG_NODRAW 128
665 #define Q3SURFACEFLAG_HINT 256
666 #define Q3SURFACEFLAG_SKIP 512 // has no surfaceparm
667 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
668 #define Q3SURFACEFLAG_POINTLIGHT 2048
669 #define Q3SURFACEFLAG_METALSTEPS 4096
670 #define Q3SURFACEFLAG_NOSTEPS 8192 // has no surfaceparm
671 #define Q3SURFACEFLAG_NONSOLID 16384
672 #define Q3SURFACEFLAG_LIGHTFILTER 32768
673 #define Q3SURFACEFLAG_ALPHASHADOW 65536
674 #define Q3SURFACEFLAG_NODLIGHT 131072
675 #define Q3SURFACEFLAG_DUST 262144
677 // surfaceparms from shaders
678 #define Q3SURFACEPARM_ALPHASHADOW 1
679 #define Q3SURFACEPARM_AREAPORTAL 2
680 #define Q3SURFACEPARM_CLUSTERPORTAL 4
681 #define Q3SURFACEPARM_DETAIL 8
682 #define Q3SURFACEPARM_DONOTENTER 16
683 #define Q3SURFACEPARM_FOG 32
684 #define Q3SURFACEPARM_LAVA 64
685 #define Q3SURFACEPARM_LIGHTFILTER 128
686 #define Q3SURFACEPARM_METALSTEPS 256
687 #define Q3SURFACEPARM_NODAMAGE 512
688 #define Q3SURFACEPARM_NODLIGHT 1024
689 #define Q3SURFACEPARM_NODRAW 2048
690 #define Q3SURFACEPARM_NODROP 4096
691 #define Q3SURFACEPARM_NOIMPACT 8192
692 #define Q3SURFACEPARM_NOLIGHTMAP 16384
693 #define Q3SURFACEPARM_NOMARKS 32768
694 #define Q3SURFACEPARM_NOMIPMAPS 65536
695 #define Q3SURFACEPARM_NONSOLID 131072
696 #define Q3SURFACEPARM_ORIGIN 262144
697 #define Q3SURFACEPARM_PLAYERCLIP 524288
698 #define Q3SURFACEPARM_SKY 1048576
699 #define Q3SURFACEPARM_SLICK 2097152
700 #define Q3SURFACEPARM_SLIME 4194304
701 #define Q3SURFACEPARM_STRUCTURAL 8388608
702 #define Q3SURFACEPARM_TRANS 16777216
703 #define Q3SURFACEPARM_WATER 33554432
704 #define Q3SURFACEPARM_POINTLIGHT 67108864
705 #define Q3SURFACEPARM_HINT 134217728
706 #define Q3SURFACEPARM_DUST 268435456
707 #define Q3SURFACEPARM_BOTCLIP 536870912
708 #define Q3SURFACEPARM_LIGHTGRID 1073741824
709 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
711 typedef struct q3mbrush_s
713 struct colbrushf_s *colbrushf;
715 struct q3mbrushside_s *firstbrushside;
716 struct texture_s *texture;
720 typedef struct q3mbrushside_s
722 struct mplane_s *plane;
723 struct texture_s *texture;
727 // the first cast is to shut up a stupid warning by clang, the second cast is to make both sides have the same type
728 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : (unsigned char) false)
729 #define SETPVSBIT(pvs,b) (void) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : (unsigned char) false)
730 #define CLEARPVSBIT(pvs,b) (void) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : (unsigned char) false)