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 // combined mask of all attributes that require depth sorted rendering
120 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
121 // combined mask of all attributes that cause some sort of transparency
122 #define MATERIALFLAGMASK_TRANSLUCENT (MATERIALFLAG_WATERALPHA | MATERIALFLAG_SKY | MATERIALFLAG_NODRAW | MATERIALFLAG_ALPHATEST | MATERIALFLAG_BLENDED | MATERIALFLAG_WATERSHADER | MATERIALFLAG_REFRACTION)
124 typedef struct medge_s
130 struct entity_render_s;
134 typedef struct mnode_s
136 //this part shared between node and leaf
137 mplane_t *plane; // != NULL
138 struct mnode_s *parent;
139 struct mportal_s *portals;
140 // for bounding box culling
143 // supercontents from all brushes inside this node or leaf
144 int combinedsupercontents;
146 // this part unique to node
147 struct mnode_s *children[2];
150 unsigned short firstsurface;
151 unsigned short numsurfaces;
155 typedef struct mleaf_s
157 //this part shared between node and leaf
158 mplane_t *plane; // == NULL
159 struct mnode_s *parent;
160 struct mportal_s *portals;
161 // for bounding box culling
164 // supercontents from all brushes inside this node or leaf
165 int combinedsupercontents;
167 // this part unique to leaf
169 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
170 int areaindex; // q3bsp
171 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
173 int *firstleafsurface;
174 int numleafbrushes; // q3bsp
175 int *firstleafbrush; // q3bsp
176 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
177 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
178 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
182 typedef struct mclipnode_s
185 int children[2]; // negative numbers are contents
188 typedef struct hull_s
190 mclipnode_t *clipnodes;
200 typedef struct mportal_s
202 struct mportal_s *next; // the next portal on this leaf
203 mleaf_t *here; // the leaf this portal is on
204 mleaf_t *past; // the leaf through this portal (infront)
207 vec3_t mins, maxs; // culling
212 typedef struct svbspmesh_s
214 struct svbspmesh_s *next;
215 int numverts, maxverts;
216 int numtriangles, maxtriangles;
224 #define Q2BSPVERSION 38
226 // leaffaces, leafbrushes, planes, and verts are still bounded by
227 // 16 bit short limits
229 //=============================================================================
231 #define Q2LUMP_ENTITIES 0
232 #define Q2LUMP_PLANES 1
233 #define Q2LUMP_VERTEXES 2
234 #define Q2LUMP_VISIBILITY 3
235 #define Q2LUMP_NODES 4
236 #define Q2LUMP_TEXINFO 5
237 #define Q2LUMP_FACES 6
238 #define Q2LUMP_LIGHTING 7
239 #define Q2LUMP_LEAFS 8
240 #define Q2LUMP_LEAFFACES 9
241 #define Q2LUMP_LEAFBRUSHES 10
242 #define Q2LUMP_EDGES 11
243 #define Q2LUMP_SURFEDGES 12
244 #define Q2LUMP_MODELS 13
245 #define Q2LUMP_BRUSHES 14
246 #define Q2LUMP_BRUSHSIDES 15
247 #define Q2LUMP_POP 16
248 #define Q2LUMP_AREAS 17
249 #define Q2LUMP_AREAPORTALS 18
250 #define Q2HEADER_LUMPS 19
252 typedef struct q2dheader_s
256 lump_t lumps[Q2HEADER_LUMPS];
259 typedef struct q2dmodel_s
261 float mins[3], maxs[3];
262 float origin[3]; // for sounds or lights
264 int firstface, numfaces; // submodels just draw faces
265 // without walking the bsp tree
268 // planes (x&~1) and (x&~1)+1 are always opposites
270 // contents flags are seperate bits
271 // a given brush can contribute multiple content bits
272 // multiple brushes can be in a single leaf
274 // these definitions also need to be in q_shared.h!
276 // lower bits are stronger, and will eat weaker brushes completely
277 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
278 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
279 #define Q2CONTENTS_AUX 4
280 #define Q2CONTENTS_LAVA 8
281 #define Q2CONTENTS_SLIME 16
282 #define Q2CONTENTS_WATER 32
283 #define Q2CONTENTS_MIST 64
284 #define Q2LAST_VISIBLE_CONTENTS 64
286 // remaining contents are non-visible, and don't eat brushes
288 #define Q2CONTENTS_AREAPORTAL 0x8000
290 #define Q2CONTENTS_PLAYERCLIP 0x10000
291 #define Q2CONTENTS_MONSTERCLIP 0x20000
293 // currents can be added to any other contents, and may be mixed
294 #define Q2CONTENTS_CURRENT_0 0x40000
295 #define Q2CONTENTS_CURRENT_90 0x80000
296 #define Q2CONTENTS_CURRENT_180 0x100000
297 #define Q2CONTENTS_CURRENT_270 0x200000
298 #define Q2CONTENTS_CURRENT_UP 0x400000
299 #define Q2CONTENTS_CURRENT_DOWN 0x800000
301 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
303 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
304 #define Q2CONTENTS_DEADMONSTER 0x4000000
305 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
306 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
307 #define Q2CONTENTS_LADDER 0x20000000
311 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
313 #define Q2SURF_SLICK 0x2 // effects game physics
315 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
316 #define Q2SURF_WARP 0x8 // turbulent water warp
317 #define Q2SURF_TRANS33 0x10
318 #define Q2SURF_TRANS66 0x20
319 #define Q2SURF_FLOWING 0x40 // scroll towards angle
320 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
325 typedef struct q2dnode_s
328 int children[2]; // negative numbers are -(leafs+1), not nodes
329 short mins[3]; // for frustom culling
331 unsigned short firstface;
332 unsigned short numfaces; // counting both sides
336 typedef struct q2texinfo_s
338 float vecs[2][4]; // [s/t][xyz offset]
339 int flags; // miptex flags + overrides
340 int value; // light emission, etc
341 char texture[32]; // texture name (textures/*.wal)
342 int nexttexinfo; // for animations, -1 = end of chain
345 typedef struct q2dleaf_s
347 int contents; // OR of all brushes (not needed?)
352 short mins[3]; // for frustum culling
355 unsigned short firstleafface;
356 unsigned short numleaffaces;
358 unsigned short firstleafbrush;
359 unsigned short numleafbrushes;
362 typedef struct q2dbrushside_s
364 unsigned short planenum; // facing out of the leaf
368 typedef struct q2dbrush_s
376 // the visibility lump consists of a header with a count, then
377 // byte offsets for the PVS and PHS of each cluster, then the raw
378 // compressed bit vectors
381 typedef struct q2dvis_s
384 int bitofs[8][2]; // bitofs[numclusters][2]
387 // each area has a list of portals that lead into other areas
388 // when portals are closed, other areas may not be visible or
389 // hearable even if the vis info says that it should be
390 typedef struct q2dareaportal_s
396 typedef struct q2darea_s
405 #define Q3BSPVERSION 46
406 #define Q3BSPVERSION_LIVE 47
407 #define Q3BSPVERSION_IG 48
409 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
410 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
411 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
412 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
413 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
414 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
415 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
416 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
417 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
418 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
419 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
420 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
421 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
422 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
423 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
424 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
425 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
426 #define Q3HEADER_LUMPS 17
427 #define Q3LUMP_ADVERTISEMENTS 17 // quake live stuff written by zeroradiant's q3map2 (ignored by DP)
428 #define Q3HEADER_LUMPS_LIVE 18
429 #define Q3HEADER_LUMPS_MAX 18
431 typedef struct q3dheader_s
435 lump_t lumps[Q3HEADER_LUMPS_MAX];
438 typedef struct q3dtexture_s
440 char name[Q3PATHLENGTH];
446 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
447 typedef struct q3dplane_s
454 typedef struct q3dnode_s
457 int childrenindex[2];
463 typedef struct q3dleaf_s
465 int clusterindex; // pvs index
466 int areaindex; // area index
476 typedef struct q3dmodel_s
487 typedef struct q3dbrush_s
495 typedef struct q3dbrushside_s
502 typedef struct q3dbrushside_ig_s
510 typedef struct q3dvertex_s
516 unsigned char color4ub[4];
520 typedef struct q3dmeshvertex_s
522 int offset; // first vertex index of mesh
526 typedef struct q3deffect_s
528 char shadername[Q3PATHLENGTH];
530 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
534 #define Q3FACETYPE_FLAT 1 // common
535 #define Q3FACETYPE_PATCH 2 // common
536 #define Q3FACETYPE_MESH 3 // common
537 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
539 typedef struct q3dface_s
542 int effectindex; // -1 if none
543 int type; // Q3FACETYPE
548 int lightmapindex; // -1 if none
549 int lightmap_base[2];
550 int lightmap_size[2];
555 // corrupt or don't care
562 // mesh is a collection of triangles on a plane, renderable as a mesh (NOT a polygon)
563 float lightmap_origin[3];
564 float lightmap_vectors[2][3];
572 // patch renders as a bezier mesh, with adjustable tesselation
573 // level (optionally based on LOD using the bbox and polygon
574 // count to choose a tesselation level)
575 // note: multiple patches may have the same bbox to cause them to
576 // be LOD adjusted together as a group
578 float mins[3]; // LOD bbox
579 float maxs[3]; // LOD bbox
581 int patchsize[2]; // dimensions of vertex grid
587 // mesh renders as simply a triangle mesh
597 // flare renders as a simple sprite at origin, no geometry
598 // exists, nor does it have a radius, a cvar controls the radius
599 // and another cvar controls distance fade
600 // (they were not used in Q3 I'm told)
610 typedef struct q3dlightmap_s
612 unsigned char rgb[128*128*3];
616 typedef struct q3dlightgrid_s
618 unsigned char ambientrgb[3];
619 unsigned char diffusergb[3];
620 unsigned char diffusepitch;
621 unsigned char diffuseyaw;
625 typedef struct q3dpvs_s
629 // unsigned char chains[];
630 // containing bits in 0-7 order (not 7-0 order),
631 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
635 // surfaceflags from bsp
636 #define Q3SURFACEFLAG_NODAMAGE 1
637 #define Q3SURFACEFLAG_SLICK 2
638 #define Q3SURFACEFLAG_SKY 4
639 #define Q3SURFACEFLAG_LADDER 8
640 #define Q3SURFACEFLAG_NOIMPACT 16
641 #define Q3SURFACEFLAG_NOMARKS 32
642 #define Q3SURFACEFLAG_FLESH 64
643 #define Q3SURFACEFLAG_NODRAW 128
644 #define Q3SURFACEFLAG_HINT 256
645 #define Q3SURFACEFLAG_SKIP 512
646 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
647 #define Q3SURFACEFLAG_POINTLIGHT 2048
648 #define Q3SURFACEFLAG_METALSTEPS 4096
649 #define Q3SURFACEFLAG_NOSTEPS 8192
650 #define Q3SURFACEFLAG_NONSOLID 16384
651 #define Q3SURFACEFLAG_LIGHTFILTER 32768
652 #define Q3SURFACEFLAG_ALPHASHADOW 65536
653 #define Q3SURFACEFLAG_NODLIGHT 131072
654 #define Q3SURFACEFLAG_DUST 262144
656 // surfaceparms from shaders
657 #define Q3SURFACEPARM_ALPHASHADOW 1
658 #define Q3SURFACEPARM_AREAPORTAL 2
659 #define Q3SURFACEPARM_CLUSTERPORTAL 4
660 #define Q3SURFACEPARM_DETAIL 8
661 #define Q3SURFACEPARM_DONOTENTER 16
662 #define Q3SURFACEPARM_FOG 32
663 #define Q3SURFACEPARM_LAVA 64
664 #define Q3SURFACEPARM_LIGHTFILTER 128
665 #define Q3SURFACEPARM_METALSTEPS 256
666 #define Q3SURFACEPARM_NODAMAGE 512
667 #define Q3SURFACEPARM_NODLIGHT 1024
668 #define Q3SURFACEPARM_NODRAW 2048
669 #define Q3SURFACEPARM_NODROP 4096
670 #define Q3SURFACEPARM_NOIMPACT 8192
671 #define Q3SURFACEPARM_NOLIGHTMAP 16384
672 #define Q3SURFACEPARM_NOMARKS 32768
673 #define Q3SURFACEPARM_NOMIPMAPS 65536
674 #define Q3SURFACEPARM_NONSOLID 131072
675 #define Q3SURFACEPARM_ORIGIN 262144
676 #define Q3SURFACEPARM_PLAYERCLIP 524288
677 #define Q3SURFACEPARM_SKY 1048576
678 #define Q3SURFACEPARM_SLICK 2097152
679 #define Q3SURFACEPARM_SLIME 4194304
680 #define Q3SURFACEPARM_STRUCTURAL 8388608
681 #define Q3SURFACEPARM_TRANS 16777216
682 #define Q3SURFACEPARM_WATER 33554432
683 #define Q3SURFACEPARM_POINTLIGHT 67108864
684 #define Q3SURFACEPARM_HINT 134217728
685 #define Q3SURFACEPARM_DUST 268435456
686 #define Q3SURFACEPARM_BOTCLIP 536870912
687 #define Q3SURFACEPARM_LIGHTGRID 1073741824
688 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
690 typedef struct q3mbrush_s
692 struct colbrushf_s *colbrushf;
694 struct q3mbrushside_s *firstbrushside;
695 struct texture_s *texture;
699 typedef struct q3mbrushside_s
701 struct mplane_s *plane;
702 struct texture_s *texture;
706 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
707 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
708 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)