2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
21 #ifndef MODEL_SHARED_H
22 #define MODEL_SHARED_H
24 typedef enum synctype_e {ST_SYNC=0, ST_RAND } synctype_t;
28 d*_t structures are on-disk representations
29 m*_t structures are in-memory
33 typedef enum modtype_e {mod_invalid, mod_brushq1, mod_sprite, mod_alias, mod_brushq2, mod_brushq3, mod_obj, mod_null} modtype_t;
35 typedef struct animscene_s
37 char name[32]; // for viewthing support
40 int loop; // true or false
45 typedef struct skinframe_s
47 rtexture_t *stain; // inverse modulate with background (used for decals and such)
48 rtexture_t *merged; // original texture without glow
49 rtexture_t *base; // original texture without pants/shirt/glow
50 rtexture_t *pants; // pants only (in greyscale)
51 rtexture_t *shirt; // shirt only (in greyscale)
52 rtexture_t *nmap; // normalmap (bumpmap for dot3)
53 rtexture_t *gloss; // glossmap (for dot3)
54 rtexture_t *glow; // glow only (fullbrights)
55 rtexture_t *fog; // alpha of the base texture (if not opaque)
56 rtexture_t *reflect; // colored mask for cubemap reflections
57 // accounting data for hash searches:
58 // the compare variables are used to identify internal skins from certain
60 // (so that two q1bsp maps with the same texture name for different
61 // textures do not have any conflicts)
62 struct skinframe_s *next; // next on hash chain
63 char basename[MAX_QPATH]; // name of this
64 int textureflags; // texture flags to use
68 // mark and sweep garbage collection, this value is updated to a new value
69 // on each level change for the used skinframes, if some are not used they
72 // indicates whether this texture has transparent pixels
74 // average texture color, if applicable
76 // for mdl skins, we actually only upload on first use (many are never used, and they are almost never used in both base+pants+shirt and merged modes)
77 unsigned char *qpixels;
80 qboolean qhascolormapping;
81 qboolean qgeneratebase;
82 qboolean qgeneratemerged;
83 qboolean qgeneratenmap;
84 qboolean qgenerateglow;
85 // for q2 wal files we have some extra info
89 // we could also store the q2animname from the wal but we have no current need of it
95 typedef struct texvecvertex_s
102 typedef struct blendweights_s
104 unsigned char index[4];
105 unsigned char influence[4];
109 typedef struct r_vertexgeneric_s
118 typedef struct r_vertexmesh_s
123 float texcoordtexture2f[2];
124 float texcoordlightmap2f[2];
128 unsigned char skeletalindex4ub[4];
129 unsigned char skeletalweight4ub[4];
133 typedef struct r_meshbuffer_s
135 int bufferobject; // OpenGL
136 void *devicebuffer; // Direct3D
138 qboolean isindexbuffer;
139 qboolean isuniformbuffer;
142 char name[MAX_QPATH];
146 // used for mesh lists in q1bsp/q3bsp map models
147 // (the surfaces reference portions of these meshes)
148 typedef struct surfmesh_s
150 // triangle data in system memory
151 int num_triangles; // number of triangles in the mesh
152 int *data_element3i; // int[tris*3] triangles of the mesh, 3 indices into vertex arrays for each
153 r_meshbuffer_t *data_element3i_indexbuffer;
154 int data_element3i_bufferoffset;
155 unsigned short *data_element3s; // unsigned short[tris*3] triangles of the mesh in unsigned short format (NULL if num_vertices > 65536)
156 r_meshbuffer_t *data_element3s_indexbuffer;
157 int data_element3s_bufferoffset;
158 int *data_neighbor3i; // int[tris*3] neighboring triangle on each edge (-1 if none)
159 // vertex data in system memory
160 int num_vertices; // number of vertices in the mesh
161 float *data_vertex3f; // float[verts*3] vertex locations
162 float *data_svector3f; // float[verts*3] direction of 'S' (right) texture axis for each vertex
163 float *data_tvector3f; // float[verts*3] direction of 'T' (down) texture axis for each vertex
164 float *data_normal3f; // float[verts*3] direction of 'R' (out) texture axis for each vertex
165 float *data_texcoordtexture2f; // float[verts*2] texcoords for surface texture
166 float *data_texcoordlightmap2f; // float[verts*2] texcoords for lightmap texture
167 float *data_lightmapcolor4f;
168 unsigned char *data_skeletalindex4ub;
169 unsigned char *data_skeletalweight4ub;
170 int *data_lightmapoffsets; // index into surface's lightmap samples for vertex lighting
171 r_vertexmesh_t *data_vertexmesh; // interleaved arrays for D3D
172 // vertex buffer object (stores geometry in video memory)
173 r_meshbuffer_t *vbo_vertexbuffer;
174 int vbooffset_vertex3f;
175 int vbooffset_svector3f;
176 int vbooffset_tvector3f;
177 int vbooffset_normal3f;
178 int vbooffset_texcoordtexture2f;
179 int vbooffset_texcoordlightmap2f;
180 int vbooffset_lightmapcolor4f;
181 int vbooffset_skeletalindex4ub;
182 int vbooffset_skeletalweight4ub;
183 int vbooffset_vertexmesh;
184 // morph blending, these are zero if model is skeletal or static
186 struct md3vertex_s *data_morphmd3vertex;
187 struct trivertx_s *data_morphmdlvertex;
188 struct texvecvertex_s *data_morphtexvecvertex;
189 float *data_morphmd2framesize6f;
190 float num_morphmdlframescale[3];
191 float num_morphmdlframetranslate[3];
192 // skeletal blending, these are NULL if model is morph or static
193 struct blendweights_s *data_blendweights;
195 unsigned short *blends;
196 // set if there is some kind of animation on this model
199 // vertex and index buffers for rendering
200 r_meshbuffer_t *vertexmesh_vertexbuffer;
204 #define SHADOWMESHVERTEXHASH 1024
205 typedef struct shadowmeshvertexhash_s
207 struct shadowmeshvertexhash_s *next;
209 shadowmeshvertexhash_t;
211 typedef struct shadowmesh_s
213 // next mesh in chain
214 struct shadowmesh_s *next;
215 // used for light mesh (NULL on shadow mesh)
216 rtexture_t *map_diffuse;
217 rtexture_t *map_specular;
218 rtexture_t *map_normal;
220 int numverts, maxverts;
221 int numtriangles, maxtriangles;
224 // used for light mesh (NULL on shadow mesh)
231 r_meshbuffer_t *element3i_indexbuffer;
232 int element3i_bufferoffset;
233 unsigned short *element3s;
234 r_meshbuffer_t *element3s_indexbuffer;
235 int element3s_bufferoffset;
236 // vertex/index buffers for rendering
237 // (created by Mod_ShadowMesh_Finish if possible)
238 r_vertexmesh_t *vertexmesh; // usually NULL
239 // used for shadow mapping cubemap side partitioning
240 int sideoffsets[6], sidetotals[6];
241 // used for shadow mesh (NULL on light mesh)
243 // these are NULL after Mod_ShadowMesh_Finish is performed, only used
244 // while building meshes
245 shadowmeshvertexhash_t **vertexhashtable, *vertexhashentries;
246 r_meshbuffer_t *vbo_vertexbuffer;
247 int vbooffset_vertex3f;
248 int vbooffset_svector3f;
249 int vbooffset_tvector3f;
250 int vbooffset_normal3f;
251 int vbooffset_texcoord2f;
252 int vbooffset_vertexmesh;
256 // various flags from shaders, used for special effects not otherwise classified
257 // TODO: support these features more directly
258 #define Q3TEXTUREFLAG_TWOSIDED 1
259 #define Q3TEXTUREFLAG_NOPICMIP 16
260 #define Q3TEXTUREFLAG_POLYGONOFFSET 32
261 #define Q3TEXTUREFLAG_REFRACTION 256
262 #define Q3TEXTUREFLAG_REFLECTION 512
263 #define Q3TEXTUREFLAG_WATERSHADER 1024
264 #define Q3TEXTUREFLAG_CAMERA 2048
265 #define Q3TEXTUREFLAG_TRANSPARENTSORT 4096
267 #define Q3PATHLENGTH 64
268 #define TEXTURE_MAXFRAMES 64
269 #define Q3WAVEPARMS 4
270 #define Q3DEFORM_MAXPARMS 3
271 #define Q3SHADER_MAXLAYERS 2 // FIXME support more than that (currently only two are used, so why keep more in RAM?)
272 #define Q3RGBGEN_MAXPARMS 3
273 #define Q3ALPHAGEN_MAXPARMS 1
274 #define Q3TCGEN_MAXPARMS 6
275 #define Q3TCMOD_MAXPARMS 6
276 #define Q3MAXTCMODS 8
277 #define Q3MAXDEFORMS 4
279 typedef enum q3wavefunc_e
282 Q3WAVEFUNC_INVERSESAWTOOTH,
291 typedef int q3wavefunc_t;
292 #define Q3WAVEFUNC_USER_COUNT 4
293 #define Q3WAVEFUNC_USER_SHIFT 8 // use 8 bits for wave func type
295 typedef enum q3deform_e
298 Q3DEFORM_PROJECTIONSHADOW,
300 Q3DEFORM_AUTOSPRITE2,
317 typedef enum q3rgbgen_e
322 Q3RGBGEN_EXACTVERTEX,
323 Q3RGBGEN_IDENTITYLIGHTING,
324 Q3RGBGEN_LIGHTINGDIFFUSE,
325 Q3RGBGEN_ONEMINUSENTITY,
326 Q3RGBGEN_ONEMINUSVERTEX,
333 typedef enum q3alphagen_e
338 Q3ALPHAGEN_LIGHTINGSPECULAR,
339 Q3ALPHAGEN_ONEMINUSENTITY,
340 Q3ALPHAGEN_ONEMINUSVERTEX,
348 typedef enum q3tcgen_e
351 Q3TCGEN_TEXTURE, // very common
352 Q3TCGEN_ENVIRONMENT, // common
359 typedef enum q3tcmod_e
362 Q3TCMOD_ENTITYTRANSLATE,
374 typedef struct q3shaderinfo_layer_rgbgen_s
377 float parms[Q3RGBGEN_MAXPARMS];
378 q3wavefunc_t wavefunc;
379 float waveparms[Q3WAVEPARMS];
381 q3shaderinfo_layer_rgbgen_t;
383 typedef struct q3shaderinfo_layer_alphagen_s
385 q3alphagen_t alphagen;
386 float parms[Q3ALPHAGEN_MAXPARMS];
387 q3wavefunc_t wavefunc;
388 float waveparms[Q3WAVEPARMS];
390 q3shaderinfo_layer_alphagen_t;
392 typedef struct q3shaderinfo_layer_tcgen_s
395 float parms[Q3TCGEN_MAXPARMS];
397 q3shaderinfo_layer_tcgen_t;
399 typedef struct q3shaderinfo_layer_tcmod_s
402 float parms[Q3TCMOD_MAXPARMS];
403 q3wavefunc_t wavefunc;
404 float waveparms[Q3WAVEPARMS];
406 q3shaderinfo_layer_tcmod_t;
408 typedef struct q3shaderinfo_layer_s
417 q3shaderinfo_layer_rgbgen_t rgbgen;
418 q3shaderinfo_layer_alphagen_t alphagen;
419 q3shaderinfo_layer_tcgen_t tcgen;
420 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
422 q3shaderinfo_layer_t;
424 typedef struct q3shaderinfo_deform_s
427 float parms[Q3DEFORM_MAXPARMS];
428 q3wavefunc_t wavefunc;
429 float waveparms[Q3WAVEPARMS];
431 q3shaderinfo_deform_t;
433 typedef enum dpoffsetmapping_technique_s
435 OFFSETMAPPING_OFF, // none
436 OFFSETMAPPING_DEFAULT, // cvar-set
437 OFFSETMAPPING_LINEAR, // linear
438 OFFSETMAPPING_RELIEF // relief
439 }dpoffsetmapping_technique_t;
441 typedef enum dptransparentsort_category_e
444 TRANSPARENTSORT_DISTANCE,
446 }dptransparentsortcategory_t;
448 typedef struct q3shaderinfo_s
450 char name[Q3PATHLENGTH];
451 #define Q3SHADERINFO_COMPARE_START surfaceparms
457 qboolean vertexalpha;
458 qboolean textureblendalpha;
459 int primarylayer, backgroundlayer;
460 q3shaderinfo_layer_t layers[Q3SHADER_MAXLAYERS];
461 char skyboxname[Q3PATHLENGTH];
462 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
464 // dp-specific additions:
467 qboolean dpnortlight;
471 // add collisions to all triangles of the surface
472 qboolean dpmeshcollisions;
474 // kill shader based on cvar checks
475 qboolean dpshaderkill;
478 char dpreflectcube[Q3PATHLENGTH];
481 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
482 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
483 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
484 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
485 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
486 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
487 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
488 float r_water_waterscroll[2]; // water normalmapscrollblend - scale and speed
491 dpoffsetmapping_technique_t offsetmapping;
493 float offsetbias; // 0 is normal, 1 leads to alpha 0 being neutral and alpha 1 pushing "out"
495 // polygonoffset (only used if Q3TEXTUREFLAG_POLYGONOFFSET)
496 float biaspolygonoffset, biaspolygonfactor;
498 // transparent sort category
499 dptransparentsortcategory_t transparentsort;
502 float specularscalemod;
503 float specularpowermod;
505 // rtlighting ambient addition
506 float rtlightambient;
507 #define Q3SHADERINFO_COMPARE_END rtlightambient
511 typedef enum texturelayertype_e
513 TEXTURELAYERTYPE_INVALID,
514 TEXTURELAYERTYPE_LITTEXTURE,
515 TEXTURELAYERTYPE_TEXTURE,
520 typedef struct texturelayer_s
522 texturelayertype_t type;
527 matrix4x4_t texmatrix;
532 typedef struct texture_s
538 unsigned int width, height;
540 //unsigned int flags;
542 // base material flags
543 int basematerialflags;
544 // current material flags (updated each bmodel render)
545 int currentmaterialflags;
546 // base material alpha (used for Q2 materials)
549 // PolygonOffset values for rendering this material
550 // (these are added to the r_refdef values and submodel values)
551 float biaspolygonfactor;
552 float biaspolygonoffset;
554 // textures to use when rendering this material
555 skinframe_t *currentskinframe;
558 skinframe_t *skinframes[TEXTURE_MAXFRAMES];
559 // background layer (for terrain texture blending)
560 skinframe_t *backgroundcurrentskinframe;
561 int backgroundnumskinframes;
562 float backgroundskinframerate;
563 skinframe_t *backgroundskinframes[TEXTURE_MAXFRAMES];
565 // total frames in sequence and alternate sequence
567 // direct pointers to each of the frames in the sequences
568 // (indexed as [alternate][frame])
569 struct texture_s *anim_frames[2][10];
570 // 1 = q1bsp animation with anim_total[0] >= 2 (animated) or anim_total[1] >= 1 (alternate frame set)
571 // 2 = q2bsp animation with anim_total[0] >= 2 (uses self.frame)
574 // renderer checks if this texture needs updating...
575 int update_lastrenderframe;
576 void *update_lastrenderentity;
577 // the current alpha of this texture (may be affected by r_wateralpha, also basealpha, and ent->alpha)
579 // the current texture frame in animation
580 struct texture_s *currentframe;
581 // current texture transform matrix (used for water scrolling)
582 matrix4x4_t currenttexmatrix;
583 matrix4x4_t currentbackgroundtexmatrix;
585 // various q3 shader features
586 q3shaderinfo_layer_rgbgen_t rgbgen;
587 q3shaderinfo_layer_alphagen_t alphagen;
588 q3shaderinfo_layer_tcgen_t tcgen;
589 q3shaderinfo_layer_tcmod_t tcmods[Q3MAXTCMODS];
590 q3shaderinfo_layer_tcmod_t backgroundtcmods[Q3MAXTCMODS];
591 q3shaderinfo_deform_t deforms[Q3MAXDEFORMS];
593 qboolean colormapping;
594 rtexture_t *basetexture; // original texture without pants/shirt/glow
595 rtexture_t *pantstexture; // pants only (in greyscale)
596 rtexture_t *shirttexture; // shirt only (in greyscale)
597 rtexture_t *nmaptexture; // normalmap (bumpmap for dot3)
598 rtexture_t *glosstexture; // glossmap (for dot3)
599 rtexture_t *glowtexture; // glow only (fullbrights)
600 rtexture_t *fogtexture; // alpha of the base texture (if not opaque)
601 rtexture_t *reflectmasktexture; // mask for fake reflections
602 rtexture_t *reflectcubetexture; // fake reflections cubemap
603 rtexture_t *backgroundbasetexture; // original texture without pants/shirt/glow
604 rtexture_t *backgroundnmaptexture; // normalmap (bumpmap for dot3)
605 rtexture_t *backgroundglosstexture; // glossmap (for dot3)
606 rtexture_t *backgroundglowtexture; // glow only (fullbrights)
609 // color tint (colormod * currentalpha) used for rtlighting this material
610 float dlightcolor[3];
611 // color tint (colormod * 2) used for lightmapped lighting on this material
612 // includes alpha as 4th component
613 // replaces role of gl_Color in GLSL shader
614 float lightmapcolor[4];
617 int customblendfunc[2];
619 int currentnumlayers;
620 texturelayer_t currentlayers[16];
629 // we have to load the texture multiple times when Q2SURF_ flags differ,
630 // though it still shares the skinframe
636 float reflectmin; // when refraction is used, minimum amount of reflection (when looking straight down)
637 float reflectmax; // when refraction is used, maximum amount of reflection (when looking parallel to water)
638 float refractfactor; // amount of refraction distort (1.0 = like the cvar specifies)
639 vec4_t refractcolor4f; // color tint of refraction (including alpha factor)
640 float reflectfactor; // amount of reflection distort (1.0 = like the cvar specifies)
641 vec4_t reflectcolor4f; // color tint of reflection (including alpha factor)
642 float r_water_wateralpha; // additional wateralpha to apply when r_water is active
643 float r_water_waterscroll[2]; // scale and speed
644 int camera_entity; // entity number for use by cameras
647 dpoffsetmapping_technique_t offsetmapping;
651 // transparent sort category
652 dptransparentsortcategory_t transparentsort;
655 float specularscalemod;
656 float specularpowermod;
658 // diffuse and ambient
659 float rtlightambient;
663 typedef struct mtexinfo_s
665 float vecs[2][4]; // [s/t][xyz offset]
668 int q2flags; // miptex flags + overrides
669 int q2value; // light emission, etc
670 char q2texture[32]; // texture name (textures/*.wal)
671 int q2nexttexinfo; // for animations, -1 = end of chain
675 typedef struct msurface_lightmapinfo_s
677 // texture mapping properties used by this surface
678 mtexinfo_t *texinfo; // q1bsp
679 // index into r_refdef.scene.lightstylevalue array, 255 means not used (black)
680 unsigned char styles[MAXLIGHTMAPS]; // q1bsp
681 // RGB lighting data [numstyles][height][width][3]
682 unsigned char *samples; // q1bsp
683 // RGB normalmap data [numstyles][height][width][3]
684 unsigned char *nmapsamples; // q1bsp
685 // stain to apply on lightmap (soot/dirt/blood/whatever)
686 unsigned char *stainsamples; // q1bsp
687 int texturemins[2]; // q1bsp
688 int extents[2]; // q1bsp
689 int lightmaporigin[2]; // q1bsp
691 msurface_lightmapinfo_t;
694 typedef struct msurface_s
696 // bounding box for onscreen checks
699 // the texture to use on the surface
701 // the lightmap texture fragment to use on the rendering mesh
702 rtexture_t *lightmaptexture;
703 // the lighting direction texture fragment to use on the rendering mesh
704 rtexture_t *deluxemaptexture;
705 // lightmaptexture rebuild information not used in q3bsp
706 msurface_lightmapinfo_t *lightmapinfo; // q1bsp
707 // fog volume info in q3bsp
708 struct q3deffect_s *effect; // q3bsp
709 // mesh information for collisions (only used by q3bsp curves)
710 int num_firstcollisiontriangle;
711 int *deprecatedq3data_collisionelement3i; // q3bsp
712 float *deprecatedq3data_collisionvertex3f; // q3bsp
713 float *deprecatedq3data_collisionbbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
714 float *deprecatedq3data_bbox6f; // collision optimization - contains combined bboxes of every data_collisionstride triangles
716 // surfaces own ranges of vertices and triangles in the model->surfmesh
717 int num_triangles; // number of triangles
718 int num_firsttriangle; // first triangle
719 int num_vertices; // number of vertices
720 int num_firstvertex; // first vertex
722 // shadow volume building information
723 int num_firstshadowmeshtriangle; // index into model->brush.shadowmesh
725 // mesh information for collisions (only used by q3bsp curves)
726 int num_collisiontriangles; // q3bsp
727 int num_collisionvertices; // q3bsp
728 int deprecatedq3num_collisionbboxstride;
729 int deprecatedq3num_bboxstride;
730 // FIXME: collisionmarkframe should be kept in a separate array
731 int deprecatedq3collisionmarkframe; // q3bsp // don't collide twice in one trace
735 #include "matrixlib.h"
738 #include "model_brush.h"
739 #include "model_sprite.h"
740 #include "model_alias.h"
742 typedef struct model_sprite_s
745 mspriteframe_t *sprdata_frames;
751 typedef struct model_brush_lightstyleinfo_s
758 model_brush_lightstyleinfo_t;
760 typedef struct model_brush_s
762 // true if this model is a HalfLife .bsp file
764 // true if this model is a BSP2rmqe .bsp file (expanded 32bit bsp format for rmqe)
766 // true if this model is a BSP2 .bsp file (expanded 32bit bsp format for DarkPlaces, others?)
768 // true if this model is a Quake2 .bsp file (IBSP46)
770 // string of entity definitions (.map format)
773 // if not NULL this is a submodel
774 struct model_s *parentmodel;
775 // (this is the number of the submodel, an index into submodels)
778 // number of submodels in this map (just used by server to know how many
779 // submodels to load)
781 // pointers to each of the submodels
782 struct model_s **submodels;
785 mplane_t *data_planes;
790 // visible leafs, not counting 0 (solid)
792 // number of actual leafs (including 0 which is solid)
797 int *data_leafbrushes;
799 int num_leafsurfaces;
800 int *data_leafsurfaces;
803 mportal_t *data_portals;
805 int num_portalpoints;
806 mvertex_t *data_portalpoints;
809 q3mbrush_t *data_brushes;
812 q3mbrushside_t *data_brushsides;
816 int num_pvsclusterbytes;
817 unsigned char *data_pvsclusters;
819 //pvschain = model->brush.data_pvsclusters + mycluster * model->brush.num_pvsclusterbytes;
820 //if (pvschain[thatcluster >> 3] & (1 << (thatcluster & 7)))
822 // collision geometry for q3 curves
823 int num_collisionvertices;
824 int num_collisiontriangles;
825 float *data_collisionvertex3f;
826 int *data_collisionelement3i;
828 // a mesh containing all shadow casting geometry for the whole model (including submodels), portions of this are referenced by each surface's num_firstshadowmeshtriangle
829 shadowmesh_t *shadowmesh;
831 // a mesh containing all SUPERCONTENTS_SOLID surfaces for this model or submodel, for physics engines to use
832 shadowmesh_t *collisionmesh;
835 int (*SuperContentsFromNativeContents)(struct model_s *model, int nativecontents);
836 int (*NativeContentsFromSuperContents)(struct model_s *model, int supercontents);
837 unsigned char *(*GetPVS)(struct model_s *model, const vec3_t p);
838 int (*FatPVS)(struct model_s *model, const vec3_t org, vec_t radius, unsigned char *pvsbuffer, int pvsbufferlength, qboolean merge);
839 int (*BoxTouchingPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
840 int (*BoxTouchingLeafPVS)(struct model_s *model, const unsigned char *pvs, const vec3_t mins, const vec3_t maxs);
841 int (*BoxTouchingVisibleLeafs)(struct model_s *model, const unsigned char *visibleleafs, const vec3_t mins, const vec3_t maxs);
842 int (*FindBoxClusters)(struct model_s *model, const vec3_t mins, const vec3_t maxs, int maxclusters, int *clusterlist);
843 void (*LightPoint)(struct model_s *model, const vec3_t p, vec3_t ambientcolor, vec3_t diffusecolor, vec3_t diffusenormal);
844 void (*FindNonSolidLocation)(struct model_s *model, const vec3_t in, vec3_t out, vec_t radius);
845 mleaf_t *(*PointInLeaf)(struct model_s *model, const vec3_t p);
846 // these are actually only found on brushq1, but NULL is handled gracefully
847 void (*AmbientSoundLevelsForPoint)(struct model_s *model, const vec3_t p, unsigned char *out, int outsize);
848 void (*RoundUpToHullSize)(struct model_s *cmodel, const vec3_t inmins, const vec3_t inmaxs, vec3_t outmins, vec3_t outmaxs);
849 // trace a line of sight through this model (returns false if the line if sight is definitely blocked)
850 qboolean (*TraceLineOfSight)(struct model_s *model, const vec3_t start, const vec3_t end);
852 char skybox[MAX_QPATH];
854 skinframe_t *solidskyskinframe;
855 skinframe_t *alphaskyskinframe;
857 qboolean supportwateralpha;
865 typedef struct model_brushq1_s
882 mclipnode_t *clipnodes;
884 hull_t hulls[MAX_MAP_HULLS];
886 int num_compressedpvs;
887 unsigned char *data_compressedpvs;
890 unsigned char *lightdata;
891 unsigned char *nmaplightdata; // deluxemap file
893 // lightmap update chains for light styles
895 model_brush_lightstyleinfo_t *data_lightstyleinfo;
897 // this contains bytes that are 1 if a surface needs its lightmap rebuilt
898 unsigned char *lightmapupdateflags;
899 qboolean firstrender; // causes all surface lightmaps to be loaded in first frame
903 typedef struct model_brushq2_s
905 int dummy; // MSVC can't handle an empty struct
909 typedef struct model_brushq3_s
912 q3dmodel_t *data_models;
914 // used only during loading - freed after loading!
916 float *data_vertex3f;
917 float *data_normal3f;
918 float *data_texcoordtexture2f;
919 float *data_texcoordlightmap2f;
922 // freed after loading!
927 q3deffect_t *data_effects;
930 int num_originallightmaps;
931 int num_mergedlightmaps;
932 int num_lightmapmergedwidthpower;
933 int num_lightmapmergedheightpower;
934 int num_lightmapmergedwidthheightdeluxepower;
935 int num_lightmapmerge;
936 rtexture_t **data_lightmaps;
937 rtexture_t **data_deluxemaps;
939 // voxel light data with directional shading
941 q3dlightgrid_t *data_lightgrid;
942 // size of each cell (may vary by map, typically 64 64 128)
943 float num_lightgrid_cellsize[3];
944 // 1.0 / num_lightgrid_cellsize
945 float num_lightgrid_scale[3];
946 // dimensions of the world model in lightgrid cells
947 int num_lightgrid_imins[3];
948 int num_lightgrid_imaxs[3];
949 int num_lightgrid_isize[3];
950 // transform modelspace coordinates to lightgrid index
951 matrix4x4_t num_lightgrid_indexfromworld;
953 // true if this q3bsp file has been detected as using deluxemapping
954 // (lightmap texture pairs, every odd one is never directly refernced,
955 // and contains lighting normals, not colors)
956 qboolean deluxemapping;
957 // true if the detected deluxemaps are the modelspace kind, rather than
958 // the faster tangentspace kind
959 qboolean deluxemapping_modelspace;
960 // size of lightmaps (128 by default, but may be another poweroftwo if
961 // external lightmaps are used (q3map2 -lightmapsize)
969 typedef struct model_s
971 // name and path of model, for example "progs/player.mdl"
972 char name[MAX_QPATH];
973 // model needs to be loaded if this is false
975 // set if the model is used in current map, models which are not, are purged
977 // CRC of the file this model was loaded from, to reload if changed
979 // mod_brush, mod_alias, mod_sprite
981 // memory pool for allocations
983 // all models use textures...
984 rtexturepool_t *texturepool;
985 // EF_* flags (translated from the model file's different flags layout)
987 // number of QC accessible frame(group)s in the model
989 // number of QC accessible skin(group)s in the model
991 // whether to randomize animated framegroups
993 // bounding box at angles '0 0 0'
994 vec3_t normalmins, normalmaxs;
995 // bounding box if yaw angle is not 0, but pitch and roll are
996 vec3_t yawmins, yawmaxs;
997 // bounding box if pitch or roll are used
998 vec3_t rotatedmins, rotatedmaxs;
999 // sphere radius, usable at any angles
1001 // squared sphere radius for easier comparisons
1003 // skin animation info
1004 animscene_t *skinscenes; // [numskins]
1005 // skin animation info
1006 animscene_t *animscenes; // [numframes]
1007 // range of surface numbers in this (sub)model
1008 int firstmodelsurface;
1009 int nummodelsurfaces;
1010 int *sortedmodelsurfaces;
1011 // range of collision brush numbers in this (sub)model
1012 int firstmodelbrush;
1013 int nummodelbrushes;
1014 // BIH (Bounding Interval Hierarchy) for this (sub)model
1015 bih_t collision_bih;
1016 bih_t render_bih; // if not set, use collision_bih instead for rendering purposes too
1020 aliastag_t *data_tags;
1021 // for skeletal models
1023 aliasbone_t *data_bones;
1024 float num_posescale; // scaling factor from origin in poses7s format (includes divide by 32767)
1025 float num_poseinvscale; // scaling factor to origin in poses7s format (includes multiply by 32767)
1027 short *data_poses7s; // origin xyz, quat xyzw, unit length, values normalized to +/-32767 range
1028 float *data_baseboneposeinverse;
1029 // textures of this model
1031 int num_texturesperskin;
1032 texture_t *data_textures;
1033 qboolean wantnormals;
1034 qboolean wanttangents;
1035 // surfaces of this model
1037 msurface_t *data_surfaces;
1038 // optional lightmapinfo data for surface lightmap updates
1039 msurface_lightmapinfo_t *data_surfaces_lightmapinfo;
1040 // all surfaces belong to this mesh
1041 surfmesh_t surfmesh;
1042 // data type of model
1043 const char *modeldatatypestring;
1044 // generates vertex data for a given frameblend
1045 void(*AnimateVertices)(const struct model_s * RESTRICT model, const struct frameblend_s * RESTRICT frameblend, const struct skeleton_s *skeleton, float * RESTRICT vertex3f, float * RESTRICT normal3f, float * RESTRICT svector3f, float * RESTRICT tvector3f);
1046 // draw the model's sky polygons (only used by brush models)
1047 void(*DrawSky)(struct entity_render_s *ent);
1048 // draw refraction/reflection textures for the model's water polygons (only used by brush models)
1049 void(*DrawAddWaterPlanes)(struct entity_render_s *ent);
1050 // draw the model using lightmap/dlight shading
1051 void(*Draw)(struct entity_render_s *ent);
1052 // draw the model to the depth buffer (no color rendering at all)
1053 void(*DrawDepth)(struct entity_render_s *ent);
1054 // draw any enabled debugging effects on this model (such as showing triangles, normals, collision brushes...)
1055 void(*DrawDebug)(struct entity_render_s *ent);
1056 // draw geometry textures for deferred rendering
1057 void(*DrawPrepass)(struct entity_render_s *ent);
1058 // compile an optimized shadowmap mesh for the model based on light source
1059 void(*CompileShadowMap)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1060 // draw depth into a shadowmap
1061 void(*DrawShadowMap)(int side, struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const unsigned char *surfacesides, const vec3_t lightmins, const vec3_t lightmaxs);
1062 // gathers info on which clusters and surfaces are lit by light, as well as calculating a bounding box
1063 void(*GetLightInfo)(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, vec3_t outmins, vec3_t outmaxs, int *outleaflist, unsigned char *outleafpvs, int *outnumleafspointer, int *outsurfacelist, unsigned char *outsurfacepvs, int *outnumsurfacespointer, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs, unsigned char *visitingleafpvs, int numfrustumplanes, const mplane_t *frustumplanes);
1064 // compile a shadow volume for the model based on light source
1065 void(*CompileShadowVolume)(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1066 // draw a shadow volume for the model based on light source
1067 void(*DrawShadowVolume)(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
1068 // draw the lighting on a model (through stencil)
1069 void(*DrawLight)(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1070 // trace a box against this model
1071 void (*TraceBox)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t boxmins, const vec3_t boxmaxs, const vec3_t end, int hitsupercontentsmask);
1072 void (*TraceBrush)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, struct colbrushf_s *start, struct colbrushf_s *end, int hitsupercontentsmask);
1073 // trace a box against this model
1074 void (*TraceLine)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1075 // trace a point against this model (like PointSuperContents)
1076 void (*TracePoint)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1077 // find the supercontents value at a point in this model
1078 int (*PointSuperContents)(struct model_s *model, int frame, const vec3_t point);
1079 // trace a line against geometry in this model and report correct texture (used by r_shadow_bouncegrid)
1080 void (*TraceLineAgainstSurfaces)(struct model_s *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1081 // fields belonging to some types of model
1082 model_sprite_t sprite;
1083 model_brush_t brush;
1084 model_brushq1_t brushq1;
1085 model_brushq2_t brushq2;
1086 model_brushq3_t brushq3;
1087 // flags this model for offseting sounds to the model center (used by brush models)
1088 int soundfromcenter;
1090 // if set, the model contains light information (lightmap, or vertexlight)
1092 float lightmapscale;
1096 //============================================================================
1099 extern dp_model_t *loadmodel;
1100 extern unsigned char *mod_base;
1101 // sky/water subdivision
1102 //extern cvar_t gl_subdivide_size;
1103 // texture fullbrights
1104 extern cvar_t r_fullbrights;
1105 extern cvar_t r_enableshadowvolumes;
1107 void Mod_Init (void);
1108 void Mod_Reload (void);
1109 dp_model_t *Mod_LoadModel(dp_model_t *mod, qboolean crash, qboolean checkdisk);
1110 dp_model_t *Mod_FindName (const char *name, const char *parentname);
1111 dp_model_t *Mod_ForName (const char *name, qboolean crash, qboolean checkdisk, const char *parentname);
1112 void Mod_UnloadModel (dp_model_t *mod);
1114 void Mod_ClearUsed(void);
1115 void Mod_PurgeUnused(void);
1116 void Mod_RemoveStaleWorldModels(dp_model_t *skip); // only used during loading!
1118 extern dp_model_t *loadmodel;
1119 extern char loadname[32]; // for hunk tags
1121 int Mod_BuildVertexRemapTableFromElements(int numelements, const int *elements, int numvertices, int *remapvertices);
1122 void Mod_BuildTriangleNeighbors(int *neighbors, const int *elements, int numtriangles);
1123 void Mod_ValidateElements(int *elements, int numtriangles, int firstvertex, int numverts, const char *filename, int fileline);
1124 void Mod_BuildNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const int *elements, float *normal3f, qboolean areaweighting);
1125 void Mod_BuildTextureVectorsFromNormals(int firstvertex, int numvertices, int numtriangles, const float *vertex3f, const float *texcoord2f, const float *normal3f, const int *elements, float *svector3f, float *tvector3f, qboolean areaweighting);
1127 void Mod_AllocSurfMesh(mempool_t *mempool, int numvertices, int numtriangles, qboolean lightmapoffsets, qboolean vertexcolors, qboolean neighbors);
1128 void Mod_MakeSortedSurfaces(dp_model_t *mod);
1130 // called specially by brush model loaders before generating submodels
1131 // automatically called after model loader returns
1132 void Mod_BuildVBOs(void);
1134 shadowmesh_t *Mod_ShadowMesh_Alloc(mempool_t *mempool, int maxverts, int maxtriangles, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, int light, int neighbors, int expandable);
1135 shadowmesh_t *Mod_ShadowMesh_ReAlloc(mempool_t *mempool, shadowmesh_t *oldmesh, int light, int neighbors);
1136 int Mod_ShadowMesh_AddVertex(shadowmesh_t *mesh, float *vertex14f);
1137 void Mod_ShadowMesh_AddTriangle(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, float *vertex14f);
1138 void Mod_ShadowMesh_AddMesh(mempool_t *mempool, shadowmesh_t *mesh, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, const float *vertex3f, const float *svector3f, const float *tvector3f, const float *normal3f, const float *texcoord2f, int numtris, const int *element3i);
1139 shadowmesh_t *Mod_ShadowMesh_Begin(mempool_t *mempool, int maxverts, int maxtriangles, rtexture_t *map_diffuse, rtexture_t *map_specular, rtexture_t *map_normal, int light, int neighbors, int expandable);
1140 shadowmesh_t *Mod_ShadowMesh_Finish(mempool_t *mempool, shadowmesh_t *firstmesh, qboolean light, qboolean neighbors, qboolean createvbo);
1141 void Mod_ShadowMesh_CalcBBox(shadowmesh_t *firstmesh, vec3_t mins, vec3_t maxs, vec3_t center, float *radius);
1142 void Mod_ShadowMesh_Free(shadowmesh_t *mesh);
1144 void Mod_CreateCollisionMesh(dp_model_t *mod);
1146 void Mod_FreeQ3Shaders(void);
1147 void Mod_LoadQ3Shaders(void);
1148 q3shaderinfo_t *Mod_LookupQ3Shader(const char *name);
1149 qboolean Mod_LoadTextureFromQ3Shader(texture_t *texture, const char *name, qboolean warnmissing, qboolean fallback, int defaulttexflags);
1151 extern cvar_t r_mipskins;
1152 extern cvar_t r_mipnormalmaps;
1154 typedef struct skinfileitem_s
1156 struct skinfileitem_s *next;
1157 char name[MAX_QPATH];
1158 char replacement[MAX_QPATH];
1162 typedef struct skinfile_s
1164 struct skinfile_s *next;
1165 skinfileitem_t *items;
1169 skinfile_t *Mod_LoadSkinFiles(void);
1170 void Mod_FreeSkinFiles(skinfile_t *skinfile);
1171 int Mod_CountSkinFiles(skinfile_t *skinfile);
1172 void Mod_BuildAliasSkinsFromSkinFiles(texture_t *skin, skinfile_t *skinfile, const char *meshname, const char *shadername);
1174 void Mod_SnapVertices(int numcomponents, int numvertices, float *vertices, float snap);
1175 int Mod_RemoveDegenerateTriangles(int numtriangles, const int *inelement3i, int *outelement3i, const float *vertex3f);
1176 void Mod_VertexRangeFromElements(int numelements, const int *elements, int *firstvertexpointer, int *lastvertexpointer);
1178 typedef struct mod_alloclightmap_row_s
1183 mod_alloclightmap_row_t;
1185 typedef struct mod_alloclightmap_state_s
1190 mod_alloclightmap_row_t *rows;
1192 mod_alloclightmap_state_t;
1194 void Mod_AllocLightmap_Init(mod_alloclightmap_state_t *state, int width, int height);
1195 void Mod_AllocLightmap_Free(mod_alloclightmap_state_t *state);
1196 void Mod_AllocLightmap_Reset(mod_alloclightmap_state_t *state);
1197 qboolean Mod_AllocLightmap_Block(mod_alloclightmap_state_t *state, int blockwidth, int blockheight, int *outx, int *outy);
1200 void Mod_BrushInit(void);
1201 // used for talking to the QuakeC mainly
1202 int Mod_Q1BSP_NativeContentsFromSuperContents(struct model_s *model, int supercontents);
1203 int Mod_Q1BSP_SuperContentsFromNativeContents(struct model_s *model, int nativecontents);
1204 // used for loading wal files in Mod_LoadTextureFromQ3Shader
1205 int Mod_Q2BSP_SuperContentsFromNativeContents(dp_model_t *model, int nativecontents);
1206 int Mod_Q2BSP_NativeContentsFromSuperContents(dp_model_t *model, int supercontents);
1208 // a lot of model formats use the Q1BSP code, so here are the prototypes...
1209 struct entity_render_s;
1210 void R_Q1BSP_DrawAddWaterPlanes(struct entity_render_s *ent);
1211 void R_Q1BSP_DrawSky(struct entity_render_s *ent);
1212 void R_Q1BSP_Draw(struct entity_render_s *ent);
1213 void R_Q1BSP_DrawDepth(struct entity_render_s *ent);
1214 void R_Q1BSP_DrawDebug(struct entity_render_s *ent);
1215 void R_Q1BSP_DrawPrepass(struct entity_render_s *ent);
1216 void R_Q1BSP_GetLightInfo(struct entity_render_s *ent, vec3_t relativelightorigin, float lightradius, vec3_t outmins, vec3_t outmaxs, int *outleaflist, unsigned char *outleafpvs, int *outnumleafspointer, int *outsurfacelist, unsigned char *outsurfacepvs, int *outnumsurfacespointer, unsigned char *outshadowtrispvs, unsigned char *outlighttrispvs, unsigned char *visitingleafpvs, int numfrustumplanes, const mplane_t *frustumplanes);
1217 void R_Q1BSP_CompileShadowMap(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1218 void R_Q1BSP_DrawShadowMap(int side, struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int modelnumsurfaces, const int *modelsurfacelist, const unsigned char *surfacesides, const vec3_t lightmins, const vec3_t lightmaxs);
1219 void R_Q1BSP_CompileShadowVolume(struct entity_render_s *ent, vec3_t relativelightorigin, vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist);
1220 void R_Q1BSP_DrawShadowVolume(struct entity_render_s *ent, const vec3_t relativelightorigin, const vec3_t relativelightdirection, float lightradius, int numsurfaces, const int *surfacelist, const vec3_t lightmins, const vec3_t lightmaxs);
1221 void R_Q1BSP_DrawLight(struct entity_render_s *ent, int numsurfaces, const int *surfacelist, const unsigned char *trispvs);
1223 // Collision optimization using Bounding Interval Hierarchy
1224 void Mod_CollisionBIH_TracePoint(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1225 void Mod_CollisionBIH_TraceLine(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t end, int hitsupercontentsmask);
1226 void Mod_CollisionBIH_TraceBox(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, const vec3_t boxmins, const vec3_t boxmaxs, const vec3_t end, int hitsupercontentsmask);
1227 void Mod_CollisionBIH_TraceBrush(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, struct colbrushf_s *start, struct colbrushf_s *end, int hitsupercontentsmask);
1228 void Mod_CollisionBIH_TracePoint_Mesh(dp_model_t *model, const struct frameblend_s *frameblend, const skeleton_t *skeleton, struct trace_s *trace, const vec3_t start, int hitsupercontentsmask);
1229 qboolean Mod_CollisionBIH_TraceLineOfSight(struct model_s *model, const vec3_t start, const vec3_t end);
1230 int Mod_CollisionBIH_PointSuperContents(struct model_s *model, int frame, const vec3_t point);
1231 int Mod_CollisionBIH_PointSuperContents_Mesh(struct model_s *model, int frame, const vec3_t point);
1232 bih_t *Mod_MakeCollisionBIH(dp_model_t *model, qboolean userendersurfaces, bih_t *out);
1235 struct frameblend_s;
1237 void Mod_AliasInit(void);
1238 int Mod_Alias_GetTagMatrix(const dp_model_t *model, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, matrix4x4_t *outmatrix);
1239 int Mod_Alias_GetTagIndexForName(const dp_model_t *model, unsigned int skin, const char *tagname);
1240 int Mod_Alias_GetExtendedTagInfoForIndex(const dp_model_t *model, unsigned int skin, const struct frameblend_s *frameblend, const struct skeleton_s *skeleton, int tagindex, int *parentindex, const char **tagname, matrix4x4_t *tag_localmatrix);
1242 void Mod_Skeletal_FreeBuffers(void);
1245 void Mod_SpriteInit(void);
1248 void Mod_Q1BSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1249 void Mod_IBSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1250 void Mod_MAP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1251 void Mod_OBJ_Load(dp_model_t *mod, void *buffer, void *bufferend);
1252 void Mod_IDP0_Load(dp_model_t *mod, void *buffer, void *bufferend);
1253 void Mod_IDP2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1254 void Mod_IDP3_Load(dp_model_t *mod, void *buffer, void *bufferend);
1255 void Mod_ZYMOTICMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1256 void Mod_DARKPLACESMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1257 void Mod_PSKMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1258 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend);
1259 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend);
1260 void Mod_INTERQUAKEMODEL_Load(dp_model_t *mod, void *buffer, void *bufferend);
1262 #endif // MODEL_SHARED_H