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 // 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 // causes RSurf_GetCurrentTexture to leave alone certain fields
112 #define MATERIALFLAG_CUSTOMSURFACE 16777216
113 // combined mask of all attributes that require depth sorted rendering
114 #define MATERIALFLAGMASK_DEPTHSORTED (MATERIALFLAG_BLENDED | MATERIALFLAG_NODEPTHTEST)
115 // combined mask of all attributes that cause some sort of transparency
116 #define MATERIALFLAGMASK_TRANSLUCENT (MATERIALFLAG_WATERALPHA | MATERIALFLAG_SKY | MATERIALFLAG_NODRAW | MATERIALFLAG_ALPHATEST | MATERIALFLAG_BLENDED | MATERIALFLAG_WATERSHADER | MATERIALFLAG_REFRACTION)
118 typedef struct medge_s
124 struct entity_render_s;
128 typedef struct mnode_s
130 //this part shared between node and leaf
131 mplane_t *plane; // != NULL
132 struct mnode_s *parent;
133 struct mportal_s *portals;
134 // for bounding box culling
137 // supercontents from all brushes inside this node or leaf
138 int combinedsupercontents;
140 // this part unique to node
141 struct mnode_s *children[2];
144 unsigned short firstsurface;
145 unsigned short numsurfaces;
149 typedef struct mleaf_s
151 //this part shared between node and leaf
152 mplane_t *plane; // == NULL
153 struct mnode_s *parent;
154 struct mportal_s *portals;
155 // for bounding box culling
158 // supercontents from all brushes inside this node or leaf
159 int combinedsupercontents;
161 // this part unique to leaf
163 int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
164 int areaindex; // q3bsp
165 int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
167 int *firstleafsurface;
168 int numleafbrushes; // q3bsp
169 int *firstleafbrush; // q3bsp
170 unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
171 int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
172 int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
176 typedef struct mclipnode_s
179 int children[2]; // negative numbers are contents
182 typedef struct hull_s
184 mclipnode_t *clipnodes;
194 typedef struct mportal_s
196 struct mportal_s *next; // the next portal on this leaf
197 mleaf_t *here; // the leaf this portal is on
198 mleaf_t *past; // the leaf through this portal (infront)
201 vec3_t mins, maxs; // culling
206 typedef struct svbspmesh_s
208 struct svbspmesh_s *next;
209 int numverts, maxverts;
210 int numtriangles, maxtriangles;
218 #define Q2BSPVERSION 38
220 // leaffaces, leafbrushes, planes, and verts are still bounded by
221 // 16 bit short limits
223 //=============================================================================
225 #define Q2LUMP_ENTITIES 0
226 #define Q2LUMP_PLANES 1
227 #define Q2LUMP_VERTEXES 2
228 #define Q2LUMP_VISIBILITY 3
229 #define Q2LUMP_NODES 4
230 #define Q2LUMP_TEXINFO 5
231 #define Q2LUMP_FACES 6
232 #define Q2LUMP_LIGHTING 7
233 #define Q2LUMP_LEAFS 8
234 #define Q2LUMP_LEAFFACES 9
235 #define Q2LUMP_LEAFBRUSHES 10
236 #define Q2LUMP_EDGES 11
237 #define Q2LUMP_SURFEDGES 12
238 #define Q2LUMP_MODELS 13
239 #define Q2LUMP_BRUSHES 14
240 #define Q2LUMP_BRUSHSIDES 15
241 #define Q2LUMP_POP 16
242 #define Q2LUMP_AREAS 17
243 #define Q2LUMP_AREAPORTALS 18
244 #define Q2HEADER_LUMPS 19
246 typedef struct q2dheader_s
250 lump_t lumps[Q2HEADER_LUMPS];
253 typedef struct q2dmodel_s
255 float mins[3], maxs[3];
256 float origin[3]; // for sounds or lights
258 int firstface, numfaces; // submodels just draw faces
259 // without walking the bsp tree
262 // planes (x&~1) and (x&~1)+1 are always opposites
264 // contents flags are seperate bits
265 // a given brush can contribute multiple content bits
266 // multiple brushes can be in a single leaf
268 // these definitions also need to be in q_shared.h!
270 // lower bits are stronger, and will eat weaker brushes completely
271 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
272 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
273 #define Q2CONTENTS_AUX 4
274 #define Q2CONTENTS_LAVA 8
275 #define Q2CONTENTS_SLIME 16
276 #define Q2CONTENTS_WATER 32
277 #define Q2CONTENTS_MIST 64
278 #define Q2LAST_VISIBLE_CONTENTS 64
280 // remaining contents are non-visible, and don't eat brushes
282 #define Q2CONTENTS_AREAPORTAL 0x8000
284 #define Q2CONTENTS_PLAYERCLIP 0x10000
285 #define Q2CONTENTS_MONSTERCLIP 0x20000
287 // currents can be added to any other contents, and may be mixed
288 #define Q2CONTENTS_CURRENT_0 0x40000
289 #define Q2CONTENTS_CURRENT_90 0x80000
290 #define Q2CONTENTS_CURRENT_180 0x100000
291 #define Q2CONTENTS_CURRENT_270 0x200000
292 #define Q2CONTENTS_CURRENT_UP 0x400000
293 #define Q2CONTENTS_CURRENT_DOWN 0x800000
295 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
297 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
298 #define Q2CONTENTS_DEADMONSTER 0x4000000
299 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
300 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
301 #define Q2CONTENTS_LADDER 0x20000000
305 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
307 #define Q2SURF_SLICK 0x2 // effects game physics
309 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
310 #define Q2SURF_WARP 0x8 // turbulent water warp
311 #define Q2SURF_TRANS33 0x10
312 #define Q2SURF_TRANS66 0x20
313 #define Q2SURF_FLOWING 0x40 // scroll towards angle
314 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
319 typedef struct q2dnode_s
322 int children[2]; // negative numbers are -(leafs+1), not nodes
323 short mins[3]; // for frustom culling
325 unsigned short firstface;
326 unsigned short numfaces; // counting both sides
330 typedef struct q2texinfo_s
332 float vecs[2][4]; // [s/t][xyz offset]
333 int flags; // miptex flags + overrides
334 int value; // light emission, etc
335 char texture[32]; // texture name (textures/*.wal)
336 int nexttexinfo; // for animations, -1 = end of chain
339 typedef struct q2dleaf_s
341 int contents; // OR of all brushes (not needed?)
346 short mins[3]; // for frustum culling
349 unsigned short firstleafface;
350 unsigned short numleaffaces;
352 unsigned short firstleafbrush;
353 unsigned short numleafbrushes;
356 typedef struct q2dbrushside_s
358 unsigned short planenum; // facing out of the leaf
362 typedef struct q2dbrush_s
370 // the visibility lump consists of a header with a count, then
371 // byte offsets for the PVS and PHS of each cluster, then the raw
372 // compressed bit vectors
375 typedef struct q2dvis_s
378 int bitofs[8][2]; // bitofs[numclusters][2]
381 // each area has a list of portals that lead into other areas
382 // when portals are closed, other areas may not be visible or
383 // hearable even if the vis info says that it should be
384 typedef struct q2dareaportal_s
390 typedef struct q2darea_s
399 #define Q3BSPVERSION 46
400 #define Q3BSPVERSION_LIVE 47
401 #define Q3BSPVERSION_IG 48
403 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
404 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
405 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
406 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
407 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
408 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
409 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
410 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
411 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
412 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
413 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
414 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
415 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
416 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
417 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
418 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
419 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
420 #define Q3HEADER_LUMPS 17
421 #define Q3LUMP_ADVERTISEMENTS 17 // quake live stuff written by zeroradiant's q3map2 (ignored by DP)
422 #define Q3HEADER_LUMPS_LIVE 18
423 #define Q3HEADER_LUMPS_MAX 18
425 typedef struct q3dheader_s
429 lump_t lumps[Q3HEADER_LUMPS_MAX];
432 typedef struct q3dtexture_s
434 char name[Q3PATHLENGTH];
440 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
441 typedef struct q3dplane_s
448 typedef struct q3dnode_s
451 int childrenindex[2];
457 typedef struct q3dleaf_s
459 int clusterindex; // pvs index
460 int areaindex; // area index
470 typedef struct q3dmodel_s
481 typedef struct q3dbrush_s
489 typedef struct q3dbrushside_s
496 typedef struct q3dbrushside_ig_s
504 typedef struct q3dvertex_s
510 unsigned char color4ub[4];
514 typedef struct q3dmeshvertex_s
516 int offset; // first vertex index of mesh
520 typedef struct q3deffect_s
522 char shadername[Q3PATHLENGTH];
524 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
528 #define Q3FACETYPE_FLAT 1 // common
529 #define Q3FACETYPE_PATCH 2 // common
530 #define Q3FACETYPE_MESH 3 // common
531 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
533 typedef struct q3dface_s
536 int effectindex; // -1 if none
537 int type; // Q3FACETYPE
542 int lightmapindex; // -1 if none
543 int lightmap_base[2];
544 int lightmap_size[2];
549 // corrupt or don't care
556 // mesh is a collection of triangles on a plane, renderable as a mesh (NOT a polygon)
557 float lightmap_origin[3];
558 float lightmap_vectors[2][3];
566 // patch renders as a bezier mesh, with adjustable tesselation
567 // level (optionally based on LOD using the bbox and polygon
568 // count to choose a tesselation level)
569 // note: multiple patches may have the same bbox to cause them to
570 // be LOD adjusted together as a group
572 float mins[3]; // LOD bbox
573 float maxs[3]; // LOD bbox
575 int patchsize[2]; // dimensions of vertex grid
581 // mesh renders as simply a triangle mesh
591 // flare renders as a simple sprite at origin, no geometry
592 // exists, nor does it have a radius, a cvar controls the radius
593 // and another cvar controls distance fade
594 // (they were not used in Q3 I'm told)
604 typedef struct q3dlightmap_s
606 unsigned char rgb[128*128*3];
610 typedef struct q3dlightgrid_s
612 unsigned char ambientrgb[3];
613 unsigned char diffusergb[3];
614 unsigned char diffusepitch;
615 unsigned char diffuseyaw;
619 typedef struct q3dpvs_s
623 // unsigned char chains[];
624 // containing bits in 0-7 order (not 7-0 order),
625 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
629 // surfaceflags from bsp
630 #define Q3SURFACEFLAG_NODAMAGE 1
631 #define Q3SURFACEFLAG_SLICK 2
632 #define Q3SURFACEFLAG_SKY 4
633 #define Q3SURFACEFLAG_LADDER 8
634 #define Q3SURFACEFLAG_NOIMPACT 16
635 #define Q3SURFACEFLAG_NOMARKS 32
636 #define Q3SURFACEFLAG_FLESH 64
637 #define Q3SURFACEFLAG_NODRAW 128
638 #define Q3SURFACEFLAG_HINT 256
639 #define Q3SURFACEFLAG_SKIP 512
640 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
641 #define Q3SURFACEFLAG_POINTLIGHT 2048
642 #define Q3SURFACEFLAG_METALSTEPS 4096
643 #define Q3SURFACEFLAG_NOSTEPS 8192
644 #define Q3SURFACEFLAG_NONSOLID 16384
645 #define Q3SURFACEFLAG_LIGHTFILTER 32768
646 #define Q3SURFACEFLAG_ALPHASHADOW 65536
647 #define Q3SURFACEFLAG_NODLIGHT 131072
648 #define Q3SURFACEFLAG_DUST 262144
650 // surfaceparms from shaders
651 #define Q3SURFACEPARM_ALPHASHADOW 1
652 #define Q3SURFACEPARM_AREAPORTAL 2
653 #define Q3SURFACEPARM_CLUSTERPORTAL 4
654 #define Q3SURFACEPARM_DETAIL 8
655 #define Q3SURFACEPARM_DONOTENTER 16
656 #define Q3SURFACEPARM_FOG 32
657 #define Q3SURFACEPARM_LAVA 64
658 #define Q3SURFACEPARM_LIGHTFILTER 128
659 #define Q3SURFACEPARM_METALSTEPS 256
660 #define Q3SURFACEPARM_NODAMAGE 512
661 #define Q3SURFACEPARM_NODLIGHT 1024
662 #define Q3SURFACEPARM_NODRAW 2048
663 #define Q3SURFACEPARM_NODROP 4096
664 #define Q3SURFACEPARM_NOIMPACT 8192
665 #define Q3SURFACEPARM_NOLIGHTMAP 16384
666 #define Q3SURFACEPARM_NOMARKS 32768
667 #define Q3SURFACEPARM_NOMIPMAPS 65536
668 #define Q3SURFACEPARM_NONSOLID 131072
669 #define Q3SURFACEPARM_ORIGIN 262144
670 #define Q3SURFACEPARM_PLAYERCLIP 524288
671 #define Q3SURFACEPARM_SKY 1048576
672 #define Q3SURFACEPARM_SLICK 2097152
673 #define Q3SURFACEPARM_SLIME 4194304
674 #define Q3SURFACEPARM_STRUCTURAL 8388608
675 #define Q3SURFACEPARM_TRANS 16777216
676 #define Q3SURFACEPARM_WATER 33554432
677 #define Q3SURFACEPARM_POINTLIGHT 67108864
678 #define Q3SURFACEPARM_HINT 134217728
679 #define Q3SURFACEPARM_DUST 268435456
680 #define Q3SURFACEPARM_BOTCLIP 536870912
681 #define Q3SURFACEPARM_LIGHTGRID 1073741824
682 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
684 typedef struct q3mbrush_s
686 struct colbrushf_s *colbrushf;
688 struct q3mbrushside_s *firstbrushside;
689 struct texture_s *texture;
693 typedef struct q3mbrushside_s
695 struct mplane_s *plane;
696 struct texture_s *texture;
700 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
701 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
702 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)