eliminated RENDER_NOCULLFACE (now uses MATERIALFLAG_NOCULLFACE on a texture)
[divverent/darkplaces.git] / model_brush.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20
21 #ifndef MODEL_BRUSH_H
22 #define MODEL_BRUSH_H
23
24 /*
25 ==============================================================================
26
27 BRUSH MODELS
28
29 ==============================================================================
30 */
31
32 #define Q3PATHLENGTH 64
33
34
35 //
36 // in memory representation
37 //
38 typedef struct mvertex_s
39 {
40         vec3_t position;
41 }
42 mvertex_t;
43
44 #define SIDE_FRONT 0
45 #define SIDE_BACK 1
46 #define SIDE_ON 2
47
48
49 // plane_t structure
50 typedef struct mplane_s
51 {
52         vec3_t normal;
53         float dist;
54         // for texture axis selection and fast side tests
55         int type;
56         int signbits;
57 }
58 mplane_t;
59
60 #define SHADERSTAGE_SKY 0
61 #define SHADERSTAGE_NORMAL 1
62 #define SHADERSTAGE_COUNT 2
63
64 //#define SURF_PLANEBACK 2
65
66 // set for anything to be transparent sorted
67 #define MATERIALFLAG_TRANSPARENT 1
68 // use alpha blend on this material
69 #define MATERIALFLAG_ALPHA 2
70 // use additive blend on this material
71 #define MATERIALFLAG_ADD 4
72 // turn off depth test on this material
73 #define MATERIALFLAG_NODEPTHTEST 8
74 // multiply alpha by r_wateralpha cvar
75 #define MATERIALFLAG_WATERALPHA 16
76 // draw with no lighting
77 #define MATERIALFLAG_FULLBRIGHT 32
78 // drawn as a normal lightmapped wall
79 #define MATERIALFLAG_WALL 64
80 // swirling water effect
81 #define MATERIALFLAG_WATER 128
82 // this surface shows the sky
83 // skipped if transparent
84 #define MATERIALFLAG_SKY 256
85 // skips drawing the surface
86 #define MATERIALFLAG_NODRAW 512
87 // probably used only on q1bsp water
88 #define MATERIALFLAG_LIGHTBOTHSIDES 1024
89 // use alpha test on this material
90 #define MATERIALFLAG_ALPHATEST 2048
91 // treat this material as a blended transparency (as opposed to an alpha test
92 // transparency), this causes special fog behavior, and disables glDepthMask
93 #define MATERIALFLAG_BLENDED 4096
94 // render using a custom blendfunc
95 #define MATERIALFLAG_CUSTOMBLEND 8192
96 // do not cast shadows from this material
97 #define MATERIALFLAG_NOSHADOW 16384
98 // render using vertex alpha (q3bsp) as texture blend parameter between foreground (normal) skinframe and background skinframe
99 #define MATERIALFLAG_VERTEXTEXTUREBLEND 32768
100 // disables GL_CULL_FACE on this texture (making it double sided)
101 #define MATERIALFLAG_NOCULLFACE 65536
102
103 typedef struct medge_s
104 {
105         unsigned short v[2];
106 }
107 medge_t;
108
109 struct entity_render_s;
110 struct texture_s;
111 struct msurface_s;
112
113 typedef struct mnode_s
114 {
115         //this part shared between node and leaf
116         mplane_t *plane; // != NULL
117         struct mnode_s *parent;
118         struct mportal_s *portals;
119         // for bounding box culling
120         vec3_t mins;
121         vec3_t maxs;
122         // supercontents from all brushes inside this node or leaf
123         int combinedsupercontents;
124
125         // this part unique to node
126         struct mnode_s *children[2];
127
128         // q1bsp specific
129         unsigned short firstsurface;
130         unsigned short numsurfaces;
131 }
132 mnode_t;
133
134 typedef struct mleaf_s
135 {
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
141         vec3_t mins;
142         vec3_t maxs;
143         // supercontents from all brushes inside this node or leaf
144         int combinedsupercontents;
145
146         // this part unique to leaf
147         // common
148         int clusterindex; // -1 is not in pvs, >= 0 is pvs bit number
149         int areaindex; // q3bsp
150         int containscollisionsurfaces; // indicates whether the leafsurfaces contains q3 patches
151         int numleafsurfaces;
152         int *firstleafsurface;
153         int numleafbrushes; // q3bsp
154         int *firstleafbrush; // q3bsp
155         unsigned char ambient_sound_level[NUM_AMBIENTS]; // q1bsp
156         int contents; // q1bsp: // TODO: remove (only used temporarily during loading when making collision hull 0)
157         int portalmarkid; // q1bsp // used by see-polygon-through-portals visibility checker
158 }
159 mleaf_t;
160
161 typedef struct hull_s
162 {
163         dclipnode_t *clipnodes;
164         mplane_t *planes;
165         int firstclipnode;
166         int lastclipnode;
167         vec3_t clip_mins;
168         vec3_t clip_maxs;
169         vec3_t clip_size;
170 }
171 hull_t;
172
173 typedef struct mportal_s
174 {
175         struct mportal_s *next; // the next portal on this leaf
176         mleaf_t *here; // the leaf this portal is on
177         mleaf_t *past; // the leaf through this portal (infront)
178         int numpoints;
179         mvertex_t *points;
180         vec3_t mins, maxs; // culling
181         mplane_t plane;
182 }
183 mportal_t;
184
185 typedef struct svbspmesh_s
186 {
187         struct svbspmesh_s *next;
188         int numverts, maxverts;
189         int numtriangles, maxtriangles;
190         float *verts;
191         int *elements;
192 }
193 svbspmesh_t;
194
195 // Q2 bsp stuff
196
197 #define Q2BSPVERSION    38
198
199 // leaffaces, leafbrushes, planes, and verts are still bounded by
200 // 16 bit short limits
201
202 //=============================================================================
203
204 #define Q2LUMP_ENTITIES         0
205 #define Q2LUMP_PLANES                   1
206 #define Q2LUMP_VERTEXES         2
207 #define Q2LUMP_VISIBILITY               3
208 #define Q2LUMP_NODES                    4
209 #define Q2LUMP_TEXINFO          5
210 #define Q2LUMP_FACES                    6
211 #define Q2LUMP_LIGHTING         7
212 #define Q2LUMP_LEAFS                    8
213 #define Q2LUMP_LEAFFACES                9
214 #define Q2LUMP_LEAFBRUSHES      10
215 #define Q2LUMP_EDGES                    11
216 #define Q2LUMP_SURFEDGES                12
217 #define Q2LUMP_MODELS                   13
218 #define Q2LUMP_BRUSHES          14
219 #define Q2LUMP_BRUSHSIDES               15
220 #define Q2LUMP_POP                      16
221 #define Q2LUMP_AREAS                    17
222 #define Q2LUMP_AREAPORTALS      18
223 #define Q2HEADER_LUMPS          19
224
225 typedef struct q2dheader_s
226 {
227         int                     ident;
228         int                     version;
229         lump_t          lumps[Q2HEADER_LUMPS];
230 } q2dheader_t;
231
232 typedef struct q2dmodel_s
233 {
234         float           mins[3], maxs[3];
235         float           origin[3];              // for sounds or lights
236         int                     headnode;
237         int                     firstface, numfaces;    // submodels just draw faces
238                                                                                 // without walking the bsp tree
239 } q2dmodel_t;
240
241 // planes (x&~1) and (x&~1)+1 are always opposites
242
243 // contents flags are seperate bits
244 // a given brush can contribute multiple content bits
245 // multiple brushes can be in a single leaf
246
247 // these definitions also need to be in q_shared.h!
248
249 // lower bits are stronger, and will eat weaker brushes completely
250 #define Q2CONTENTS_SOLID                        1               // an eye is never valid in a solid
251 #define Q2CONTENTS_WINDOW                       2               // translucent, but not watery
252 #define Q2CONTENTS_AUX                  4
253 #define Q2CONTENTS_LAVA                 8
254 #define Q2CONTENTS_SLIME                        16
255 #define Q2CONTENTS_WATER                        32
256 #define Q2CONTENTS_MIST                 64
257 #define Q2LAST_VISIBLE_CONTENTS 64
258
259 // remaining contents are non-visible, and don't eat brushes
260
261 #define Q2CONTENTS_AREAPORTAL           0x8000
262
263 #define Q2CONTENTS_PLAYERCLIP           0x10000
264 #define Q2CONTENTS_MONSTERCLIP  0x20000
265
266 // currents can be added to any other contents, and may be mixed
267 #define Q2CONTENTS_CURRENT_0            0x40000
268 #define Q2CONTENTS_CURRENT_90           0x80000
269 #define Q2CONTENTS_CURRENT_180  0x100000
270 #define Q2CONTENTS_CURRENT_270  0x200000
271 #define Q2CONTENTS_CURRENT_UP           0x400000
272 #define Q2CONTENTS_CURRENT_DOWN 0x800000
273
274 #define Q2CONTENTS_ORIGIN                       0x1000000       // removed before bsping an entity
275
276 #define Q2CONTENTS_MONSTER              0x2000000       // should never be on a brush, only in game
277 #define Q2CONTENTS_DEADMONSTER  0x4000000
278 #define Q2CONTENTS_DETAIL                       0x8000000       // brushes to be added after vis leafs
279 #define Q2CONTENTS_TRANSLUCENT  0x10000000      // auto set if any surface has trans
280 #define Q2CONTENTS_LADDER                       0x20000000
281
282
283
284 #define Q2SURF_LIGHT            0x1             // value will hold the light strength
285
286 #define Q2SURF_SLICK            0x2             // effects game physics
287
288 #define Q2SURF_SKY              0x4             // don't draw, but add to skybox
289 #define Q2SURF_WARP             0x8             // turbulent water warp
290 #define Q2SURF_TRANS33  0x10
291 #define Q2SURF_TRANS66  0x20
292 #define Q2SURF_FLOWING  0x40    // scroll towards angle
293 #define Q2SURF_NODRAW           0x80    // don't bother referencing the texture
294
295
296
297
298 typedef struct q2dnode_s
299 {
300         int                     planenum;
301         int                     children[2];    // negative numbers are -(leafs+1), not nodes
302         short           mins[3];                // for frustom culling
303         short           maxs[3];
304         unsigned short  firstface;
305         unsigned short  numfaces;       // counting both sides
306 } q2dnode_t;
307
308
309 typedef struct q2texinfo_s
310 {
311         float           vecs[2][4];             // [s/t][xyz offset]
312         int                     flags;                  // miptex flags + overrides
313         int                     value;                  // light emission, etc
314         char            texture[32];    // texture name (textures/*.wal)
315         int                     nexttexinfo;    // for animations, -1 = end of chain
316 } q2texinfo_t;
317
318 typedef struct q2dleaf_s
319 {
320         int                             contents;                       // OR of all brushes (not needed?)
321
322         short                   cluster;
323         short                   area;
324
325         short                   mins[3];                        // for frustum culling
326         short                   maxs[3];
327
328         unsigned short  firstleafface;
329         unsigned short  numleaffaces;
330
331         unsigned short  firstleafbrush;
332         unsigned short  numleafbrushes;
333 } q2dleaf_t;
334
335 typedef struct q2dbrushside_s
336 {
337         unsigned short  planenum;               // facing out of the leaf
338         short   texinfo;
339 } q2dbrushside_t;
340
341 typedef struct q2dbrush_s
342 {
343         int                     firstside;
344         int                     numsides;
345         int                     contents;
346 } q2dbrush_t;
347
348
349 // the visibility lump consists of a header with a count, then
350 // byte offsets for the PVS and PHS of each cluster, then the raw
351 // compressed bit vectors
352 #define Q2DVIS_PVS      0
353 #define Q2DVIS_PHS      1
354 typedef struct q2dvis_s
355 {
356         int                     numclusters;
357         int                     bitofs[8][2];   // bitofs[numclusters][2]
358 } q2dvis_t;
359
360 // each area has a list of portals that lead into other areas
361 // when portals are closed, other areas may not be visible or
362 // hearable even if the vis info says that it should be
363 typedef struct q2dareaportal_s
364 {
365         int             portalnum;
366         int             otherarea;
367 } q2dareaportal_t;
368
369 typedef struct q2darea_s
370 {
371         int             numareaportals;
372         int             firstareaportal;
373 } q2darea_t;
374
375
376 //Q3 bsp stuff
377
378 #define Q3BSPVERSION    46
379
380 #define Q3LUMP_ENTITIES         0 // entities to spawn (used by server and client)
381 #define Q3LUMP_TEXTURES         1 // textures used (used by faces)
382 #define Q3LUMP_PLANES           2 // planes used (used by bsp nodes)
383 #define Q3LUMP_NODES            3 // bsp nodes (used by bsp nodes, bsp leafs, rendering, collisions)
384 #define Q3LUMP_LEAFS            4 // bsp leafs (used by bsp nodes)
385 #define Q3LUMP_LEAFFACES        5 // array of ints indexing faces (used by leafs)
386 #define Q3LUMP_LEAFBRUSHES      6 // array of ints indexing brushes (used by leafs)
387 #define Q3LUMP_MODELS           7 // models (used by rendering, collisions)
388 #define Q3LUMP_BRUSHES          8 // brushes (used by effects, collisions)
389 #define Q3LUMP_BRUSHSIDES       9 // brush faces (used by brushes)
390 #define Q3LUMP_VERTICES         10 // mesh vertices (used by faces)
391 #define Q3LUMP_TRIANGLES        11 // mesh triangles (used by faces)
392 #define Q3LUMP_EFFECTS          12 // fog (used by faces)
393 #define Q3LUMP_FACES            13 // surfaces (used by leafs)
394 #define Q3LUMP_LIGHTMAPS        14 // lightmap textures (used by faces)
395 #define Q3LUMP_LIGHTGRID        15 // lighting as a voxel grid (used by rendering)
396 #define Q3LUMP_PVS                      16 // potentially visible set; bit[clusters][clusters] (used by rendering)
397 #define Q3HEADER_LUMPS          17
398
399 typedef struct q3dheader_s
400 {
401         int                     ident;
402         int                     version;
403         lump_t          lumps[Q3HEADER_LUMPS];
404 } q3dheader_t;
405
406 typedef struct q3dtexture_s
407 {
408         char name[Q3PATHLENGTH];
409         int surfaceflags;
410         int contents;
411 }
412 q3dtexture_t;
413
414 // note: planes are paired, the pair of planes with i and i ^ 1 are opposites.
415 typedef struct q3dplane_s
416 {
417         float normal[3];
418         float dist;
419 }
420 q3dplane_t;
421
422 typedef struct q3dnode_s
423 {
424         int planeindex;
425         int childrenindex[2];
426         int mins[3];
427         int maxs[3];
428 }
429 q3dnode_t;
430
431 typedef struct q3dleaf_s
432 {
433         int clusterindex; // pvs index
434         int areaindex; // area index
435         int mins[3];
436         int maxs[3];
437         int firstleafface;
438         int numleaffaces;
439         int firstleafbrush;
440         int numleafbrushes;
441 }
442 q3dleaf_t;
443
444 typedef struct q3dmodel_s
445 {
446         float mins[3];
447         float maxs[3];
448         int firstface;
449         int numfaces;
450         int firstbrush;
451         int numbrushes;
452 }
453 q3dmodel_t;
454
455 typedef struct q3dbrush_s
456 {
457         int firstbrushside;
458         int numbrushsides;
459         int textureindex;
460 }
461 q3dbrush_t;
462
463 typedef struct q3dbrushside_s
464 {
465         int planeindex;
466         int textureindex;
467 }
468 q3dbrushside_t;
469
470 typedef struct q3dvertex_s
471 {
472         float origin3f[3];
473         float texcoord2f[2];
474         float lightmap2f[2];
475         float normal3f[3];
476         unsigned char color4ub[4];
477 }
478 q3dvertex_t;
479
480 typedef struct q3dmeshvertex_s
481 {
482         int offset; // first vertex index of mesh
483 }
484 q3dmeshvertex_t;
485
486 typedef struct q3deffect_s
487 {
488         char shadername[Q3PATHLENGTH];
489         int brushindex;
490         int unknown; // I read this is always 5 except in q3dm8 which has one effect with -1
491 }
492 q3deffect_t;
493
494 #define Q3FACETYPE_POLYGON 1 // common
495 #define Q3FACETYPE_PATCH 2 // common
496 #define Q3FACETYPE_MESH 3 // common
497 #define Q3FACETYPE_FLARE 4 // rare (is this ever used?)
498
499 typedef struct q3dface_s
500 {
501         int textureindex;
502         int effectindex; // -1 if none
503         int type; // Q3FACETYPE
504         int firstvertex;
505         int numvertices;
506         int firstelement;
507         int numelements;
508         int lightmapindex; // -1 if none
509         int lightmap_base[2];
510         int lightmap_size[2];
511         union
512         {
513                 struct
514                 {
515                         // corrupt or don't care
516                         int blah[14];
517                 }
518                 unknown;
519                 struct
520                 {
521                         // Q3FACETYPE_POLYGON
522                         // polygon is simply a convex polygon, renderable as a mesh
523                         float lightmap_origin[3];
524                         float lightmap_vectors[2][3];
525                         float normal[3];
526                         int unused1[2];
527                 }
528                 polygon;
529                 struct
530                 {
531                         // Q3FACETYPE_PATCH
532                         // patch renders as a bezier mesh, with adjustable tesselation
533                         // level (optionally based on LOD using the bbox and polygon
534                         // count to choose a tesselation level)
535                         // note: multiple patches may have the same bbox to cause them to
536                         // be LOD adjusted together as a group
537                         int unused1[3];
538                         float mins[3]; // LOD bbox
539                         float maxs[3]; // LOD bbox
540                         int unused2[3];
541                         int patchsize[2]; // dimensions of vertex grid
542                 }
543                 patch;
544                 struct
545                 {
546                         // Q3FACETYPE_MESH
547                         // mesh renders as simply a triangle mesh
548                         int unused1[3];
549                         float mins[3];
550                         float maxs[3];
551                         int unused2[5];
552                 }
553                 mesh;
554                 struct
555                 {
556                         // Q3FACETYPE_FLARE
557                         // flare renders as a simple sprite at origin, no geometry
558                         // exists, nor does it have a radius, a cvar controls the radius
559                         // and another cvar controls distance fade
560                         // (they were not used in Q3 I'm told)
561                         float origin[3];
562                         int unused1[11];
563                 }
564                 flare;
565         }
566         specific;
567 }
568 q3dface_t;
569
570 typedef struct q3dlightmap_s
571 {
572         unsigned char rgb[128*128*3];
573 }
574 q3dlightmap_t;
575
576 typedef struct q3dlightgrid_s
577 {
578         unsigned char ambientrgb[3];
579         unsigned char diffusergb[3];
580         unsigned char diffusepitch;
581         unsigned char diffuseyaw;
582 }
583 q3dlightgrid_t;
584
585 typedef struct q3dpvs_s
586 {
587         int numclusters;
588         int chainlength;
589         // unsigned char chains[];
590         // containing bits in 0-7 order (not 7-0 order),
591         // pvschains[mycluster * chainlength + (thatcluster >> 3)] & (1 << (thatcluster & 7))
592 }
593 q3dpvs_t;
594
595 // surfaceflags from bsp
596 #define Q3SURFACEFLAG_NODAMAGE 1
597 #define Q3SURFACEFLAG_SLICK 2
598 #define Q3SURFACEFLAG_SKY 4
599 #define Q3SURFACEFLAG_LADDER 8
600 #define Q3SURFACEFLAG_NOIMPACT 16
601 #define Q3SURFACEFLAG_NOMARKS 32
602 #define Q3SURFACEFLAG_FLESH 64
603 #define Q3SURFACEFLAG_NODRAW 128
604 #define Q3SURFACEFLAG_HINT 256
605 #define Q3SURFACEFLAG_SKIP 512
606 #define Q3SURFACEFLAG_NOLIGHTMAP 1024
607 #define Q3SURFACEFLAG_POINTLIGHT 2048
608 #define Q3SURFACEFLAG_METALSTEPS 4096
609 #define Q3SURFACEFLAG_NOSTEPS 8192
610 #define Q3SURFACEFLAG_NONSOLID 16384
611 #define Q3SURFACEFLAG_LIGHTFILTER 32768
612 #define Q3SURFACEFLAG_ALPHASHADOW 65536
613 #define Q3SURFACEFLAG_NODLIGHT 131072
614 #define Q3SURFACEFLAG_DUST 262144
615
616 // surfaceparms from shaders
617 #define Q3SURFACEPARM_ALPHASHADOW 1
618 #define Q3SURFACEPARM_AREAPORTAL 2
619 #define Q3SURFACEPARM_CLUSTERPORTAL 4
620 #define Q3SURFACEPARM_DETAIL 8
621 #define Q3SURFACEPARM_DONOTENTER 16
622 #define Q3SURFACEPARM_FOG 32
623 #define Q3SURFACEPARM_LAVA 64
624 #define Q3SURFACEPARM_LIGHTFILTER 128
625 #define Q3SURFACEPARM_METALSTEPS 256
626 #define Q3SURFACEPARM_NODAMAGE 512
627 #define Q3SURFACEPARM_NODLIGHT 1024
628 #define Q3SURFACEPARM_NODRAW 2048
629 #define Q3SURFACEPARM_NODROP 4096
630 #define Q3SURFACEPARM_NOIMPACT 8192
631 #define Q3SURFACEPARM_NOLIGHTMAP 16384
632 #define Q3SURFACEPARM_NOMARKS 32768
633 #define Q3SURFACEPARM_NOMIPMAPS 65536
634 #define Q3SURFACEPARM_NONSOLID 131072
635 #define Q3SURFACEPARM_ORIGIN 262144
636 #define Q3SURFACEPARM_PLAYERCLIP 524288
637 #define Q3SURFACEPARM_SKY 1048576
638 #define Q3SURFACEPARM_SLICK 2197152
639 #define Q3SURFACEPARM_SLIME 4194304
640 #define Q3SURFACEPARM_STRUCTURAL 8388608
641 #define Q3SURFACEPARM_TRANS 16777216
642 #define Q3SURFACEPARM_WATER 33554432
643 #define Q3SURFACEPARM_POINTLIGHT 67108864
644 #define Q3SURFACEPARM_HINT 134217728
645 #define Q3SURFACEPARM_DUST 268435456
646 #define Q3SURFACEPARM_BOTCLIP 536870912
647 #define Q3SURFACEPARM_LIGHTGRID 1073741824
648 #define Q3SURFACEPARM_ANTIPORTAL 2147483648u
649
650 // various flags from shaders, used for special effects not otherwise classified
651 #define Q3TEXTUREFLAG_TWOSIDED 1
652 #define Q3TEXTUREFLAG_AUTOSPRITE 2
653 #define Q3TEXTUREFLAG_AUTOSPRITE2 4
654 #define Q3TEXTUREFLAG_NOPICMIP 16
655
656 typedef struct q3mbrush_s
657 {
658         struct colbrushf_s *colbrushf;
659         int numbrushsides;
660         struct q3mbrushside_s *firstbrushside;
661         struct texture_s *texture;
662 }
663 q3mbrush_t;
664
665 typedef struct q3mbrushside_s
666 {
667         struct mplane_s *plane;
668         struct texture_s *texture;
669 }
670 q3mbrushside_t;
671
672 #define CHECKPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] & (1 << ((b) & 7))) : false)
673 #define SETPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] |= (1 << ((b) & 7))) : false)
674 #define CLEARPVSBIT(pvs,b) ((b) >= 0 ? ((pvs)[(b) >> 3] &= ~(1 << ((b) & 7))) : false)
675
676 #endif
677