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 ==============================================================================
34 // in memory representation
48 typedef struct mplane_s
52 // for texture axis selection and fast side tests
58 #define SHADERSTAGE_SKY 0
59 #define SHADERSTAGE_NORMAL 1
60 #define SHADERSTAGE_COUNT 2
62 #define SHADERFLAGS_NEEDLIGHTMAP 1
64 #define SURF_PLANEBACK 2
65 #define SURF_DRAWSKY 4
66 #define SURF_DRAWTURB 0x10
67 #define SURF_LIGHTMAP 0x20
68 #define SURF_DRAWNOALPHA 0x100
69 #define SURF_DRAWFULLBRIGHT 0x200
70 #define SURF_LIGHTBOTHSIDES 0x400
71 #define SURF_SHADOWCAST 0x1000 // this polygon can cast stencil shadows
72 #define SURF_SHADOWLIGHT 0x2000 // this polygon can be lit by stencil shadowing
73 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
74 #define SURF_SOLIDCLIP 0x8000 // this polygon blocks movement
76 #define SURFRENDER_OPAQUE 0
77 #define SURFRENDER_ALPHA 1
78 #define SURFRENDER_ADD 2
80 struct entity_render_s;
83 // change this stuff when real shaders are added
84 typedef struct Cshader_s
86 void (*shaderfunc[SHADERSTAGE_COUNT])(const struct entity_render_s *ent, const struct texture_s *texture, struct msurface_s **surfchain);
91 extern Cshader_t Cshader_wall_lightmap;
92 extern Cshader_t Cshader_water;
93 extern Cshader_t Cshader_sky;
95 typedef struct texture_s
100 unsigned int width, height;
104 // position in the model's textures array
107 // type of rendering (SURFRENDER_ value)
110 // loaded the same as model skins
113 // shader to use for this texture
116 // total frames in sequence and alternate sequence
118 // direct pointers to each of the frames in the sequences
119 // (indexed as [alternate][frame])
120 struct texture_s *anim_frames[2][10];
121 // set if animated or there is an alternate frame set
122 // (this is an optimization in the renderer)
124 // the current texture frame in animation
125 struct texture_s *currentframe;
126 // current alpha of the texture
145 // LordHavoc: replaces glpoly, triangle mesh
146 typedef struct surfmesh_s
148 int num_vertices; // number of vertices in the mesh
149 int num_triangles; // number of triangles in the mesh
150 float *data_vertex3f; // float[verts*3] vertex locations
151 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
152 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
153 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
154 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
155 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
156 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
157 float *data_texcoorddetail2f; // float[verts*2] texcoords for detail texture
158 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
159 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
163 typedef struct msurface_s
165 // bounding box for onscreen checks
169 // the node plane this is on, backwards if SURF_PLANEBACK flag set
173 // texture mapping properties used by this surface
176 // the lightmap texture fragment to use on the rendering mesh
177 rtexture_t *lightmaptexture;
178 // mesh for rendering
180 // if lightmap settings changed, this forces update
183 // should be drawn if visframe == r_framecount (set by PrepareSurfaces)
185 // should be drawn if onscreen and not a backface (used for setting visframe)
187 // chain of surfaces marked visible by pvs
188 //struct msurface_s *pvschain;
190 // surface number, to avoid having to do a divide to find the number of a surface from it's address
193 // center for sorting transparent meshes
196 // index into d_lightstylevalue array, 255 means not used (black)
197 qbyte styles[MAXLIGHTMAPS];
198 // RGB lighting data [numstyles][height][width][3]
200 // stain to apply on lightmap (soot/dirt/blood/whatever)
202 // the stride when building lightmaps to comply with fragment update
203 int lightmaptexturestride;
207 // if this == r_framecount there are dynamic lights on the surface
209 // which dynamic lights are touching this surface
210 // (only access this if dlightframe is current)
212 // avoid redundent addition of dlights
215 // avoid multiple collision traces with a surface polygon
218 // these are just 3D points defining the outline of the polygon,
219 // no texcoord info (that can be generated from these)
223 // neighboring surfaces (one per poly_numverts)
224 //struct msurface_s **neighborsurfaces;
225 // currently used only for generating static shadow volumes
230 typedef struct mnode_s
236 struct mnode_s *parent;
237 struct mportal_s *portals;
239 // for bounding box culling
245 struct mnode_s *children[2];
247 unsigned short firstsurface;
248 unsigned short numsurfaces;
252 typedef struct mleaf_s
255 // always negative in leafs
258 struct mnode_s *parent;
259 struct mportal_s *portals;
261 // for bounding box culling
266 // next leaf in pvschain
267 struct mleaf_s *pvschain;
268 // potentially visible if current (model->pvsframecount)
270 // visible if marked current (r_framecount)
272 // used by certain worldnode variants to avoid processing the same leaf twice in a frame
274 // used by polygon-through-portals visibility checker
277 // decompressed pvs bits (potentially visible set)
278 // note: never NULL, always present, may be full of 0xFF though
281 int *firstmarksurface;
283 qbyte ambient_sound_level[NUM_AMBIENTS];
289 dclipnode_t *clipnodes;
299 typedef struct mportal_s
301 struct mportal_s *next; // the next portal on this leaf
302 mleaf_t *here; // the leaf this portal is on
303 mleaf_t *past; // the leaf through this portal (infront)
307 int visframe; // is this portal visible this frame?
311 typedef struct svbspmesh_s
313 struct svbspmesh_s *next;
314 int numverts, maxverts;
315 int numtriangles, maxtriangles;
321 typedef struct mlight_s
325 // distance attenuation scale (smaller is a larger light)
327 // color and brightness combined
329 // brightness bias, used for limiting radius without a hard edge
331 // spotlight direction
333 // cosine of spotlight cone angle (or 0 if not a spotlight)
335 // distance bias (larger value is softer and darker)
337 // light style controlling this light
339 // maximum extent of the light for shading purposes
341 // maximum extent of the light for culling purposes
345 // surfaces this shines on
347 msurface_t **surfaces;
350 // precomputed shadow volume meshs
351 //svbspmesh_t *shadowvolume;
352 //vec3_t shadowvolumemins, shadowvolumemaxs;
353 shadowmesh_t *shadowvolume;
358 extern rtexture_t *r_notexture;
359 extern texture_t r_notexture_mip;
362 void Mod_Q1BSP_Load(struct model_s *mod, void *buffer);
363 void Mod_IBSP_Load(struct model_s *mod, void *buffer);
364 void Mod_MAP_Load(struct model_s *mod, void *buffer);
365 void Mod_BrushInit(void);
369 #define Q2BSPVERSION 38
371 // leaffaces, leafbrushes, planes, and verts are still bounded by
372 // 16 bit short limits
374 //=============================================================================
376 #define Q2LUMP_ENTITIES 0
377 #define Q2LUMP_PLANES 1
378 #define Q2LUMP_VERTEXES 2
379 #define Q2LUMP_VISIBILITY 3
380 #define Q2LUMP_NODES 4
381 #define Q2LUMP_TEXINFO 5
382 #define Q2LUMP_FACES 6
383 #define Q2LUMP_LIGHTING 7
384 #define Q2LUMP_LEAFS 8
385 #define Q2LUMP_LEAFFACES 9
386 #define Q2LUMP_LEAFBRUSHES 10
387 #define Q2LUMP_EDGES 11
388 #define Q2LUMP_SURFEDGES 12
389 #define Q2LUMP_MODELS 13
390 #define Q2LUMP_BRUSHES 14
391 #define Q2LUMP_BRUSHSIDES 15
392 #define Q2LUMP_POP 16
393 #define Q2LUMP_AREAS 17
394 #define Q2LUMP_AREAPORTALS 18
395 #define Q2HEADER_LUMPS 19
401 lump_t lumps[HEADER_LUMPS];
406 float mins[3], maxs[3];
407 float origin[3]; // for sounds or lights
409 int firstface, numfaces; // submodels just draw faces
410 // without walking the bsp tree
413 // planes (x&~1) and (x&~1)+1 are always opposites
415 // contents flags are seperate bits
416 // a given brush can contribute multiple content bits
417 // multiple brushes can be in a single leaf
419 // these definitions also need to be in q_shared.h!
421 // lower bits are stronger, and will eat weaker brushes completely
422 #define Q2CONTENTS_SOLID 1 // an eye is never valid in a solid
423 #define Q2CONTENTS_WINDOW 2 // translucent, but not watery
424 #define Q2CONTENTS_AUX 4
425 #define Q2CONTENTS_LAVA 8
426 #define Q2CONTENTS_SLIME 16
427 #define Q2CONTENTS_WATER 32
428 #define Q2CONTENTS_MIST 64
429 #define Q2LAST_VISIBLE_CONTENTS 64
431 // remaining contents are non-visible, and don't eat brushes
433 #define Q2CONTENTS_AREAPORTAL 0x8000
435 #define Q2CONTENTS_PLAYERCLIP 0x10000
436 #define Q2CONTENTS_MONSTERCLIP 0x20000
438 // currents can be added to any other contents, and may be mixed
439 #define Q2CONTENTS_CURRENT_0 0x40000
440 #define Q2CONTENTS_CURRENT_90 0x80000
441 #define Q2CONTENTS_CURRENT_180 0x100000
442 #define Q2CONTENTS_CURRENT_270 0x200000
443 #define Q2CONTENTS_CURRENT_UP 0x400000
444 #define Q2CONTENTS_CURRENT_DOWN 0x800000
446 #define Q2CONTENTS_ORIGIN 0x1000000 // removed before bsping an entity
448 #define Q2CONTENTS_MONSTER 0x2000000 // should never be on a brush, only in game
449 #define Q2CONTENTS_DEADMONSTER 0x4000000
450 #define Q2CONTENTS_DETAIL 0x8000000 // brushes to be added after vis leafs
451 #define Q2CONTENTS_TRANSLUCENT 0x10000000 // auto set if any surface has trans
452 #define Q2CONTENTS_LADDER 0x20000000
456 #define Q2SURF_LIGHT 0x1 // value will hold the light strength
458 #define Q2SURF_SLICK 0x2 // effects game physics
460 #define Q2SURF_SKY 0x4 // don't draw, but add to skybox
461 #define Q2SURF_WARP 0x8 // turbulent water warp
462 #define Q2SURF_TRANS33 0x10
463 #define Q2SURF_TRANS66 0x20
464 #define Q2SURF_FLOWING 0x40 // scroll towards angle
465 #define Q2SURF_NODRAW 0x80 // don't bother referencing the texture
473 int children[2]; // negative numbers are -(leafs+1), not nodes
474 short mins[3]; // for frustom culling
476 unsigned short firstface;
477 unsigned short numfaces; // counting both sides
483 float vecs[2][4]; // [s/t][xyz offset]
484 int flags; // miptex flags + overrides
485 int value; // light emission, etc
486 char texture[32]; // texture name (textures/*.wal)
487 int nexttexinfo; // for animations, -1 = end of chain
492 int contents; // OR of all brushes (not needed?)
497 short mins[3]; // for frustum culling
500 unsigned short firstleafface;
501 unsigned short numleaffaces;
503 unsigned short firstleafbrush;
504 unsigned short numleafbrushes;
509 unsigned short planenum; // facing out of the leaf
521 // the visibility lump consists of a header with a count, then
522 // byte offsets for the PVS and PHS of each cluster, then the raw
523 // compressed bit vectors
529 int bitofs[8][2]; // bitofs[numclusters][2]
532 // each area has a list of portals that lead into other areas
533 // when portals are closed, other areas may not be visible or
534 // hearable even if the vis info says that it should be
550 #define Q3BSPVERSION 46
552 #define Q3LUMP_ENTITIES 0 // entities to spawn (used by server and client)
553 #define Q3LUMP_TEXTURES 1 // textures used (used by faces)
554 #define Q3LUMP_PLANES 2 // planes used (used by bsp nodes)
555 #define Q3LUMP_NODES 3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
556 #define Q3LUMP_LEAFS 4 // bsp leafs (used by bsp nodes)
557 #define Q3LUMP_LEAFFACES 5 // array of ints indexing faces (used by leafs)
558 #define Q3LUMP_LEAFBRUSHES 6 // array of ints indexing brushes (used by leafs)
559 #define Q3LUMP_MODELS 7 // models (used by rendering, collisions)
560 #define Q3LUMP_BRUSHES 8 // brushes (used by effects, collisions)
561 #define Q3LUMP_BRUSHSIDES 9 // brush faces (used by brushes)
562 #define Q3LUMP_VERTICES 10 // mesh vertices (used by faces)
563 #define Q3LUMP_TRIANGLES 11 // mesh triangles (used by faces)
564 #define Q3LUMP_EFFECTS 12 // fog (used by faces)
565 #define Q3LUMP_FACES 13 // surfaces (used by leafs)
566 #define Q3LUMP_LIGHTMAPS 14 // lightmap textures (used by faces)
567 #define Q3LUMP_LIGHTGRID 15 // lighting as a voxel grid (used by rendering)
568 #define Q3LUMP_PVS 16 // potentially visible set; bit[clusters][clusters] (used by rendering)
569 #define Q3HEADER_LUMPS 17
571 #define Q3PATHLENGTH 64
577 lump_t lumps[HEADER_LUMPS];
582 char name[Q3PATHLENGTH];
588 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
599 int childrenindex[2];
607 int clusterindex; // pvs index
608 int areaindex; // area index
650 unsigned char color4ub[4];
656 int offset; // first vertex index of mesh
662 char shadername[Q3PATHLENGTH];
664 int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
668 #define Q3FACETYPE_POLYGON 1 // common
669 #define Q3FACETYPE_PATCH 2 // common
670 #define Q3FACETYPE_MESH 3 // common
671 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
676 int effectindex; // -1 if none
677 int type; // Q3FACETYPE
682 int lightmapindex; // -1 if none
683 int lightmap_base[2];
684 int lightmap_size[2];
689 // corrupt or don't care
695 // Q3FACETYPE_POLYGON
696 // polygon is simply a convex polygon, renderable as a mesh
697 float lightmap_origin[3];
698 float lightmap_vectors[2][3];
706 // patch renders as a bezier mesh, with adjustable tesselation
707 // level (optionally based on LOD using the bbox and polygon
708 // count to choose a tesselation level)
709 // note: multiple patches may have the same bbox to cause them to
710 // be LOD adjusted together as a group
712 float mins[3]; // LOD bbox
713 float maxs[3]; // LOD bbox
715 int patchsize[2]; // dimensions of vertex grid
721 // mesh renders as simply a triangle mesh
731 // flare renders as a simple sprite at origin, no geometry
732 // exists, nor does it have a radius, a cvar controls the radius
733 // and another cvar controls distance fade
734 // (they were not used in Q3 I'm told)
746 unsigned char rgb[128*128*3];
752 unsigned char ambientrgb[3];
753 unsigned char diffusergb[3];
754 unsigned char diffusepitch;
755 unsigned char diffuseyaw;
763 // unsigned char chains[];
764 // containing bits in 0-7 order (not 7-0 order),
765 // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))