renamed byte to qbyte throughout engine to eliminate a mingw conflict
[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 /*
22 ==============================================================================
23
24 BRUSH MODELS
25
26 ==============================================================================
27 */
28
29
30 //
31 // in memory representation
32 //
33 typedef struct
34 {
35         vec3_t          position;
36 }
37 mvertex_t;
38
39 #define SIDE_FRONT      0
40 #define SIDE_BACK       1
41 #define SIDE_ON         2
42
43
44 // plane_t structure
45 typedef struct mplane_s
46 {
47         vec3_t  normal;
48         float   dist;
49         int             type;                   // for texture axis selection and fast side tests
50         // LordHavoc: faster than id's signbits system
51         int (*BoxOnPlaneSideFunc) (vec3_t emins, vec3_t emaxs, struct mplane_s *p);
52 }
53 mplane_t;
54
55 typedef struct texture_s
56 {
57         char                            name[16];
58         unsigned                        width, height;
59         int                                     flags;                          // LordHavoc: SURF_ flags
60
61         rtexture_t                      *texture;
62         rtexture_t                      *glowtexture;
63         rtexture_t                      *fogtexture;            // alpha-only version of main texture
64
65         int                                     anim_total;                     // total frames in sequence (< 2 = not animated)
66         struct texture_s        *anim_frames[10];       // LordHavoc: direct pointers to each of the frames in the sequence
67         struct texture_s        *alternate_anims;       // bmodels in frame 1 use these
68 }
69 texture_t;
70
71
72 #define SURF_PLANEBACK          2
73 #define SURF_DRAWSKY            4
74 //#define SURF_DRAWSPRITE               8
75 #define SURF_DRAWTURB           0x10
76 #define SURF_LIGHTMAP           0x20
77 //#define SURF_DRAWBACKGROUND   0x40
78 //#define SURF_UNDERWATER               0x80
79 #define SURF_DRAWNOALPHA        0x100
80 #define SURF_DRAWFULLBRIGHT     0x200
81 #define SURF_LIGHTBOTHSIDES     0x400
82 #define SURF_CLIPSOLID          0x800 // this polygon can obscure other polygons
83
84 typedef struct
85 {
86         unsigned short  v[2];
87 }
88 medge_t;
89
90 typedef struct
91 {
92         float           vecs[2][4];
93         texture_t       *texture;
94         int                     flags;
95 }
96 mtexinfo_t;
97
98 typedef struct surfvertex_s
99 {
100         // position
101         float v[3];
102         // offset into lightmap (used by vertex lighting)
103         int lightmapoffset;
104         // texture coordinates
105         float st[2];
106         // lightmap coordinates
107         float uv[2];
108 }
109 surfvertex_t;
110
111 // LordHavoc: replaces glpoly, triangle mesh
112 typedef struct surfmesh_s
113 {
114         int numverts;
115         int numtriangles;
116         surfvertex_t *vertex;
117         int *index;
118 }
119 surfmesh_t;
120
121 typedef struct msurface_s
122 {
123         // should be drawn if visframe == r_framecount (set by WorldNode functions)
124         int                     visframe;
125
126         // the node plane this is on, backwards if SURF_PLANEBACK flag set
127         mplane_t        *plane;
128         // SURF_ flags
129         int                     flags;
130         struct Cshader_s        *shader;
131         struct msurface_s       *chain; // shader rendering chain
132
133         // look up in model->surfedges[], negative numbers are backwards edges
134         int                     firstedge;
135         int                     numedges;
136
137         short           texturemins[2];
138         short           extents[2];
139
140         mtexinfo_t      *texinfo;
141         texture_t       *currenttexture; // updated (animated) during early surface processing each frame
142
143         // index into d_lightstylevalue array, 255 means not used (black)
144         qbyte           styles[MAXLIGHTMAPS];
145         // RGB lighting data [numstyles][height][width][3]
146         qbyte           *samples;
147         // stain to apply on lightmap (soot/dirt/blood/whatever)
148         qbyte           *stainsamples;
149
150         // these fields are generated during model loading
151         // the lightmap texture fragment to use on the surface
152         rtexture_t *lightmaptexture;
153         // the stride when building lightmaps to comply with fragment update
154         int                     lightmaptexturestride;
155         // mesh for rendering
156         surfmesh_t      mesh;
157
158         // these are just 3D points defining the outline of the polygon,
159         // no texcoord info (that can be generated from these)
160         int                     poly_numverts;
161         float           *poly_verts;
162
163         // these are regenerated every frame
164         // lighting info
165         int                     dlightframe;
166         int                     dlightbits[8];
167         // avoid redundent addition of dlights
168         int                     lightframe;
169         // only render each surface once
170         int                     worldnodeframe;
171         // marked when surface is prepared for the frame
172         int                     insertframe;
173
174         // these cause lightmap updates if regenerated
175         // values currently used in lightmap
176         unsigned short cached_light[MAXLIGHTMAPS];
177         // if lightmap was lit by dynamic lights, force update on next frame
178         short           cached_dlight;
179         // to cause lightmap to be rerendered when v_overbrightbits changes
180         short           cached_lightscalebit;
181         // rerender lightmaps when r_ambient changes
182         float           cached_ambient;
183 }
184 msurface_t;
185
186 #define SHADERSTAGE_SKY 0
187 #define SHADERSTAGE_NORMAL 1
188 #define SHADERSTAGE_FOG 2
189 #define SHADERSTAGE_COUNT 3
190
191 // change this stuff when real shaders are added
192 typedef struct Cshader_s
193 {
194         int (*shaderfunc[SHADERSTAGE_COUNT])(int stage, msurface_t *s);
195         // list of surfaces using this shader (used during surface rendering)
196         msurface_t *chain;
197 }
198 Cshader_t;
199
200 extern Cshader_t Cshader_wall_vertex;
201 extern Cshader_t Cshader_wall_lightmap;
202 extern Cshader_t Cshader_wall_fullbright;
203 extern Cshader_t Cshader_water;
204 extern Cshader_t Cshader_sky;
205
206 // warning: if this is changed, references must be updated in cpu_* assembly files
207 typedef struct mnode_s
208 {
209 // common with leaf
210         int                                     contents;               // 0, to differentiate from leafs
211
212         struct mnode_s          *parent;
213         struct mportal_s        *portals;
214
215         // for bounding box culling
216         vec3_t                          mins;
217         vec3_t                          maxs;
218
219 // node specific
220         mplane_t                        *plane;
221         struct mnode_s          *children[2];
222
223         unsigned short          firstsurface;
224         unsigned short          numsurfaces;
225 }
226 mnode_t;
227
228 typedef struct mleaf_s
229 {
230 // common with node
231         int                                     contents;               // will be a negative contents number
232
233         struct mnode_s          *parent;
234         struct mportal_s        *portals;
235
236         // for bounding box culling
237         vec3_t                          mins;
238         vec3_t                          maxs;
239
240 // leaf specific
241         int                                     visframe;               // visible if current (r_framecount)
242         int                                     worldnodeframe; // used by certain worldnode variants to avoid processing the same leaf twice in a frame
243         int                                     portalmarkid;   // used by polygon-through-portals visibility checker
244
245         // LordHavoc: leaf based dynamic lighting
246         int                                     dlightbits[8];
247         int                                     dlightframe;
248
249         qbyte                           *compressed_vis;
250
251         msurface_t                      **firstmarksurface;
252         int                                     nummarksurfaces;
253         qbyte                           ambient_sound_level[NUM_AMBIENTS];
254 }
255 mleaf_t;
256
257 typedef struct
258 {
259         dclipnode_t     *clipnodes;
260         mplane_t        *planes;
261         int                     firstclipnode;
262         int                     lastclipnode;
263         vec3_t          clip_mins;
264         vec3_t          clip_maxs;
265 }
266 hull_t;
267
268 typedef struct mportal_s
269 {
270         struct mportal_s *next; // the next portal on this leaf
271         mleaf_t *here; // the leaf this portal is on
272         mleaf_t *past; // the leaf through this portal (infront)
273         mvertex_t *points;
274         int numpoints;
275         mplane_t plane;
276         int visframe; // is this portal visible this frame?
277 }
278 mportal_t;
279
280 extern rtexture_t *r_notexture;
281 extern texture_t r_notexture_mip;
282
283 struct model_s;
284 void Mod_LoadBrushModel (struct model_s *mod, void *buffer);
285 void Mod_BrushInit(void);
286 void Mod_FindNonSolidLocation(vec3_t pos, struct model_s *mod);