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 surface (alternative to SKY)
76 #define MATERIALFLAG_WALL 64
77 // this surface shows the sky in its place, alternative to WALL
78 // skipped if transparent
79 #define MATERIALFLAG_SKY 128
80 // swirling water effect (used with MATERIALFLAG_WALL)
81 #define MATERIALFLAG_WATERSCROLL 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 // use model lighting on this material (q1bsp lightmap sampling or q3bsp lightgrid, implies FULLBRIGHT is false)
108 #define MATERIALFLAG_MODELLIGHT 4194304
109 // add directional model lighting to this material (q3bsp lightgrid only)
110 #define MATERIALFLAG_MODELLIGHT_DIRECTIONAL 8388608
111 // combined mask of all attributes that require depth sorted rendering
112 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
114 typedef struct medge_s
120 struct entity_render_s;
124 typedef struct mnode_s
126 //this part shared between node and leaf
127 mplane_t *plane; // != NULL
128 struct mnode_s *parent;
129 struct mportal_s *portals;
130 // for bounding box culling
133 // supercontents from all brushes inside this node or leaf
134 int combinedsupercontents;
136 // this part unique to node
137 struct mnode_s *children[2];
140 unsigned short firstsurface;
141 unsigned short numsurfaces;
145 typedef struct mleaf_s
147 //this part shared between node and leaf
148 mplane_t *plane; // == NULL
149 struct mnode_s *parent;
150 struct mportal_s *portals;
151 // for bounding box culling
154 // supercontents from all brushes inside this node or leaf
155 int combinedsupercontents;
157 // this part unique to leaf
159 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
160 int areaindex; // q3bsp
161 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
163 int *firstleafsurface;
164 int numleafbrushes; // q3bsp
165 int *firstleafbrush; // q3bsp
166 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
167 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
168 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
172 typedef struct mclipnode_s
175 int children[2]; // negative numbers are contents
178 typedef struct hull_s
180 mclipnode_t *clipnodes;
190 typedef struct mportal_s
192 struct mportal_s *next; // the next portal on this leaf
193 mleaf_t *here; // the leaf this portal is on
194 mleaf_t *past; // the leaf through this portal (infront)
197 vec3_t mins, maxs; // culling
202 typedef struct svbspmesh_s
204 struct svbspmesh_s *next;
205 int numverts, maxverts;
206 int numtriangles, maxtriangles;
214 #define Q2BSPVERSION 38
216 // leaffaces, leafbrushes, planes, and verts are still bounded by
217 // 16 bit short limits
219 //=============================================================================
221 #define Q2LUMP_ENTITIES 0
222 #define Q2LUMP_PLANES 1
223 #define Q2LUMP_VERTEXES 2
224 #define Q2LUMP_VISIBILITY 3
225 #define Q2LUMP_NODES 4
226 #define Q2LUMP_TEXINFO 5
227 #define Q2LUMP_FACES 6
228 #define Q2LUMP_LIGHTING 7
229 #define Q2LUMP_LEAFS 8
230 #define Q2LUMP_LEAFFACES 9
231 #define Q2LUMP_LEAFBRUSHES 10
232 #define Q2LUMP_EDGES 11
233 #define Q2LUMP_SURFEDGES 12
234 #define Q2LUMP_MODELS 13
235 #define Q2LUMP_BRUSHES 14
236 #define Q2LUMP_BRUSHSIDES 15
237 #define Q2LUMP_POP 16
238 #define Q2LUMP_AREAS 17
239 #define Q2LUMP_AREAPORTALS 18
240 #define Q2HEADER_LUMPS 19
242 typedef struct q2dheader_s
246 lump_t lumps[Q2HEADER_LUMPS];
249 typedef struct q2dmodel_s
251 float mins[3], maxs[3];
252 float origin[3]; // for sounds or lights
254 int firstface, numfaces; // submodels just draw faces
255 // without walking the bsp tree
258 // planes (x&~1) and (x&~1)+1 are always opposites
260 // contents flags are seperate bits
261 // a given brush can contribute multiple content bits
262 // multiple brushes can be in a single leaf
264 // these definitions also need to be in q_shared.h!
266 // lower bits are stronger, and will eat weaker brushes completely
267 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
268 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
269 #define Q2CONTENTS_AUX 4
270 #define Q2CONTENTS_LAVA 8
271 #define Q2CONTENTS_SLIME 16
272 #define Q2CONTENTS_WATER 32
273 #define Q2CONTENTS_MIST 64
274 #define Q2LAST_VISIBLE_CONTENTS 64
276 // remaining contents are non-visible, and don't eat brushes
278 #define Q2CONTENTS_AREAPORTAL 0x8000
280 #define Q2CONTENTS_PLAYERCLIP 0x10000
281 #define Q2CONTENTS_MONSTERCLIP 0x20000
283 // currents can be added to any other contents, and may be mixed
284 #define Q2CONTENTS_CURRENT_0 0x40000
285 #define Q2CONTENTS_CURRENT_90 0x80000
286 #define Q2CONTENTS_CURRENT_180 0x100000
287 #define Q2CONTENTS_CURRENT_270 0x200000
288 #define Q2CONTENTS_CURRENT_UP 0x400000
289 #define Q2CONTENTS_CURRENT_DOWN 0x800000
291 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
293 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
294 #define Q2CONTENTS_DEADMONSTER 0x4000000
295 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
296 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
297 #define Q2CONTENTS_LADDER 0x20000000
301 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
303 #define Q2SURF_SLICK 0x2 // effects game physics
305 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
306 #define Q2SURF_WARP 0x8 // turbulent water warp
307 #define Q2SURF_TRANS33 0x10
308 #define Q2SURF_TRANS66 0x20
309 #define Q2SURF_FLOWING 0x40 // scroll towards angle
310 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
315 typedef struct q2dnode_s
318 int children[2]; // negative numbers are -(leafs+1), not nodes
319 short mins[3]; // for frustom culling
321 unsigned short firstface;
322 unsigned short numfaces; // counting both sides
326 typedef struct q2texinfo_s
328 float vecs[2][4]; // [s/t][xyz offset]
329 int flags; // miptex flags + overrides
330 int value; // light emission, etc
331 char texture[32]; // texture name (textures/*.wal)
332 int nexttexinfo; // for animations, -1 = end of chain
335 typedef struct q2dleaf_s
337 int contents; // OR of all brushes (not needed?)
342 short mins[3]; // for frustum culling
345 unsigned short firstleafface;
346 unsigned short numleaffaces;
348 unsigned short firstleafbrush;
349 unsigned short numleafbrushes;
352 typedef struct q2dbrushside_s
354 unsigned short planenum; // facing out of the leaf
358 typedef struct q2dbrush_s
366 // the visibility lump consists of a header with a count, then
367 // byte offsets for the PVS and PHS of each cluster, then the raw
368 // compressed bit vectors
371 typedef struct q2dvis_s
374 int bitofs[8][2]; // bitofs[numclusters][2]
377 // each area has a list of portals that lead into other areas
378 // when portals are closed, other areas may not be visible or
379 // hearable even if the vis info says that it should be
380 typedef struct q2dareaportal_s
386 typedef struct q2darea_s
395 #define Q3BSPVERSION 46
396 #define Q3BSPVERSION_IG 48
398 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
399 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
400 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
401 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
402 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
403 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
404 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
405 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
406 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
407 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
408 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
409 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
410 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
411 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
412 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
413 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
414 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
415 #define Q3HEADER_LUMPS 17
417 typedef struct q3dheader_s
421 lump_t lumps[Q3HEADER_LUMPS];
424 typedef struct q3dtexture_s
426 char name[Q3PATHLENGTH];
432 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
433 typedef struct q3dplane_s
440 typedef struct q3dnode_s
443 int childrenindex[2];
449 typedef struct q3dleaf_s
451 int clusterindex; // pvs index
452 int areaindex; // area index
462 typedef struct q3dmodel_s
473 typedef struct q3dbrush_s
481 typedef struct q3dbrushside_s
488 typedef struct q3dbrushside_ig_s
496 typedef struct q3dvertex_s
502 unsigned char color4ub[4];
506 typedef struct q3dmeshvertex_s
508 int offset; // first vertex index of mesh
512 typedef struct q3deffect_s
514 char shadername[Q3PATHLENGTH];
516 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
520 #define Q3FACETYPE_FLAT 1 // common
521 #define Q3FACETYPE_PATCH 2 // common
522 #define Q3FACETYPE_MESH 3 // common
523 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
525 typedef struct q3dface_s
528 int effectindex; // -1 if none
529 int type; // Q3FACETYPE
534 int lightmapindex; // -1 if none
535 int lightmap_base[2];
536 int lightmap_size[2];
541 // corrupt or don't care
548 // mesh is a collection of triangles on a plane, renderable as a mesh (NOT a polygon)
549 float lightmap_origin[3];
550 float lightmap_vectors[2][3];
558 // patch renders as a bezier mesh, with adjustable tesselation
559 // level (optionally based on LOD using the bbox and polygon
560 // count to choose a tesselation level)
561 // note: multiple patches may have the same bbox to cause them to
562 // be LOD adjusted together as a group
564 float mins[3]; // LOD bbox
565 float maxs[3]; // LOD bbox
567 int patchsize[2]; // dimensions of vertex grid
573 // mesh renders as simply a triangle mesh
583 // flare renders as a simple sprite at origin, no geometry
584 // exists, nor does it have a radius, a cvar controls the radius
585 // and another cvar controls distance fade
586 // (they were not used in Q3 I'm told)
596 typedef struct q3dlightmap_s
598 unsigned char rgb[128*128*3];
602 typedef struct q3dlightgrid_s
604 unsigned char ambientrgb[3];
605 unsigned char diffusergb[3];
606 unsigned char diffusepitch;
607 unsigned char diffuseyaw;
611 typedef struct q3dpvs_s
615 // unsigned char chains[];
616 // containing bits in 0-7 order (not 7-0 order),
617 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
621 // surfaceflags from bsp
622 #define Q3SURFACEFLAG_NODAMAGE 1
623 #define Q3SURFACEFLAG_SLICK 2
624 #define Q3SURFACEFLAG_SKY 4
625 #define Q3SURFACEFLAG_LADDER 8
626 #define Q3SURFACEFLAG_NOIMPACT 16
627 #define Q3SURFACEFLAG_NOMARKS 32
628 #define Q3SURFACEFLAG_FLESH 64
629 #define Q3SURFACEFLAG_NODRAW 128
630 #define Q3SURFACEFLAG_HINT 256
631 #define Q3SURFACEFLAG_SKIP 512
632 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
633 #define Q3SURFACEFLAG_POINTLIGHT 2048
634 #define Q3SURFACEFLAG_METALSTEPS 4096
635 #define Q3SURFACEFLAG_NOSTEPS 8192
636 #define Q3SURFACEFLAG_NONSOLID 16384
637 #define Q3SURFACEFLAG_LIGHTFILTER 32768
638 #define Q3SURFACEFLAG_ALPHASHADOW 65536
639 #define Q3SURFACEFLAG_NODLIGHT 131072
640 #define Q3SURFACEFLAG_DUST 262144
642 // surfaceparms from shaders
643 #define Q3SURFACEPARM_ALPHASHADOW 1
644 #define Q3SURFACEPARM_AREAPORTAL 2
645 #define Q3SURFACEPARM_CLUSTERPORTAL 4
646 #define Q3SURFACEPARM_DETAIL 8
647 #define Q3SURFACEPARM_DONOTENTER 16
648 #define Q3SURFACEPARM_FOG 32
649 #define Q3SURFACEPARM_LAVA 64
650 #define Q3SURFACEPARM_LIGHTFILTER 128
651 #define Q3SURFACEPARM_METALSTEPS 256
652 #define Q3SURFACEPARM_NODAMAGE 512
653 #define Q3SURFACEPARM_NODLIGHT 1024
654 #define Q3SURFACEPARM_NODRAW 2048
655 #define Q3SURFACEPARM_NODROP 4096
656 #define Q3SURFACEPARM_NOIMPACT 8192
657 #define Q3SURFACEPARM_NOLIGHTMAP 16384
658 #define Q3SURFACEPARM_NOMARKS 32768
659 #define Q3SURFACEPARM_NOMIPMAPS 65536
660 #define Q3SURFACEPARM_NONSOLID 131072
661 #define Q3SURFACEPARM_ORIGIN 262144
662 #define Q3SURFACEPARM_PLAYERCLIP 524288
663 #define Q3SURFACEPARM_SKY 1048576
664 #define Q3SURFACEPARM_SLICK 2197152
665 #define Q3SURFACEPARM_SLIME 4194304
666 #define Q3SURFACEPARM_STRUCTURAL 8388608
667 #define Q3SURFACEPARM_TRANS 16777216
668 #define Q3SURFACEPARM_WATER 33554432
669 #define Q3SURFACEPARM_POINTLIGHT 67108864
670 #define Q3SURFACEPARM_HINT 134217728
671 #define Q3SURFACEPARM_DUST 268435456
672 #define Q3SURFACEPARM_BOTCLIP 536870912
673 #define Q3SURFACEPARM_LIGHTGRID 1073741824
674 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
676 typedef struct q3mbrush_s
678 struct colbrushf_s *colbrushf;
680 struct q3mbrushside_s *firstbrushside;
681 struct texture_s *texture;
685 typedef struct q3mbrushside_s
687 struct mplane_s *plane;
688 struct texture_s *texture;
692 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
693 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
694 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)