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