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 // render reflection only
104 #define MATERIALFLAG_REFLECTION 524288
105 // combined mask of all attributes that require depth sorted rendering
106 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
108 typedef struct medge_s
114 struct entity_render_s;
118 typedef struct mnode_s
120 //this part shared between node and leaf
121 mplane_t *plane; // != NULL
122 struct mnode_s *parent;
123 struct mportal_s *portals;
124 // for bounding box culling
127 // supercontents from all brushes inside this node or leaf
128 int combinedsupercontents;
130 // this part unique to node
131 struct mnode_s *children[2];
134 unsigned short firstsurface;
135 unsigned short numsurfaces;
139 typedef struct mleaf_s
141 //this part shared between node and leaf
142 mplane_t *plane; // == NULL
143 struct mnode_s *parent;
144 struct mportal_s *portals;
145 // for bounding box culling
148 // supercontents from all brushes inside this node or leaf
149 int combinedsupercontents;
151 // this part unique to leaf
153 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
154 int areaindex; // q3bsp
155 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
157 int *firstleafsurface;
158 int numleafbrushes; // q3bsp
159 int *firstleafbrush; // q3bsp
160 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
161 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
162 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
166 typedef struct hull_s
168 dclipnode_t *clipnodes;
178 typedef struct mportal_s
180 struct mportal_s *next; // the next portal on this leaf
181 mleaf_t *here; // the leaf this portal is on
182 mleaf_t *past; // the leaf through this portal (infront)
185 vec3_t mins, maxs; // culling
190 typedef struct svbspmesh_s
192 struct svbspmesh_s *next;
193 int numverts, maxverts;
194 int numtriangles, maxtriangles;
202 #define Q2BSPVERSION 38
204 // leaffaces, leafbrushes, planes, and verts are still bounded by
205 // 16 bit short limits
207 //=============================================================================
209 #define Q2LUMP_ENTITIES 0
210 #define Q2LUMP_PLANES 1
211 #define Q2LUMP_VERTEXES 2
212 #define Q2LUMP_VISIBILITY 3
213 #define Q2LUMP_NODES 4
214 #define Q2LUMP_TEXINFO 5
215 #define Q2LUMP_FACES 6
216 #define Q2LUMP_LIGHTING 7
217 #define Q2LUMP_LEAFS 8
218 #define Q2LUMP_LEAFFACES 9
219 #define Q2LUMP_LEAFBRUSHES 10
220 #define Q2LUMP_EDGES 11
221 #define Q2LUMP_SURFEDGES 12
222 #define Q2LUMP_MODELS 13
223 #define Q2LUMP_BRUSHES 14
224 #define Q2LUMP_BRUSHSIDES 15
225 #define Q2LUMP_POP 16
226 #define Q2LUMP_AREAS 17
227 #define Q2LUMP_AREAPORTALS 18
228 #define Q2HEADER_LUMPS 19
230 typedef struct q2dheader_s
234 lump_t lumps[Q2HEADER_LUMPS];
237 typedef struct q2dmodel_s
239 float mins[3], maxs[3];
240 float origin[3]; // for sounds or lights
242 int firstface, numfaces; // submodels just draw faces
243 // without walking the bsp tree
246 // planes (x&~1) and (x&~1)+1 are always opposites
248 // contents flags are seperate bits
249 // a given brush can contribute multiple content bits
250 // multiple brushes can be in a single leaf
252 // these definitions also need to be in q_shared.h!
254 // lower bits are stronger, and will eat weaker brushes completely
255 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
256 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
257 #define Q2CONTENTS_AUX 4
258 #define Q2CONTENTS_LAVA 8
259 #define Q2CONTENTS_SLIME 16
260 #define Q2CONTENTS_WATER 32
261 #define Q2CONTENTS_MIST 64
262 #define Q2LAST_VISIBLE_CONTENTS 64
264 // remaining contents are non-visible, and don't eat brushes
266 #define Q2CONTENTS_AREAPORTAL 0x8000
268 #define Q2CONTENTS_PLAYERCLIP 0x10000
269 #define Q2CONTENTS_MONSTERCLIP 0x20000
271 // currents can be added to any other contents, and may be mixed
272 #define Q2CONTENTS_CURRENT_0 0x40000
273 #define Q2CONTENTS_CURRENT_90 0x80000
274 #define Q2CONTENTS_CURRENT_180 0x100000
275 #define Q2CONTENTS_CURRENT_270 0x200000
276 #define Q2CONTENTS_CURRENT_UP 0x400000
277 #define Q2CONTENTS_CURRENT_DOWN 0x800000
279 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
281 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
282 #define Q2CONTENTS_DEADMONSTER 0x4000000
283 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
284 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
285 #define Q2CONTENTS_LADDER 0x20000000
289 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
291 #define Q2SURF_SLICK 0x2 // effects game physics
293 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
294 #define Q2SURF_WARP 0x8 // turbulent water warp
295 #define Q2SURF_TRANS33 0x10
296 #define Q2SURF_TRANS66 0x20
297 #define Q2SURF_FLOWING 0x40 // scroll towards angle
298 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
303 typedef struct q2dnode_s
306 int children[2]; // negative numbers are -(leafs+1), not nodes
307 short mins[3]; // for frustom culling
309 unsigned short firstface;
310 unsigned short numfaces; // counting both sides
314 typedef struct q2texinfo_s
316 float vecs[2][4]; // [s/t][xyz offset]
317 int flags; // miptex flags + overrides
318 int value; // light emission, etc
319 char texture[32]; // texture name (textures/*.wal)
320 int nexttexinfo; // for animations, -1 = end of chain
323 typedef struct q2dleaf_s
325 int contents; // OR of all brushes (not needed?)
330 short mins[3]; // for frustum culling
333 unsigned short firstleafface;
334 unsigned short numleaffaces;
336 unsigned short firstleafbrush;
337 unsigned short numleafbrushes;
340 typedef struct q2dbrushside_s
342 unsigned short planenum; // facing out of the leaf
346 typedef struct q2dbrush_s
354 // the visibility lump consists of a header with a count, then
355 // byte offsets for the PVS and PHS of each cluster, then the raw
356 // compressed bit vectors
359 typedef struct q2dvis_s
362 int bitofs[8][2]; // bitofs[numclusters][2]
365 // each area has a list of portals that lead into other areas
366 // when portals are closed, other areas may not be visible or
367 // hearable even if the vis info says that it should be
368 typedef struct q2dareaportal_s
374 typedef struct q2darea_s
383 #define Q3BSPVERSION 46
385 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
386 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
387 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
388 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
389 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
390 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
391 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
392 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
393 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
394 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
395 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
396 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
397 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
398 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
399 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
400 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
401 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
402 #define Q3HEADER_LUMPS 17
404 typedef struct q3dheader_s
408 lump_t lumps[Q3HEADER_LUMPS];
411 typedef struct q3dtexture_s
413 char name[Q3PATHLENGTH];
419 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
420 typedef struct q3dplane_s
427 typedef struct q3dnode_s
430 int childrenindex[2];
436 typedef struct q3dleaf_s
438 int clusterindex; // pvs index
439 int areaindex; // area index
449 typedef struct q3dmodel_s
460 typedef struct q3dbrush_s
468 typedef struct q3dbrushside_s
475 typedef struct q3dvertex_s
481 unsigned char color4ub[4];
485 typedef struct q3dmeshvertex_s
487 int offset; // first vertex index of mesh
491 typedef struct q3deffect_s
493 char shadername[Q3PATHLENGTH];
495 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
499 #define Q3FACETYPE_POLYGON 1 // common
500 #define Q3FACETYPE_PATCH 2 // common
501 #define Q3FACETYPE_MESH 3 // common
502 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
504 typedef struct q3dface_s
507 int effectindex; // -1 if none
508 int type; // Q3FACETYPE
513 int lightmapindex; // -1 if none
514 int lightmap_base[2];
515 int lightmap_size[2];
520 // corrupt or don't care
526 // Q3FACETYPE_POLYGON
527 // polygon is simply a convex polygon, renderable as a mesh
528 float lightmap_origin[3];
529 float lightmap_vectors[2][3];
537 // patch renders as a bezier mesh, with adjustable tesselation
538 // level (optionally based on LOD using the bbox and polygon
539 // count to choose a tesselation level)
540 // note: multiple patches may have the same bbox to cause them to
541 // be LOD adjusted together as a group
543 float mins[3]; // LOD bbox
544 float maxs[3]; // LOD bbox
546 int patchsize[2]; // dimensions of vertex grid
552 // mesh renders as simply a triangle mesh
562 // flare renders as a simple sprite at origin, no geometry
563 // exists, nor does it have a radius, a cvar controls the radius
564 // and another cvar controls distance fade
565 // (they were not used in Q3 I'm told)
575 typedef struct q3dlightmap_s
577 unsigned char rgb[128*128*3];
581 typedef struct q3dlightgrid_s
583 unsigned char ambientrgb[3];
584 unsigned char diffusergb[3];
585 unsigned char diffusepitch;
586 unsigned char diffuseyaw;
590 typedef struct q3dpvs_s
594 // unsigned char chains[];
595 // containing bits in 0-7 order (not 7-0 order),
596 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
600 // surfaceflags from bsp
601 #define Q3SURFACEFLAG_NODAMAGE 1
602 #define Q3SURFACEFLAG_SLICK 2
603 #define Q3SURFACEFLAG_SKY 4
604 #define Q3SURFACEFLAG_LADDER 8
605 #define Q3SURFACEFLAG_NOIMPACT 16
606 #define Q3SURFACEFLAG_NOMARKS 32
607 #define Q3SURFACEFLAG_FLESH 64
608 #define Q3SURFACEFLAG_NODRAW 128
609 #define Q3SURFACEFLAG_HINT 256
610 #define Q3SURFACEFLAG_SKIP 512
611 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
612 #define Q3SURFACEFLAG_POINTLIGHT 2048
613 #define Q3SURFACEFLAG_METALSTEPS 4096
614 #define Q3SURFACEFLAG_NOSTEPS 8192
615 #define Q3SURFACEFLAG_NONSOLID 16384
616 #define Q3SURFACEFLAG_LIGHTFILTER 32768
617 #define Q3SURFACEFLAG_ALPHASHADOW 65536
618 #define Q3SURFACEFLAG_NODLIGHT 131072
619 #define Q3SURFACEFLAG_DUST 262144
621 // surfaceparms from shaders
622 #define Q3SURFACEPARM_ALPHASHADOW 1
623 #define Q3SURFACEPARM_AREAPORTAL 2
624 #define Q3SURFACEPARM_CLUSTERPORTAL 4
625 #define Q3SURFACEPARM_DETAIL 8
626 #define Q3SURFACEPARM_DONOTENTER 16
627 #define Q3SURFACEPARM_FOG 32
628 #define Q3SURFACEPARM_LAVA 64
629 #define Q3SURFACEPARM_LIGHTFILTER 128
630 #define Q3SURFACEPARM_METALSTEPS 256
631 #define Q3SURFACEPARM_NODAMAGE 512
632 #define Q3SURFACEPARM_NODLIGHT 1024
633 #define Q3SURFACEPARM_NODRAW 2048
634 #define Q3SURFACEPARM_NODROP 4096
635 #define Q3SURFACEPARM_NOIMPACT 8192
636 #define Q3SURFACEPARM_NOLIGHTMAP 16384
637 #define Q3SURFACEPARM_NOMARKS 32768
638 #define Q3SURFACEPARM_NOMIPMAPS 65536
639 #define Q3SURFACEPARM_NONSOLID 131072
640 #define Q3SURFACEPARM_ORIGIN 262144
641 #define Q3SURFACEPARM_PLAYERCLIP 524288
642 #define Q3SURFACEPARM_SKY 1048576
643 #define Q3SURFACEPARM_SLICK 2197152
644 #define Q3SURFACEPARM_SLIME 4194304
645 #define Q3SURFACEPARM_STRUCTURAL 8388608
646 #define Q3SURFACEPARM_TRANS 16777216
647 #define Q3SURFACEPARM_WATER 33554432
648 #define Q3SURFACEPARM_POINTLIGHT 67108864
649 #define Q3SURFACEPARM_HINT 134217728
650 #define Q3SURFACEPARM_DUST 268435456
651 #define Q3SURFACEPARM_BOTCLIP 536870912
652 #define Q3SURFACEPARM_LIGHTGRID 1073741824
653 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
655 typedef struct q3mbrush_s
657 struct colbrushf_s *colbrushf;
659 struct q3mbrushside_s *firstbrushside;
660 struct texture_s *texture;
664 typedef struct q3mbrushside_s
666 struct mplane_s *plane;
667 struct texture_s *texture;
671 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
672 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
673 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)