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
54 int type; // set by PlaneClassify()
55 int signbits; // set by PlaneClassify()
59 #define SHADERSTAGE_SKY 0
60 #define SHADERSTAGE_NORMAL 1
61 #define SHADERSTAGE_COUNT 2
63 //#define SURF_PLANEBACK 2
65 // indicates that all triangles of the surface should be added to the BIH collision system
66 #define MATERIALFLAG_MESHCOLLISIONS 1
67 // use alpha blend on this material
68 #define MATERIALFLAG_ALPHA 2
69 // use additive blend on this material
70 #define MATERIALFLAG_ADD 4
71 // turn off depth test on this material
72 #define MATERIALFLAG_NODEPTHTEST 8
73 // multiply alpha by r_wateralpha cvar
74 #define MATERIALFLAG_WATERALPHA 16
75 // draw with no lighting
76 #define MATERIALFLAG_FULLBRIGHT 32
77 // drawn as a normal surface (alternative to SKY)
78 #define MATERIALFLAG_WALL 64
79 // this surface shows the sky in its place, alternative to WALL
80 // skipped if transparent
81 #define MATERIALFLAG_SKY 128
82 // swirling water effect (used with MATERIALFLAG_WALL)
83 #define MATERIALFLAG_WATERSCROLL 256
84 // skips drawing the surface
85 #define MATERIALFLAG_NODRAW 512
86 // probably used only on q1bsp water
87 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
88 // use alpha test on this material
89 #define MATERIALFLAG_ALPHATEST 2048
90 // treat this material as a blended transparency (as opposed to an alpha test
91 // transparency), this causes special fog behavior, and disables glDepthMask
92 #define MATERIALFLAG_BLENDED 4096
93 // render using a custom blendfunc
94 #define MATERIALFLAG_CUSTOMBLEND 8192
95 // do not cast shadows from this material
96 #define MATERIALFLAG_NOSHADOW 16384
97 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
98 #define MATERIALFLAG_VERTEXTEXTUREBLEND 32768
99 // disables GL_CULL_FACE on this texture (making it double sided)
100 #define MATERIALFLAG_NOCULLFACE 65536
101 // render with a very short depth range (like 10% of normal), this causes entities to appear infront of most of the scene
102 #define MATERIALFLAG_SHORTDEPTHRANGE 131072
103 // render water, comprising refraction and reflection (note: this is always opaque, the shader does the alpha effect)
104 #define MATERIALFLAG_WATERSHADER 262144
105 // render refraction (note: this is just a way to distort the background, otherwise useless)
106 #define MATERIALFLAG_REFRACTION 524288
108 #define MATERIALFLAG_REFLECTION 1048576
109 // use model lighting on this material (q1bsp lightmap sampling or q3bsp lightgrid, implies FULLBRIGHT is false)
110 #define MATERIALFLAG_MODELLIGHT 4194304
111 // add directional model lighting to this material (q3bsp lightgrid only)
112 #define MATERIALFLAG_MODELLIGHT_DIRECTIONAL 8388608
113 // causes RSurf_GetCurrentTexture to leave alone certain fields
114 #define MATERIALFLAG_CUSTOMSURFACE 16777216
115 // causes MATERIALFLAG_BLENDED to render a depth pass before rendering, hiding backfaces and other hidden geometry
116 #define MATERIALFLAG_TRANSDEPTH 33554432
117 // like refraction, but doesn't distort etc.
118 #define MATERIALFLAG_CAMERA 67108864
119 // disable rtlight on surface, use R_LightPoint instead
120 #define MATERIALFLAG_NORTLIGHT 134217728
121 // combined mask of all attributes that require depth sorted rendering
122 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
123 // combined mask of all attributes that cause some sort of transparency
124 #define MATERIALFLAGMASK_TRANSLUCENT (MATERIALFLAG_WATERALPHA | MATERIALFLAG_SKY | MATERIALFLAG_NODRAW | MATERIALFLAG_ALPHATEST | MATERIALFLAG_BLENDED | MATERIALFLAG_WATERSHADER | MATERIALFLAG_REFRACTION)
126 typedef struct medge_s
132 struct entity_render_s;
136 typedef struct mnode_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 node
149 struct mnode_s *children[2];
152 unsigned short firstsurface;
153 unsigned short numsurfaces;
157 typedef struct mleaf_s
159 //this part shared between node and leaf
160 mplane_t *plane; // == NULL
161 struct mnode_s *parent;
162 struct mportal_s *portals;
163 // for bounding box culling
166 // supercontents from all brushes inside this node or leaf
167 int combinedsupercontents;
169 // this part unique to leaf
171 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
172 int areaindex; // q3bsp
173 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
175 int *firstleafsurface;
176 int numleafbrushes; // q3bsp
177 int *firstleafbrush; // q3bsp
178 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
179 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
180 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
184 typedef struct mclipnode_s
187 int children[2]; // negative numbers are contents
190 typedef struct hull_s
192 mclipnode_t *clipnodes;
202 typedef struct mportal_s
204 struct mportal_s *next; // the next portal on this leaf
205 mleaf_t *here; // the leaf this portal is on
206 mleaf_t *past; // the leaf through this portal (infront)
209 vec3_t mins, maxs; // culling
214 typedef struct svbspmesh_s
216 struct svbspmesh_s *next;
217 int numverts, maxverts;
218 int numtriangles, maxtriangles;
226 #define Q2BSPVERSION 38
228 // leaffaces, leafbrushes, planes, and verts are still bounded by
229 // 16 bit short limits
231 //=============================================================================
233 #define Q2LUMP_ENTITIES 0
234 #define Q2LUMP_PLANES 1
235 #define Q2LUMP_VERTEXES 2
236 #define Q2LUMP_VISIBILITY 3
237 #define Q2LUMP_NODES 4
238 #define Q2LUMP_TEXINFO 5
239 #define Q2LUMP_FACES 6
240 #define Q2LUMP_LIGHTING 7
241 #define Q2LUMP_LEAFS 8
242 #define Q2LUMP_LEAFFACES 9
243 #define Q2LUMP_LEAFBRUSHES 10
244 #define Q2LUMP_EDGES 11
245 #define Q2LUMP_SURFEDGES 12
246 #define Q2LUMP_MODELS 13
247 #define Q2LUMP_BRUSHES 14
248 #define Q2LUMP_BRUSHSIDES 15
249 #define Q2LUMP_POP 16
250 #define Q2LUMP_AREAS 17
251 #define Q2LUMP_AREAPORTALS 18
252 #define Q2HEADER_LUMPS 19
254 typedef struct q2dheader_s
258 lump_t lumps[Q2HEADER_LUMPS];
261 typedef struct q2dmodel_s
263 float mins[3], maxs[3];
264 float origin[3]; // for sounds or lights
266 int firstface, numfaces; // submodels just draw faces
267 // without walking the bsp tree
270 // planes (x&~1) and (x&~1)+1 are always opposites
272 // contents flags are seperate bits
273 // a given brush can contribute multiple content bits
274 // multiple brushes can be in a single leaf
276 // these definitions also need to be in q_shared.h!
278 // lower bits are stronger, and will eat weaker brushes completely
279 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
280 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
281 #define Q2CONTENTS_AUX 4
282 #define Q2CONTENTS_LAVA 8
283 #define Q2CONTENTS_SLIME 16
284 #define Q2CONTENTS_WATER 32
285 #define Q2CONTENTS_MIST 64
286 #define Q2LAST_VISIBLE_CONTENTS 64
288 // remaining contents are non-visible, and don't eat brushes
290 #define Q2CONTENTS_AREAPORTAL 0x8000
292 #define Q2CONTENTS_PLAYERCLIP 0x10000
293 #define Q2CONTENTS_MONSTERCLIP 0x20000
295 // currents can be added to any other contents, and may be mixed
296 #define Q2CONTENTS_CURRENT_0 0x40000
297 #define Q2CONTENTS_CURRENT_90 0x80000
298 #define Q2CONTENTS_CURRENT_180 0x100000
299 #define Q2CONTENTS_CURRENT_270 0x200000
300 #define Q2CONTENTS_CURRENT_UP 0x400000
301 #define Q2CONTENTS_CURRENT_DOWN 0x800000
303 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
305 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
306 #define Q2CONTENTS_DEADMONSTER 0x4000000
307 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
308 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
309 #define Q2CONTENTS_LADDER 0x20000000
313 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
315 #define Q2SURF_SLICK 0x2 // effects game physics
317 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
318 #define Q2SURF_WARP 0x8 // turbulent water warp
319 #define Q2SURF_TRANS33 0x10
320 #define Q2SURF_TRANS66 0x20
321 #define Q2SURF_FLOWING 0x40 // scroll towards angle
322 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
327 typedef struct q2dnode_s
330 int children[2]; // negative numbers are -(leafs+1), not nodes
331 short mins[3]; // for frustom culling
333 unsigned short firstface;
334 unsigned short numfaces; // counting both sides
338 typedef struct q2texinfo_s
340 float vecs[2][4]; // [s/t][xyz offset]
341 int flags; // miptex flags + overrides
342 int value; // light emission, etc
343 char texture[32]; // texture name (textures/*.wal)
344 int nexttexinfo; // for animations, -1 = end of chain
347 typedef struct q2dleaf_s
349 int contents; // OR of all brushes (not needed?)
354 short mins[3]; // for frustum culling
357 unsigned short firstleafface;
358 unsigned short numleaffaces;
360 unsigned short firstleafbrush;
361 unsigned short numleafbrushes;
364 typedef struct q2dbrushside_s
366 unsigned short planenum; // facing out of the leaf
370 typedef struct q2dbrush_s
378 // the visibility lump consists of a header with a count, then
379 // byte offsets for the PVS and PHS of each cluster, then the raw
380 // compressed bit vectors
383 typedef struct q2dvis_s
386 int bitofs[8][2]; // bitofs[numclusters][2]
389 // each area has a list of portals that lead into other areas
390 // when portals are closed, other areas may not be visible or
391 // hearable even if the vis info says that it should be
392 typedef struct q2dareaportal_s
398 typedef struct q2darea_s
407 #define Q3BSPVERSION 46
408 #define Q3BSPVERSION_LIVE 47
409 #define Q3BSPVERSION_IG 48
411 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
412 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
413 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
414 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
415 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
416 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
417 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
418 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
419 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
420 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
421 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
422 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
423 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
424 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
425 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
426 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
427 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
428 #define Q3HEADER_LUMPS 17
429 #define Q3LUMP_ADVERTISEMENTS 17 // quake live stuff written by zeroradiant's q3map2 (ignored by DP)
430 #define Q3HEADER_LUMPS_LIVE 18
431 #define Q3HEADER_LUMPS_MAX 18
433 typedef struct q3dheader_s
437 lump_t lumps[Q3HEADER_LUMPS_MAX];
440 typedef struct q3dtexture_s
442 char name[Q3PATHLENGTH];
448 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
449 typedef struct q3dplane_s
456 typedef struct q3dnode_s
459 int childrenindex[2];
465 typedef struct q3dleaf_s
467 int clusterindex; // pvs index
468 int areaindex; // area index
478 typedef struct q3dmodel_s
489 typedef struct q3dbrush_s
497 typedef struct q3dbrushside_s
504 typedef struct q3dbrushside_ig_s
512 typedef struct q3dvertex_s
518 unsigned char color4ub[4];
522 typedef struct q3dmeshvertex_s
524 int offset; // first vertex index of mesh
528 typedef struct q3deffect_s
530 char shadername[Q3PATHLENGTH];
532 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
536 #define Q3FACETYPE_FLAT 1 // common
537 #define Q3FACETYPE_PATCH 2 // common
538 #define Q3FACETYPE_MESH 3 // common
539 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
541 typedef struct q3dface_s
544 int effectindex; // -1 if none
545 int type; // Q3FACETYPE
550 int lightmapindex; // -1 if none
551 int lightmap_base[2];
552 int lightmap_size[2];
557 // corrupt or don't care
564 // mesh is a collection of triangles on a plane, renderable as a mesh (NOT a polygon)
565 float lightmap_origin[3];
566 float lightmap_vectors[2][3];
574 // patch renders as a bezier mesh, with adjustable tesselation
575 // level (optionally based on LOD using the bbox and polygon
576 // count to choose a tesselation level)
577 // note: multiple patches may have the same bbox to cause them to
578 // be LOD adjusted together as a group
580 float mins[3]; // LOD bbox
581 float maxs[3]; // LOD bbox
583 int patchsize[2]; // dimensions of vertex grid
589 // mesh renders as simply a triangle mesh
599 // flare renders as a simple sprite at origin, no geometry
600 // exists, nor does it have a radius, a cvar controls the radius
601 // and another cvar controls distance fade
602 // (they were not used in Q3 I'm told)
612 typedef struct q3dlightmap_s
614 unsigned char rgb[128*128*3];
618 typedef struct q3dlightgrid_s
620 unsigned char ambientrgb[3];
621 unsigned char diffusergb[3];
622 unsigned char diffusepitch;
623 unsigned char diffuseyaw;
627 typedef struct q3dpvs_s
631 // unsigned char chains[];
632 // containing bits in 0-7 order (not 7-0 order),
633 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
637 // surfaceflags from bsp
638 #define Q3SURFACEFLAG_NODAMAGE 1
639 #define Q3SURFACEFLAG_SLICK 2
640 #define Q3SURFACEFLAG_SKY 4
641 #define Q3SURFACEFLAG_LADDER 8
642 #define Q3SURFACEFLAG_NOIMPACT 16
643 #define Q3SURFACEFLAG_NOMARKS 32
644 #define Q3SURFACEFLAG_FLESH 64
645 #define Q3SURFACEFLAG_NODRAW 128
646 #define Q3SURFACEFLAG_HINT 256
647 #define Q3SURFACEFLAG_SKIP 512
648 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
649 #define Q3SURFACEFLAG_POINTLIGHT 2048
650 #define Q3SURFACEFLAG_METALSTEPS 4096
651 #define Q3SURFACEFLAG_NOSTEPS 8192
652 #define Q3SURFACEFLAG_NONSOLID 16384
653 #define Q3SURFACEFLAG_LIGHTFILTER 32768
654 #define Q3SURFACEFLAG_ALPHASHADOW 65536
655 #define Q3SURFACEFLAG_NODLIGHT 131072
656 #define Q3SURFACEFLAG_DUST 262144
658 // surfaceparms from shaders
659 #define Q3SURFACEPARM_ALPHASHADOW 1
660 #define Q3SURFACEPARM_AREAPORTAL 2
661 #define Q3SURFACEPARM_CLUSTERPORTAL 4
662 #define Q3SURFACEPARM_DETAIL 8
663 #define Q3SURFACEPARM_DONOTENTER 16
664 #define Q3SURFACEPARM_FOG 32
665 #define Q3SURFACEPARM_LAVA 64
666 #define Q3SURFACEPARM_LIGHTFILTER 128
667 #define Q3SURFACEPARM_METALSTEPS 256
668 #define Q3SURFACEPARM_NODAMAGE 512
669 #define Q3SURFACEPARM_NODLIGHT 1024
670 #define Q3SURFACEPARM_NODRAW 2048
671 #define Q3SURFACEPARM_NODROP 4096
672 #define Q3SURFACEPARM_NOIMPACT 8192
673 #define Q3SURFACEPARM_NOLIGHTMAP 16384
674 #define Q3SURFACEPARM_NOMARKS 32768
675 #define Q3SURFACEPARM_NOMIPMAPS 65536
676 #define Q3SURFACEPARM_NONSOLID 131072
677 #define Q3SURFACEPARM_ORIGIN 262144
678 #define Q3SURFACEPARM_PLAYERCLIP 524288
679 #define Q3SURFACEPARM_SKY 1048576
680 #define Q3SURFACEPARM_SLICK 2097152
681 #define Q3SURFACEPARM_SLIME 4194304
682 #define Q3SURFACEPARM_STRUCTURAL 8388608
683 #define Q3SURFACEPARM_TRANS 16777216
684 #define Q3SURFACEPARM_WATER 33554432
685 #define Q3SURFACEPARM_POINTLIGHT 67108864
686 #define Q3SURFACEPARM_HINT 134217728
687 #define Q3SURFACEPARM_DUST 268435456
688 #define Q3SURFACEPARM_BOTCLIP 536870912
689 #define Q3SURFACEPARM_LIGHTGRID 1073741824
690 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
692 typedef struct q3mbrush_s
694 struct colbrushf_s *colbrushf;
696 struct q3mbrushside_s *firstbrushside;
697 struct texture_s *texture;
701 typedef struct q3mbrushside_s
703 struct mplane_s *plane;
704 struct texture_s *texture;
708 // the first cast is to shut up a stupid warning by clang, the second cast is to make both sides have the same type
709 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : (unsigned char) false)
710 #define SETPVSBIT(pvs,b) (void) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : (unsigned char) false)
711 #define CLEARPVSBIT(pvs,b) (void) ((b) >= 0 ? (unsigned char) ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : (unsigned char) false)