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