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 refraction and reflection (note: this is always opaque, the shader does the alpha effect)
102 #define MATERIALFLAG_WATERSHADER 262144
103 // combined mask of all attributes that require depth sorted rendering
104 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
106 typedef struct medge_s
112 struct entity_render_s;
116 typedef struct mnode_s
118 //this part shared between node and leaf
119 mplane_t *plane; // != NULL
120 struct mnode_s *parent;
121 struct mportal_s *portals;
122 // for bounding box culling
125 // supercontents from all brushes inside this node or leaf
126 int combinedsupercontents;
128 // this part unique to node
129 struct mnode_s *children[2];
132 unsigned short firstsurface;
133 unsigned short numsurfaces;
137 typedef struct mleaf_s
139 //this part shared between node and leaf
140 mplane_t *plane; // == NULL
141 struct mnode_s *parent;
142 struct mportal_s *portals;
143 // for bounding box culling
146 // supercontents from all brushes inside this node or leaf
147 int combinedsupercontents;
149 // this part unique to leaf
151 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
152 int areaindex; // q3bsp
153 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
155 int *firstleafsurface;
156 int numleafbrushes; // q3bsp
157 int *firstleafbrush; // q3bsp
158 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
159 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
160 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
164 typedef struct hull_s
166 dclipnode_t *clipnodes;
176 typedef struct mportal_s
178 struct mportal_s *next; // the next portal on this leaf
179 mleaf_t *here; // the leaf this portal is on
180 mleaf_t *past; // the leaf through this portal (infront)
183 vec3_t mins, maxs; // culling
188 typedef struct svbspmesh_s
190 struct svbspmesh_s *next;
191 int numverts, maxverts;
192 int numtriangles, maxtriangles;
200 #define Q2BSPVERSION 38
202 // leaffaces, leafbrushes, planes, and verts are still bounded by
203 // 16 bit short limits
205 //=============================================================================
207 #define Q2LUMP_ENTITIES 0
208 #define Q2LUMP_PLANES 1
209 #define Q2LUMP_VERTEXES 2
210 #define Q2LUMP_VISIBILITY 3
211 #define Q2LUMP_NODES 4
212 #define Q2LUMP_TEXINFO 5
213 #define Q2LUMP_FACES 6
214 #define Q2LUMP_LIGHTING 7
215 #define Q2LUMP_LEAFS 8
216 #define Q2LUMP_LEAFFACES 9
217 #define Q2LUMP_LEAFBRUSHES 10
218 #define Q2LUMP_EDGES 11
219 #define Q2LUMP_SURFEDGES 12
220 #define Q2LUMP_MODELS 13
221 #define Q2LUMP_BRUSHES 14
222 #define Q2LUMP_BRUSHSIDES 15
223 #define Q2LUMP_POP 16
224 #define Q2LUMP_AREAS 17
225 #define Q2LUMP_AREAPORTALS 18
226 #define Q2HEADER_LUMPS 19
228 typedef struct q2dheader_s
232 lump_t lumps[Q2HEADER_LUMPS];
235 typedef struct q2dmodel_s
237 float mins[3], maxs[3];
238 float origin[3]; // for sounds or lights
240 int firstface, numfaces; // submodels just draw faces
241 // without walking the bsp tree
244 // planes (x&~1) and (x&~1)+1 are always opposites
246 // contents flags are seperate bits
247 // a given brush can contribute multiple content bits
248 // multiple brushes can be in a single leaf
250 // these definitions also need to be in q_shared.h!
252 // lower bits are stronger, and will eat weaker brushes completely
253 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
254 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
255 #define Q2CONTENTS_AUX 4
256 #define Q2CONTENTS_LAVA 8
257 #define Q2CONTENTS_SLIME 16
258 #define Q2CONTENTS_WATER 32
259 #define Q2CONTENTS_MIST 64
260 #define Q2LAST_VISIBLE_CONTENTS 64
262 // remaining contents are non-visible, and don't eat brushes
264 #define Q2CONTENTS_AREAPORTAL 0x8000
266 #define Q2CONTENTS_PLAYERCLIP 0x10000
267 #define Q2CONTENTS_MONSTERCLIP 0x20000
269 // currents can be added to any other contents, and may be mixed
270 #define Q2CONTENTS_CURRENT_0 0x40000
271 #define Q2CONTENTS_CURRENT_90 0x80000
272 #define Q2CONTENTS_CURRENT_180 0x100000
273 #define Q2CONTENTS_CURRENT_270 0x200000
274 #define Q2CONTENTS_CURRENT_UP 0x400000
275 #define Q2CONTENTS_CURRENT_DOWN 0x800000
277 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
279 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
280 #define Q2CONTENTS_DEADMONSTER 0x4000000
281 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
282 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
283 #define Q2CONTENTS_LADDER 0x20000000
287 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
289 #define Q2SURF_SLICK 0x2 // effects game physics
291 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
292 #define Q2SURF_WARP 0x8 // turbulent water warp
293 #define Q2SURF_TRANS33 0x10
294 #define Q2SURF_TRANS66 0x20
295 #define Q2SURF_FLOWING 0x40 // scroll towards angle
296 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
301 typedef struct q2dnode_s
304 int children[2]; // negative numbers are -(leafs+1), not nodes
305 short mins[3]; // for frustom culling
307 unsigned short firstface;
308 unsigned short numfaces; // counting both sides
312 typedef struct q2texinfo_s
314 float vecs[2][4]; // [s/t][xyz offset]
315 int flags; // miptex flags + overrides
316 int value; // light emission, etc
317 char texture[32]; // texture name (textures/*.wal)
318 int nexttexinfo; // for animations, -1 = end of chain
321 typedef struct q2dleaf_s
323 int contents; // OR of all brushes (not needed?)
328 short mins[3]; // for frustum culling
331 unsigned short firstleafface;
332 unsigned short numleaffaces;
334 unsigned short firstleafbrush;
335 unsigned short numleafbrushes;
338 typedef struct q2dbrushside_s
340 unsigned short planenum; // facing out of the leaf
344 typedef struct q2dbrush_s
352 // the visibility lump consists of a header with a count, then
353 // byte offsets for the PVS and PHS of each cluster, then the raw
354 // compressed bit vectors
357 typedef struct q2dvis_s
360 int bitofs[8][2]; // bitofs[numclusters][2]
363 // each area has a list of portals that lead into other areas
364 // when portals are closed, other areas may not be visible or
365 // hearable even if the vis info says that it should be
366 typedef struct q2dareaportal_s
372 typedef struct q2darea_s
381 #define Q3BSPVERSION 46
383 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
384 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
385 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
386 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
387 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
388 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
389 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
390 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
391 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
392 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
393 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
394 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
395 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
396 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
397 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
398 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
399 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
400 #define Q3HEADER_LUMPS 17
402 typedef struct q3dheader_s
406 lump_t lumps[Q3HEADER_LUMPS];
409 typedef struct q3dtexture_s
411 char name[Q3PATHLENGTH];
417 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
418 typedef struct q3dplane_s
425 typedef struct q3dnode_s
428 int childrenindex[2];
434 typedef struct q3dleaf_s
436 int clusterindex; // pvs index
437 int areaindex; // area index
447 typedef struct q3dmodel_s
458 typedef struct q3dbrush_s
466 typedef struct q3dbrushside_s
473 typedef struct q3dvertex_s
479 unsigned char color4ub[4];
483 typedef struct q3dmeshvertex_s
485 int offset; // first vertex index of mesh
489 typedef struct q3deffect_s
491 char shadername[Q3PATHLENGTH];
493 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
497 #define Q3FACETYPE_POLYGON 1 // common
498 #define Q3FACETYPE_PATCH 2 // common
499 #define Q3FACETYPE_MESH 3 // common
500 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
502 typedef struct q3dface_s
505 int effectindex; // -1 if none
506 int type; // Q3FACETYPE
511 int lightmapindex; // -1 if none
512 int lightmap_base[2];
513 int lightmap_size[2];
518 // corrupt or don't care
524 // Q3FACETYPE_POLYGON
525 // polygon is simply a convex polygon, renderable as a mesh
526 float lightmap_origin[3];
527 float lightmap_vectors[2][3];
535 // patch renders as a bezier mesh, with adjustable tesselation
536 // level (optionally based on LOD using the bbox and polygon
537 // count to choose a tesselation level)
538 // note: multiple patches may have the same bbox to cause them to
539 // be LOD adjusted together as a group
541 float mins[3]; // LOD bbox
542 float maxs[3]; // LOD bbox
544 int patchsize[2]; // dimensions of vertex grid
550 // mesh renders as simply a triangle mesh
560 // flare renders as a simple sprite at origin, no geometry
561 // exists, nor does it have a radius, a cvar controls the radius
562 // and another cvar controls distance fade
563 // (they were not used in Q3 I'm told)
573 typedef struct q3dlightmap_s
575 unsigned char rgb[128*128*3];
579 typedef struct q3dlightgrid_s
581 unsigned char ambientrgb[3];
582 unsigned char diffusergb[3];
583 unsigned char diffusepitch;
584 unsigned char diffuseyaw;
588 typedef struct q3dpvs_s
592 // unsigned char chains[];
593 // containing bits in 0-7 order (not 7-0 order),
594 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
598 // surfaceflags from bsp
599 #define Q3SURFACEFLAG_NODAMAGE 1
600 #define Q3SURFACEFLAG_SLICK 2
601 #define Q3SURFACEFLAG_SKY 4
602 #define Q3SURFACEFLAG_LADDER 8
603 #define Q3SURFACEFLAG_NOIMPACT 16
604 #define Q3SURFACEFLAG_NOMARKS 32
605 #define Q3SURFACEFLAG_FLESH 64
606 #define Q3SURFACEFLAG_NODRAW 128
607 #define Q3SURFACEFLAG_HINT 256
608 #define Q3SURFACEFLAG_SKIP 512
609 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
610 #define Q3SURFACEFLAG_POINTLIGHT 2048
611 #define Q3SURFACEFLAG_METALSTEPS 4096
612 #define Q3SURFACEFLAG_NOSTEPS 8192
613 #define Q3SURFACEFLAG_NONSOLID 16384
614 #define Q3SURFACEFLAG_LIGHTFILTER 32768
615 #define Q3SURFACEFLAG_ALPHASHADOW 65536
616 #define Q3SURFACEFLAG_NODLIGHT 131072
617 #define Q3SURFACEFLAG_DUST 262144
619 // surfaceparms from shaders
620 #define Q3SURFACEPARM_ALPHASHADOW 1
621 #define Q3SURFACEPARM_AREAPORTAL 2
622 #define Q3SURFACEPARM_CLUSTERPORTAL 4
623 #define Q3SURFACEPARM_DETAIL 8
624 #define Q3SURFACEPARM_DONOTENTER 16
625 #define Q3SURFACEPARM_FOG 32
626 #define Q3SURFACEPARM_LAVA 64
627 #define Q3SURFACEPARM_LIGHTFILTER 128
628 #define Q3SURFACEPARM_METALSTEPS 256
629 #define Q3SURFACEPARM_NODAMAGE 512
630 #define Q3SURFACEPARM_NODLIGHT 1024
631 #define Q3SURFACEPARM_NODRAW 2048
632 #define Q3SURFACEPARM_NODROP 4096
633 #define Q3SURFACEPARM_NOIMPACT 8192
634 #define Q3SURFACEPARM_NOLIGHTMAP 16384
635 #define Q3SURFACEPARM_NOMARKS 32768
636 #define Q3SURFACEPARM_NOMIPMAPS 65536
637 #define Q3SURFACEPARM_NONSOLID 131072
638 #define Q3SURFACEPARM_ORIGIN 262144
639 #define Q3SURFACEPARM_PLAYERCLIP 524288
640 #define Q3SURFACEPARM_SKY 1048576
641 #define Q3SURFACEPARM_SLICK 2197152
642 #define Q3SURFACEPARM_SLIME 4194304
643 #define Q3SURFACEPARM_STRUCTURAL 8388608
644 #define Q3SURFACEPARM_TRANS 16777216
645 #define Q3SURFACEPARM_WATER 33554432
646 #define Q3SURFACEPARM_POINTLIGHT 67108864
647 #define Q3SURFACEPARM_HINT 134217728
648 #define Q3SURFACEPARM_DUST 268435456
649 #define Q3SURFACEPARM_BOTCLIP 536870912
650 #define Q3SURFACEPARM_LIGHTGRID 1073741824
651 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
653 typedef struct q3mbrush_s
655 struct colbrushf_s *colbrushf;
657 struct q3mbrushside_s *firstbrushside;
658 struct texture_s *texture;
662 typedef struct q3mbrushside_s
664 struct mplane_s *plane;
665 struct texture_s *texture;
669 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
670 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
671 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)