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.
20 // models.c -- model loading and caching
22 // models are the only shared resource between a client and server running
23 // on the same machine.
28 cvar_t r_mipsprites = {CF_CLIENT | CF_ARCHIVE, "r_mipsprites", "1", "mipmaps sprites so they render faster in the distance and do not display noise artifacts"};
29 cvar_t r_labelsprites_scale = {CF_CLIENT | CF_ARCHIVE, "r_labelsprites_scale", "1", "global scale to apply to label sprites before conversion to HUD coordinates"};
30 cvar_t r_labelsprites_roundtopixels = {CF_CLIENT | CF_ARCHIVE, "r_labelsprites_roundtopixels", "1", "try to make label sprites sharper by rounding their size to 0.5x or 1x and by rounding their position to whole pixels if possible"};
31 cvar_t r_overheadsprites_perspective = {CF_CLIENT | CF_ARCHIVE, "r_overheadsprites_perspective", "5", "fake perspective effect for SPR_OVERHEAD sprites"};
32 cvar_t r_overheadsprites_pushback = {CF_CLIENT | CF_ARCHIVE, "r_overheadsprites_pushback", "15", "how far to pull the SPR_OVERHEAD sprites toward the eye (used to avoid intersections with 3D models)"};
33 cvar_t r_overheadsprites_scalex = {CF_CLIENT | CF_ARCHIVE, "r_overheadsprites_scalex", "1", "additional scale for overhead sprites for x axis"};
34 cvar_t r_overheadsprites_scaley = {CF_CLIENT | CF_ARCHIVE, "r_overheadsprites_scaley", "1", "additional scale for overhead sprites for y axis"};
35 cvar_t r_track_sprites = {CF_CLIENT | CF_ARCHIVE, "r_track_sprites", "1", "track SPR_LABEL* sprites by putting them as indicator at the screen border to rotate to"};
36 cvar_t r_track_sprites_flags = {CF_CLIENT | CF_ARCHIVE, "r_track_sprites_flags", "1", "1: Rotate sprites accordingly, 2: Make it a continuous rotation"};
37 cvar_t r_track_sprites_scalew = {CF_CLIENT | CF_ARCHIVE, "r_track_sprites_scalew", "1", "width scaling of tracked sprites"};
38 cvar_t r_track_sprites_scaleh = {CF_CLIENT | CF_ARCHIVE, "r_track_sprites_scaleh", "1", "height scaling of tracked sprites"};
45 void Mod_SpriteInit (void)
47 Cvar_RegisterVariable(&r_mipsprites);
48 Cvar_RegisterVariable(&r_labelsprites_scale);
49 Cvar_RegisterVariable(&r_labelsprites_roundtopixels);
50 Cvar_RegisterVariable(&r_overheadsprites_perspective);
51 Cvar_RegisterVariable(&r_overheadsprites_pushback);
52 Cvar_RegisterVariable(&r_overheadsprites_scalex);
53 Cvar_RegisterVariable(&r_overheadsprites_scaley);
54 Cvar_RegisterVariable(&r_track_sprites);
55 Cvar_RegisterVariable(&r_track_sprites_flags);
56 Cvar_RegisterVariable(&r_track_sprites_scalew);
57 Cvar_RegisterVariable(&r_track_sprites_scaleh);
60 static void Mod_SpriteSetupTexture(texture_t *texture, skinframe_t *skinframe, qbool fullbright, qbool additive)
63 skinframe = R_SkinFrame_LoadMissing();
64 texture->offsetmapping = OFFSETMAPPING_OFF;
65 texture->offsetscale = 1;
66 texture->offsetbias = 0;
67 texture->specularscalemod = 1;
68 texture->specularpowermod = 1;
69 texture->basematerialflags = MATERIALFLAG_WALL;
70 texture->basealpha = 1.0f;
72 texture->basematerialflags |= MATERIALFLAG_FULLBRIGHT;
74 texture->basematerialflags |= MATERIALFLAG_ADD | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
75 else if (skinframe->hasalpha)
76 texture->basematerialflags |= MATERIALFLAG_ALPHA | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
77 texture->currentmaterialflags = texture->basematerialflags;
78 texture->materialshaderpass = texture->shaderpasses[0] = Mod_CreateShaderPass(loadmodel->mempool, skinframe);
79 texture->currentskinframe = skinframe;
80 texture->surfaceflags = 0;
81 texture->supercontents = SUPERCONTENTS_SOLID;
82 if (!(texture->basematerialflags & MATERIALFLAG_BLENDED))
83 texture->supercontents |= SUPERCONTENTS_OPAQUE;
84 texture->transparentsort = TRANSPARENTSORT_DISTANCE;
85 // WHEN ADDING DEFAULTS HERE, REMEMBER TO PUT DEFAULTS IN ALL LOADERS
86 // JUST GREP FOR "specularscalemod = 1".
89 extern cvar_t gl_texturecompression_sprites;
91 static void Mod_Sprite_SharedSetup(const unsigned char *datapointer, int version, const unsigned int *palette, qbool additive)
93 int i, j, groupframes, realframes, x, y, origin[2], width, height;
95 dspriteframetype_t *pinframetype;
96 dspriteframe_t *pinframe;
97 dspritegroup_t *pingroup;
98 dspriteinterval_t *pinintervals;
99 skinframe_t *skinframe;
100 float modelradius, interval;
101 char name[MAX_QPATH], fogname[MAX_QPATH];
102 const void *startframes;
103 int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | ((gl_texturecompression.integer && gl_texturecompression_sprites.integer) ? TEXF_COMPRESS : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_ALPHA | TEXF_CLAMP;
106 if (loadmodel->numframes < 1)
107 Host_Error ("Mod_Sprite_SharedSetup: Invalid # of frames: %d", loadmodel->numframes);
109 // LadyHavoc: hack to allow sprites to be non-fullbright
111 for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
112 if (loadmodel->name[i] == '!')
118 startframes = datapointer;
120 for (i = 0;i < loadmodel->numframes;i++)
122 pinframetype = (dspriteframetype_t *)datapointer;
123 datapointer += sizeof(dspriteframetype_t);
125 if (LittleLong (pinframetype->type) == SPR_SINGLE)
129 pingroup = (dspritegroup_t *)datapointer;
130 datapointer += sizeof(dspritegroup_t);
132 groupframes = LittleLong(pingroup->numframes);
134 datapointer += sizeof(dspriteinterval_t) * groupframes;
137 for (j = 0;j < groupframes;j++)
139 pinframe = (dspriteframe_t *)datapointer;
140 if (version == SPRITE32_VERSION)
141 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height) * 4;
142 else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
143 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height);
145 realframes += groupframes;
148 loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
149 loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * realframes);
150 loadmodel->num_textures = realframes;
151 loadmodel->num_texturesperskin = 1;
152 loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
154 datapointer = (unsigned char *)startframes;
156 for (i = 0;i < loadmodel->numframes;i++)
158 pinframetype = (dspriteframetype_t *)datapointer;
159 datapointer += sizeof(dspriteframetype_t);
161 if (LittleLong (pinframetype->type) == SPR_SINGLE)
168 pingroup = (dspritegroup_t *)datapointer;
169 datapointer += sizeof(dspritegroup_t);
171 groupframes = LittleLong(pingroup->numframes);
173 pinintervals = (dspriteinterval_t *)datapointer;
174 datapointer += sizeof(dspriteinterval_t) * groupframes;
176 interval = LittleFloat(pinintervals[0].interval);
177 if (interval < 0.01f)
178 Host_Error("Mod_Sprite_SharedSetup: invalid interval");
181 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
182 loadmodel->animscenes[i].firstframe = realframes;
183 loadmodel->animscenes[i].framecount = groupframes;
184 loadmodel->animscenes[i].framerate = 1.0f / interval;
185 loadmodel->animscenes[i].loop = true;
187 for (j = 0;j < groupframes;j++)
189 pinframe = (dspriteframe_t *)datapointer;
190 datapointer += sizeof(dspriteframe_t);
192 origin[0] = LittleLong (pinframe->origin[0]);
193 origin[1] = LittleLong (pinframe->origin[1]);
194 width = LittleLong (pinframe->width);
195 height = LittleLong (pinframe->height);
197 loadmodel->sprite.sprdata_frames[realframes].left = origin[0];
198 loadmodel->sprite.sprdata_frames[realframes].right = origin[0] + width;
199 loadmodel->sprite.sprdata_frames[realframes].up = origin[1];
200 loadmodel->sprite.sprdata_frames[realframes].down = origin[1] - height;
202 x = (int)max(loadmodel->sprite.sprdata_frames[realframes].left * loadmodel->sprite.sprdata_frames[realframes].left, loadmodel->sprite.sprdata_frames[realframes].right * loadmodel->sprite.sprdata_frames[realframes].right);
203 y = (int)max(loadmodel->sprite.sprdata_frames[realframes].up * loadmodel->sprite.sprdata_frames[realframes].up, loadmodel->sprite.sprdata_frames[realframes].down * loadmodel->sprite.sprdata_frames[realframes].down);
204 if (modelradius < x + y)
207 if (cls.state != ca_dedicated)
210 // note: Nehahra's null.spr has width == 0 and height == 0
211 if (width > 0 && height > 0)
215 dpsnprintf (name, sizeof(name), "%s_%i_%i", loadmodel->name, i, j);
216 dpsnprintf (fogname, sizeof(fogname), "%s_%i_%ifog", loadmodel->name, i, j);
220 dpsnprintf (name, sizeof(name), "%s_%i", loadmodel->name, i);
221 dpsnprintf (fogname, sizeof(fogname), "%s_%ifog", loadmodel->name, i);
223 if (!(skinframe = R_SkinFrame_LoadExternal(name, texflags | TEXF_COMPRESS, false, false)))
225 unsigned char *pixels = (unsigned char *) Mem_Alloc(loadmodel->mempool, width*height*4);
226 if (version == SPRITE32_VERSION)
228 for (x = 0;x < width*height;x++)
230 pixels[x*4+2] = datapointer[x*4+0];
231 pixels[x*4+1] = datapointer[x*4+1];
232 pixels[x*4+0] = datapointer[x*4+2];
233 pixels[x*4+3] = datapointer[x*4+3];
236 else //if (version == SPRITEHL_VERSION || version == SPRITE_VERSION)
237 Image_Copy8bitBGRA(datapointer, pixels, width*height, palette ? palette : palette_bgra_transparent);
238 skinframe = R_SkinFrame_LoadInternalBGRA(name, texflags, pixels, width, height, 0, 0, 0, false);
239 // texflags |= TEXF_COMPRESS;
243 if (skinframe == NULL)
244 skinframe = R_SkinFrame_LoadMissing();
245 Mod_SpriteSetupTexture(&loadmodel->data_textures[realframes], skinframe, fullbright, additive);
248 if (version == SPRITE32_VERSION)
249 datapointer += width * height * 4;
250 else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
251 datapointer += width * height;
256 modelradius = sqrt(modelradius);
257 for (i = 0;i < 3;i++)
259 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
260 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
262 loadmodel->radius = modelradius;
263 loadmodel->radius2 = modelradius * modelradius;
266 void Mod_IDSP_Load(model_t *mod, void *buffer, void *bufferend)
269 const unsigned char *datapointer;
271 datapointer = (unsigned char *)buffer;
273 loadmodel->modeldatatypestring = "SPR1";
275 loadmodel->type = mod_sprite;
277 loadmodel->Draw = R_Model_Sprite_Draw;
278 loadmodel->DrawDepth = NULL;
279 loadmodel->DrawLight = NULL;
281 version = LittleLong(((dsprite_t *)buffer)->version);
282 if (version == SPRITE_VERSION || version == SPRITE32_VERSION)
284 dsprite_t *pinqsprite;
286 pinqsprite = (dsprite_t *)datapointer;
287 datapointer += sizeof(dsprite_t);
289 loadmodel->numframes = LittleLong (pinqsprite->numframes);
290 loadmodel->sprite.sprnum_type = LittleLong (pinqsprite->type);
291 loadmodel->synctype = (synctype_t)LittleLong (pinqsprite->synctype);
293 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinqsprite->version), NULL, false);
295 else if (version == SPRITEHL_VERSION)
298 unsigned char palette[256][4];
299 const unsigned char *in;
300 dspritehl_t *pinhlsprite;
302 pinhlsprite = (dspritehl_t *)datapointer;
303 datapointer += sizeof(dspritehl_t);
305 loadmodel->numframes = LittleLong (pinhlsprite->numframes);
306 loadmodel->sprite.sprnum_type = LittleLong (pinhlsprite->type);
307 loadmodel->synctype = (synctype_t)LittleLong (pinhlsprite->synctype);
308 rendermode = pinhlsprite->rendermode;
312 i = in[0] + in[1] * 256;
314 Host_Error ("Mod_IDSP_Load: unexpected number of palette colors %i (should be 256)", i);
320 for (i = 0;i < 256;i++)
322 palette[i][2] = in[i*3+0];
323 palette[i][1] = in[i*3+1];
324 palette[i][0] = in[i*3+2];
329 for (i = 0;i < 256;i++)
331 palette[i][2] = in[i*3+0];
332 palette[i][1] = in[i*3+1];
333 palette[i][0] = in[i*3+2];
336 // also passes additive == true to Mod_Sprite_SharedSetup
338 case SPRHL_INDEXALPHA:
339 for (i = 0;i < 256;i++)
341 palette[i][2] = in[765];
342 palette[i][1] = in[766];
343 palette[i][0] = in[767];
348 case SPRHL_ALPHATEST:
349 for (i = 0;i < 256;i++)
351 palette[i][2] = in[i*3+0];
352 palette[i][1] = in[i*3+1];
353 palette[i][0] = in[i*3+2];
356 palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
357 // should this use alpha test or alpha blend? (currently blend)
360 Host_Error("Mod_IDSP_Load: unknown texFormat (%i, should be 0, 1, 2, or 3)", i);
364 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinhlsprite->version), (unsigned int *)(&palette[0][0]), rendermode == SPRHL_ADDITIVE);
367 Host_Error("Mod_IDSP_Load: %s has wrong version number (%i). Only %i (quake), %i (HalfLife), and %i (sprite32) supported",
368 loadmodel->name, version, SPRITE_VERSION, SPRITEHL_VERSION, SPRITE32_VERSION);
370 // TODO: Note that isanimated only means whether vertices change due to
371 // the animation. This may happen due to sprframe parameters changing.
372 // Mere texture chanegs OTOH shouldn't require isanimated to be 1.
373 loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || (loadmodel->animscenes && loadmodel->animscenes[0].framecount > 1);
377 void Mod_IDS2_Load(model_t *mod, void *buffer, void *bufferend)
381 const dsprite2_t *pinqsprite;
382 skinframe_t *skinframe;
384 int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_COMPRESS | TEXF_ALPHA | TEXF_CLAMP;
386 loadmodel->modeldatatypestring = "SPR2";
388 loadmodel->type = mod_sprite;
390 loadmodel->Draw = R_Model_Sprite_Draw;
391 loadmodel->DrawDepth = NULL;
392 loadmodel->DrawLight = NULL;
394 pinqsprite = (dsprite2_t *)buffer;
396 version = LittleLong(pinqsprite->version);
397 if (version != SPRITE2_VERSION)
398 Host_Error("Mod_IDS2_Load: %s has wrong version number (%i should be 2 (quake 2)", loadmodel->name, version);
400 loadmodel->numframes = LittleLong (pinqsprite->numframes);
401 if (loadmodel->numframes < 1)
402 Host_Error ("Mod_IDS2_Load: Invalid # of frames: %d", loadmodel->numframes);
403 loadmodel->sprite.sprnum_type = SPR_VP_PARALLEL;
404 loadmodel->synctype = ST_SYNC;
406 // LadyHavoc: hack to allow sprites to be non-fullbright
408 for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
409 if (loadmodel->name[i] == '!')
412 loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
413 loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * loadmodel->numframes);
414 loadmodel->num_textures = loadmodel->numframes;
415 loadmodel->num_texturesperskin = 1;
416 loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
419 for (i = 0;i < loadmodel->numframes;i++)
421 int origin[2], x, y, width, height;
422 const dsprite2frame_t *pinframe;
423 mspriteframe_t *sprframe;
425 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
426 loadmodel->animscenes[i].firstframe = i;
427 loadmodel->animscenes[i].framecount = 1;
428 loadmodel->animscenes[i].framerate = 10;
429 loadmodel->animscenes[i].loop = true;
431 pinframe = &pinqsprite->frames[i];
433 origin[0] = LittleLong (pinframe->origin_x);
434 origin[1] = LittleLong (pinframe->origin_y);
435 width = LittleLong (pinframe->width);
436 height = LittleLong (pinframe->height);
438 sprframe = &loadmodel->sprite.sprdata_frames[i];
440 // note that sp2 origin[0] is positive, where as it is negative in
442 sprframe->left = -origin[0];
443 sprframe->right = -origin[0] + width;
444 sprframe->up = origin[1];
445 sprframe->down = origin[1] - height;
447 x = (int)max(sprframe->left * sprframe->left, sprframe->right * sprframe->right);
448 y = (int)max(sprframe->up * sprframe->up, sprframe->down * sprframe->down);
449 if (modelradius < x + y)
453 if (cls.state != ca_dedicated)
455 for (i = 0;i < loadmodel->numframes;i++)
457 const dsprite2frame_t *pinframe;
458 pinframe = &pinqsprite->frames[i];
459 if (!(skinframe = R_SkinFrame_LoadExternal(pinframe->name, texflags, false, false)))
461 Con_Printf(CON_ERROR "Mod_IDS2_Load: failed to load %s", pinframe->name);
462 skinframe = R_SkinFrame_LoadMissing();
464 Mod_SpriteSetupTexture(&loadmodel->data_textures[i], skinframe, fullbright, false);
468 modelradius = sqrt(modelradius);
469 for (i = 0;i < 3;i++)
471 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
472 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
474 loadmodel->radius = modelradius;
475 loadmodel->radius2 = modelradius * modelradius;
477 // TODO: Note that isanimated only means whether vertices change due to
478 // the animation. This may happen due to sprframe parameters changing.
479 // Mere texture chanegs OTOH shouldn't require isanimated to be 1.
480 loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || (loadmodel->animscenes && loadmodel->animscenes[0].framecount > 1);