now clears stencil to 128 instead of 0, this avoids problems with arbitrary incr...
[xonotic/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 // in memory representation
35 //
36 typedef struct
37 {
38         vec3_t position;
39 }
40 mvertex_t;
41
42 #define SIDE_FRONT 0
43 #define SIDE_BACK 1
44 #define SIDE_ON 2
45
46
47 // plane_t structure
48 typedef struct mplane_s
49 {
50         vec3_t normal;
51         float dist;
52         // for texture axis selection and fast side tests
53         int type;
54         int signbits;
55 }
56 mplane_t;
57
58 #define SHADERSTAGE_SKY 0
59 #define SHADERSTAGE_NORMAL 1
60 #define SHADERSTAGE_COUNT 2
61
62 #define SHADERFLAGS_NEEDLIGHTMAP 1
63
64 #define SURF_PLANEBACK 2
65 #define SURF_DRAWSKY 4
66 #define SURF_DRAWTURB 0x10
67 #define SURF_LIGHTMAP 0x20
68 #define SURF_DRAWNOALPHA 0x100
69 #define SURF_DRAWFULLBRIGHT 0x200
70 #define SURF_LIGHTBOTHSIDES 0x400
71 #define SURF_SHADOWCAST 0x1000 // this polygon can cast stencil shadows
72 #define SURF_SHADOWLIGHT 0x2000 // this polygon can be lit by stencil shadowing
73 #define SURF_WATERALPHA 0x4000 // this polygon's alpha is modulated by r_wateralpha
74
75 #define SURFRENDER_OPAQUE 0
76 #define SURFRENDER_ALPHA 1
77 #define SURFRENDER_ADD 2
78
79 struct entity_render_s;
80 struct texture_s;
81 struct msurface_s;
82 // change this stuff when real shaders are added
83 typedef struct Cshader_s
84 {
85         void (*shaderfunc[SHADERSTAGE_COUNT])(const struct entity_render_s *ent, const struct texture_s *texture, const struct msurface_s *firstsurf);
86         int flags;
87 }
88 Cshader_t;
89
90 extern Cshader_t Cshader_wall_lightmap;
91 extern Cshader_t Cshader_water;
92 extern Cshader_t Cshader_sky;
93
94 typedef struct texture_s
95 {
96         // name
97         char name[16];
98         // size
99         unsigned int width, height;
100         // SURF_ flags
101         unsigned int flags;
102
103         // type of rendering (SURFRENDER_ value)
104         int rendertype;
105
106         // base texture without fullbrights, never NULL
107         rtexture_t *texture;
108         // fullbrights texture, NULL if no fullbrights used
109         rtexture_t *glowtexture;
110         // alpha texture (used for fogging), NULL if opaque
111         rtexture_t *fogtexture;
112         // detail texture (usually not used if transparent)
113         rtexture_t *detailtexture;
114         // normalmap for bumpmap shading
115         rtexture_t *nmaptexture;
116         // color filtering for glossy surfaces
117         rtexture_t *glosstexture;
118
119         // shader to use for this texture
120         Cshader_t *shader;
121
122         // total frames in sequence and alternate sequence
123         int anim_total[2];
124         // direct pointers to each of the frames in the sequences
125         // (indexed as [alternate][frame])
126         struct texture_s *anim_frames[2][10];
127         // set if animated or there is an alternate frame set
128         // (this is an optimization in the renderer)
129         int animated;
130         // the current texture frame in animation
131         struct texture_s *currentframe;
132         // current alpha of the texture
133         float currentalpha;
134 }
135 texture_t;
136
137 typedef struct
138 {
139         unsigned short v[2];
140 }
141 medge_t;
142
143 typedef struct
144 {
145         float vecs[2][4];
146         texture_t *texture;
147         int flags;
148 }
149 mtexinfo_t;
150
151 // LordHavoc: replaces glpoly, triangle mesh
152 typedef struct surfmesh_s
153 {
154         // can be multiple meshs per surface
155         struct surfmesh_s *chain;
156         int numverts;
157         int numtriangles;
158         float *verts;
159         float *svectors;
160         float *tvectors;
161         float *normals;
162         int *lightmapoffsets;
163         float *str;
164         float *uvw;
165         float *abc;
166         int *index;
167         int *triangleneighbors;
168 }
169 surfmesh_t;
170
171 typedef struct msurface_s
172 {
173         // surface number, to avoid having to do a divide to find the number of a surface from it's address
174         int number;
175         // should be drawn if visframe == r_framecount (set by PrepareSurfaces)
176         int visframe;
177         // should be drawn if onscreen and not a backface (used for setting visframe)
178         //int pvsframe;
179         // chain of surfaces marked visible by pvs
180         //struct msurface_s *pvschain;
181
182         // the node plane this is on, backwards if SURF_PLANEBACK flag set
183         mplane_t *plane;
184         // SURF_ flags
185         int flags;
186         // rendering chain
187         struct msurface_s *texturechain;
188
189         // look up in model->surfedges[], negative numbers are backwards edges
190         int firstedge;
191         int numedges;
192
193         short texturemins[2];
194         short extents[2];
195
196         mtexinfo_t *texinfo;
197
198         // index into d_lightstylevalue array, 255 means not used (black)
199         qbyte styles[MAXLIGHTMAPS];
200         // RGB lighting data [numstyles][height][width][3]
201         qbyte *samples;
202         // stain to apply on lightmap (soot/dirt/blood/whatever)
203         qbyte *stainsamples;
204
205         // these fields are generated during model loading
206         // the lightmap texture fragment to use on the surface
207         rtexture_t *lightmaptexture;
208         // the stride when building lightmaps to comply with fragment update
209         int lightmaptexturestride;
210         // mesh for rendering
211         surfmesh_t *mesh;
212
213         // these are just 3D points defining the outline of the polygon,
214         // no texcoord info (that can be generated from these)
215         int poly_numverts;
216         float *poly_verts;
217         // bounding box for onscreen checks, and center for sorting
218         vec3_t poly_mins, poly_maxs, poly_center;
219
220         // neighboring surfaces (one per poly_numverts)
221         struct msurface_s **neighborsurfaces;
222         // currently used only for generating static shadow volumes
223         int castshadow;
224
225         // these are regenerated every frame
226         // lighting info
227         int dlightframe;
228         int dlightbits[8];
229         // avoid redundent addition of dlights
230         int lightframe;
231         // only render each surface once
232         //int worldnodeframe;
233
234         // these cause lightmap updates if regenerated
235         // values currently used in lightmap
236         unsigned short cached_light[MAXLIGHTMAPS];
237         // if lightmap was lit by dynamic lights, force update on next frame
238         short cached_dlight;
239         // to cause lightmap to be rerendered when v_overbrightbits changes
240         short cached_lightmapscalebit;
241         // rerender lightmaps when r_ambient changes
242         float cached_ambient;
243 }
244 msurface_t;
245
246 typedef struct mnode_s
247 {
248 // common with leaf
249         // always 0 in nodes
250         int contents;
251
252         struct mnode_s *parent;
253         struct mportal_s *portals;
254
255         // for bounding box culling
256         vec3_t mins;
257         vec3_t maxs;
258
259 // node specific
260         mplane_t *plane;
261         struct mnode_s *children[2];
262
263         unsigned short firstsurface;
264         unsigned short numsurfaces;
265 }
266 mnode_t;
267
268 typedef struct mleaf_s
269 {
270 // common with node
271         // always negative in leafs
272         int contents;
273
274         struct mnode_s *parent;
275         struct mportal_s *portals;
276
277         // for bounding box culling
278         vec3_t mins;
279         vec3_t maxs;
280
281 // leaf specific
282         // next leaf in pvschain
283         struct mleaf_s *pvschain;
284         // potentially visible if current (model->pvsframecount)
285         int pvsframe;
286         // visible if marked current (r_framecount)
287         int visframe;
288         // used by certain worldnode variants to avoid processing the same leaf twice in a frame
289         int worldnodeframe;
290         // used by polygon-through-portals visibility checker
291         int portalmarkid;
292
293         qbyte *compressed_vis;
294
295         int *firstmarksurface;
296         int nummarksurfaces;
297         qbyte ambient_sound_level[NUM_AMBIENTS];
298 }
299 mleaf_t;
300
301 typedef struct
302 {
303         dclipnode_t *clipnodes;
304         mplane_t *planes;
305         int firstclipnode;
306         int lastclipnode;
307         vec3_t clip_mins;
308         vec3_t clip_maxs;
309         vec3_t clip_size;
310 }
311 hull_t;
312
313 typedef struct mportal_s
314 {
315         struct mportal_s *next; // the next portal on this leaf
316         mleaf_t *here; // the leaf this portal is on
317         mleaf_t *past; // the leaf through this portal (infront)
318         mvertex_t *points;
319         int numpoints;
320         mplane_t plane;
321         int visframe; // is this portal visible this frame?
322 }
323 mportal_t;
324
325 typedef struct svbspmesh_s
326 {
327         struct svbspmesh_s *next;
328         int numverts, maxverts;
329         int numtriangles, maxtriangles;
330         float *verts;
331         int *elements;
332 }
333 svbspmesh_t;
334
335 typedef struct mlight_s
336 {
337         // location of light
338         vec3_t origin;
339         // distance attenuation scale (smaller is a larger light)
340         float falloff;
341         // color and brightness combined
342         vec3_t light;
343         // brightness bias, used for limiting radius without a hard edge
344         float subtract;
345         // spotlight direction
346         vec3_t spotdir;
347         // cosine of spotlight cone angle (or 0 if not a spotlight)
348         float spotcone;
349         // distance bias (larger value is softer and darker)
350         float distbias;
351         // light style controlling this light
352         int style;
353         // maximum extent of the light for shading purposes
354         float lightradius;
355         // maximum extent of the light for culling purposes
356         float cullradius;
357         float cullradius2;
358         /*
359         // surfaces this shines on
360         int numsurfaces;
361         msurface_t **surfaces;
362         // lit area
363         vec3_t mins, maxs;
364         // precomputed shadow volume meshs
365         //svbspmesh_t *shadowvolume;
366         //vec3_t shadowvolumemins, shadowvolumemaxs;
367         shadowmesh_t *shadowvolume;
368         */
369 }
370 mlight_t;
371
372 extern rtexture_t *r_notexture;
373 extern texture_t r_notexture_mip;
374
375 struct model_s;
376 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
377 void Mod_BrushInit(void);
378
379 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);
380 mleaf_t *Mod_PointInLeaf (const float *p, struct model_s *model);
381 int Mod_PointContents (const float *p, struct model_s *model);
382 qbyte *Mod_LeafPVS (mleaf_t *leaf, struct model_s *model);
383
384 #endif
385