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