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 // render water, comprising refraction and reflection (note: this is always opaque, the shader does the alpha effect)
102 #define MATERIALFLAG_WATERSHADER 262144
103 // render refraction (note: this is just a way to distort the background, otherwise useless)
104 #define MATERIALFLAG_REFRACTION 524288
106 #define MATERIALFLAG_REFLECTION 1048576
107 // render water, comprising refraction and reflection (note: this is always opaque, the shader does the alpha effect)
108 #define MATERIALFLAG_SORTTRANSPARENT 2097152
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 // combined mask of all attributes that require depth sorted rendering
114 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_SORTTRANSPARENT | MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
116 typedef struct medge_s
122 struct entity_render_s;
126 typedef struct mnode_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
135 // supercontents from all brushes inside this node or leaf
136 int combinedsupercontents;
138 // this part unique to node
139 struct mnode_s *children[2];
142 unsigned short firstsurface;
143 unsigned short numsurfaces;
147 typedef struct mleaf_s
149 //this part shared between node and leaf
150 mplane_t *plane; // == NULL
151 struct mnode_s *parent;
152 struct mportal_s *portals;
153 // for bounding box culling
156 // supercontents from all brushes inside this node or leaf
157 int combinedsupercontents;
159 // this part unique to leaf
161 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
162 int areaindex; // q3bsp
163 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
165 int *firstleafsurface;
166 int numleafbrushes; // q3bsp
167 int *firstleafbrush; // q3bsp
168 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
169 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
170 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
174 typedef struct mclipnode_s
177 int children[2]; // negative numbers are contents
180 typedef struct hull_s
182 mclipnode_t *clipnodes;
192 typedef struct mportal_s
194 struct mportal_s *next; // the next portal on this leaf
195 mleaf_t *here; // the leaf this portal is on
196 mleaf_t *past; // the leaf through this portal (infront)
199 vec3_t mins, maxs; // culling
204 typedef struct svbspmesh_s
206 struct svbspmesh_s *next;
207 int numverts, maxverts;
208 int numtriangles, maxtriangles;
216 #define Q2BSPVERSION 38
218 // leaffaces, leafbrushes, planes, and verts are still bounded by
219 // 16 bit short limits
221 //=============================================================================
223 #define Q2LUMP_ENTITIES 0
224 #define Q2LUMP_PLANES 1
225 #define Q2LUMP_VERTEXES 2
226 #define Q2LUMP_VISIBILITY 3
227 #define Q2LUMP_NODES 4
228 #define Q2LUMP_TEXINFO 5
229 #define Q2LUMP_FACES 6
230 #define Q2LUMP_LIGHTING 7
231 #define Q2LUMP_LEAFS 8
232 #define Q2LUMP_LEAFFACES 9
233 #define Q2LUMP_LEAFBRUSHES 10
234 #define Q2LUMP_EDGES 11
235 #define Q2LUMP_SURFEDGES 12
236 #define Q2LUMP_MODELS 13
237 #define Q2LUMP_BRUSHES 14
238 #define Q2LUMP_BRUSHSIDES 15
239 #define Q2LUMP_POP 16
240 #define Q2LUMP_AREAS 17
241 #define Q2LUMP_AREAPORTALS 18
242 #define Q2HEADER_LUMPS 19
244 typedef struct q2dheader_s
248 lump_t lumps[Q2HEADER_LUMPS];
251 typedef struct q2dmodel_s
253 float mins[3], maxs[3];
254 float origin[3]; // for sounds or lights
256 int firstface, numfaces; // submodels just draw faces
257 // without walking the bsp tree
260 // planes (x&~1) and (x&~1)+1 are always opposites
262 // contents flags are seperate bits
263 // a given brush can contribute multiple content bits
264 // multiple brushes can be in a single leaf
266 // these definitions also need to be in q_shared.h!
268 // lower bits are stronger, and will eat weaker brushes completely
269 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
270 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
271 #define Q2CONTENTS_AUX 4
272 #define Q2CONTENTS_LAVA 8
273 #define Q2CONTENTS_SLIME 16
274 #define Q2CONTENTS_WATER 32
275 #define Q2CONTENTS_MIST 64
276 #define Q2LAST_VISIBLE_CONTENTS 64
278 // remaining contents are non-visible, and don't eat brushes
280 #define Q2CONTENTS_AREAPORTAL 0x8000
282 #define Q2CONTENTS_PLAYERCLIP 0x10000
283 #define Q2CONTENTS_MONSTERCLIP 0x20000
285 // currents can be added to any other contents, and may be mixed
286 #define Q2CONTENTS_CURRENT_0 0x40000
287 #define Q2CONTENTS_CURRENT_90 0x80000
288 #define Q2CONTENTS_CURRENT_180 0x100000
289 #define Q2CONTENTS_CURRENT_270 0x200000
290 #define Q2CONTENTS_CURRENT_UP 0x400000
291 #define Q2CONTENTS_CURRENT_DOWN 0x800000
293 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
295 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
296 #define Q2CONTENTS_DEADMONSTER 0x4000000
297 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
298 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
299 #define Q2CONTENTS_LADDER 0x20000000
303 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
305 #define Q2SURF_SLICK 0x2 // effects game physics
307 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
308 #define Q2SURF_WARP 0x8 // turbulent water warp
309 #define Q2SURF_TRANS33 0x10
310 #define Q2SURF_TRANS66 0x20
311 #define Q2SURF_FLOWING 0x40 // scroll towards angle
312 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
317 typedef struct q2dnode_s
320 int children[2]; // negative numbers are -(leafs+1), not nodes
321 short mins[3]; // for frustom culling
323 unsigned short firstface;
324 unsigned short numfaces; // counting both sides
328 typedef struct q2texinfo_s
330 float vecs[2][4]; // [s/t][xyz offset]
331 int flags; // miptex flags + overrides
332 int value; // light emission, etc
333 char texture[32]; // texture name (textures/*.wal)
334 int nexttexinfo; // for animations, -1 = end of chain
337 typedef struct q2dleaf_s
339 int contents; // OR of all brushes (not needed?)
344 short mins[3]; // for frustum culling
347 unsigned short firstleafface;
348 unsigned short numleaffaces;
350 unsigned short firstleafbrush;
351 unsigned short numleafbrushes;
354 typedef struct q2dbrushside_s
356 unsigned short planenum; // facing out of the leaf
360 typedef struct q2dbrush_s
368 // the visibility lump consists of a header with a count, then
369 // byte offsets for the PVS and PHS of each cluster, then the raw
370 // compressed bit vectors
373 typedef struct q2dvis_s
376 int bitofs[8][2]; // bitofs[numclusters][2]
379 // each area has a list of portals that lead into other areas
380 // when portals are closed, other areas may not be visible or
381 // hearable even if the vis info says that it should be
382 typedef struct q2dareaportal_s
388 typedef struct q2darea_s
397 #define Q3BSPVERSION 46
399 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
400 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
401 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
402 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
403 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
404 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
405 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
406 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
407 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
408 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
409 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
410 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
411 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
412 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
413 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
414 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
415 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
416 #define Q3HEADER_LUMPS 17
418 typedef struct q3dheader_s
422 lump_t lumps[Q3HEADER_LUMPS];
425 typedef struct q3dtexture_s
427 char name[Q3PATHLENGTH];
433 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
434 typedef struct q3dplane_s
441 typedef struct q3dnode_s
444 int childrenindex[2];
450 typedef struct q3dleaf_s
452 int clusterindex; // pvs index
453 int areaindex; // area index
463 typedef struct q3dmodel_s
474 typedef struct q3dbrush_s
482 typedef struct q3dbrushside_s
489 typedef struct q3dvertex_s
495 unsigned char color4ub[4];
499 typedef struct q3dmeshvertex_s
501 int offset; // first vertex index of mesh
505 typedef struct q3deffect_s
507 char shadername[Q3PATHLENGTH];
509 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
513 #define Q3FACETYPE_POLYGON 1 // common
514 #define Q3FACETYPE_PATCH 2 // common
515 #define Q3FACETYPE_MESH 3 // common
516 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
518 typedef struct q3dface_s
521 int effectindex; // -1 if none
522 int type; // Q3FACETYPE
527 int lightmapindex; // -1 if none
528 int lightmap_base[2];
529 int lightmap_size[2];
534 // corrupt or don't care
540 // Q3FACETYPE_POLYGON
541 // polygon is simply a convex polygon, renderable as a mesh
542 float lightmap_origin[3];
543 float lightmap_vectors[2][3];
551 // patch renders as a bezier mesh, with adjustable tesselation
552 // level (optionally based on LOD using the bbox and polygon
553 // count to choose a tesselation level)
554 // note: multiple patches may have the same bbox to cause them to
555 // be LOD adjusted together as a group
557 float mins[3]; // LOD bbox
558 float maxs[3]; // LOD bbox
560 int patchsize[2]; // dimensions of vertex grid
566 // mesh renders as simply a triangle mesh
576 // flare renders as a simple sprite at origin, no geometry
577 // exists, nor does it have a radius, a cvar controls the radius
578 // and another cvar controls distance fade
579 // (they were not used in Q3 I'm told)
589 typedef struct q3dlightmap_s
591 unsigned char rgb[128*128*3];
595 typedef struct q3dlightgrid_s
597 unsigned char ambientrgb[3];
598 unsigned char diffusergb[3];
599 unsigned char diffusepitch;
600 unsigned char diffuseyaw;
604 typedef struct q3dpvs_s
608 // unsigned char chains[];
609 // containing bits in 0-7 order (not 7-0 order),
610 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
614 // surfaceflags from bsp
615 #define Q3SURFACEFLAG_NODAMAGE 1
616 #define Q3SURFACEFLAG_SLICK 2
617 #define Q3SURFACEFLAG_SKY 4
618 #define Q3SURFACEFLAG_LADDER 8
619 #define Q3SURFACEFLAG_NOIMPACT 16
620 #define Q3SURFACEFLAG_NOMARKS 32
621 #define Q3SURFACEFLAG_FLESH 64
622 #define Q3SURFACEFLAG_NODRAW 128
623 #define Q3SURFACEFLAG_HINT 256
624 #define Q3SURFACEFLAG_SKIP 512
625 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
626 #define Q3SURFACEFLAG_POINTLIGHT 2048
627 #define Q3SURFACEFLAG_METALSTEPS 4096
628 #define Q3SURFACEFLAG_NOSTEPS 8192
629 #define Q3SURFACEFLAG_NONSOLID 16384
630 #define Q3SURFACEFLAG_LIGHTFILTER 32768
631 #define Q3SURFACEFLAG_ALPHASHADOW 65536
632 #define Q3SURFACEFLAG_NODLIGHT 131072
633 #define Q3SURFACEFLAG_DUST 262144
635 // surfaceparms from shaders
636 #define Q3SURFACEPARM_ALPHASHADOW 1
637 #define Q3SURFACEPARM_AREAPORTAL 2
638 #define Q3SURFACEPARM_CLUSTERPORTAL 4
639 #define Q3SURFACEPARM_DETAIL 8
640 #define Q3SURFACEPARM_DONOTENTER 16
641 #define Q3SURFACEPARM_FOG 32
642 #define Q3SURFACEPARM_LAVA 64
643 #define Q3SURFACEPARM_LIGHTFILTER 128
644 #define Q3SURFACEPARM_METALSTEPS 256
645 #define Q3SURFACEPARM_NODAMAGE 512
646 #define Q3SURFACEPARM_NODLIGHT 1024
647 #define Q3SURFACEPARM_NODRAW 2048
648 #define Q3SURFACEPARM_NODROP 4096
649 #define Q3SURFACEPARM_NOIMPACT 8192
650 #define Q3SURFACEPARM_NOLIGHTMAP 16384
651 #define Q3SURFACEPARM_NOMARKS 32768
652 #define Q3SURFACEPARM_NOMIPMAPS 65536
653 #define Q3SURFACEPARM_NONSOLID 131072
654 #define Q3SURFACEPARM_ORIGIN 262144
655 #define Q3SURFACEPARM_PLAYERCLIP 524288
656 #define Q3SURFACEPARM_SKY 1048576
657 #define Q3SURFACEPARM_SLICK 2197152
658 #define Q3SURFACEPARM_SLIME 4194304
659 #define Q3SURFACEPARM_STRUCTURAL 8388608
660 #define Q3SURFACEPARM_TRANS 16777216
661 #define Q3SURFACEPARM_WATER 33554432
662 #define Q3SURFACEPARM_POINTLIGHT 67108864
663 #define Q3SURFACEPARM_HINT 134217728
664 #define Q3SURFACEPARM_DUST 268435456
665 #define Q3SURFACEPARM_BOTCLIP 536870912
666 #define Q3SURFACEPARM_LIGHTGRID 1073741824
667 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
669 typedef struct q3mbrush_s
671 struct colbrushf_s *colbrushf;
673 struct q3mbrushside_s *firstbrushside;
674 struct texture_s *texture;
678 typedef struct q3mbrushside_s
680 struct mplane_s *plane;
681 struct texture_s *texture;
685 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
686 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
687 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)