OpenTTD Source: src/spritecache.cpp Source File

OpenTTD Source 1.11.0-RC1

spritecache.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11 #include "fileio_func.h"
12 #include "spriteloader/grf.hpp"
13 #include "gfx_func.h"
14 #include "error.h"
15 #include "zoom_func.h"
16 #include "settings_type.h"
17 #include "blitter/factory.hpp"
18 #include "core/math_func.hpp"
19 #include "core/mem_func.hpp"
20 #include "video/video_driver.hpp"
21
22 #include "table/sprites.h"
23 #include "table/strings.h"
24 #include "table/palette_convert.h"
25
26 #include "safeguards.h"
27
28 /* Default of 4MB spritecache */
29 uint _sprite_cache_size = 4;
30
31 struct SpriteCache {
32 void *ptr;
33 size_t file_pos;
34 uint32 id;
35 uint16 file_slot;
36 int16 lru;
37 SpriteType type;
38 bool warned;
39 byte container_ver;
40 };
41
42
43 static uint _spritecache_items = 0;
44 static SpriteCache *_spritecache = nullptr;
45
46
47 static inline SpriteCache *GetSpriteCache(uint index)
48 {
49 return &_spritecache[index];
50 }
51
52 static inline bool IsMapgenSpriteID(SpriteID sprite)
53 {
54 return IsInsideMM(sprite, 4845, 4882);
55 }
56
57 static SpriteCache *AllocateSpriteCache(uint index)
58 {
59 if (index >= _spritecache_items) {
60 /* Add another 1024 items to the 'pool' */
61 uint items = Align(index + 1, 1024);
62
63 DEBUG(sprite, 4, "Increasing sprite cache to %u items (" PRINTF_SIZE " bytes)", items, items * sizeof(*_spritecache));
64
65 _spritecache = ReallocT(_spritecache, items);
66
67 /* Reset the new items and update the count */
68 memset(_spritecache + _spritecache_items, 0, (items - _spritecache_items) * sizeof(*_spritecache));
69 _spritecache_items = items;
70 }
71
72 return GetSpriteCache(index);
73 }
74
75
76 struct MemBlock {
77 size_t size;
78 byte data[];
79 };
80
81 static uint _sprite_lru_counter;
82 static MemBlock *_spritecache_ptr;
83 static uint _allocated_sprite_cache_size = 0;
84 static int _compact_cache_counter;
85
86 static void CompactSpriteCache();
87 static void *AllocSprite(size_t mem_req);
88
95 bool SkipSpriteData(byte type, uint16 num)
96 {
97 if (type & 2) {
98 FioSkipBytes(num);
99 } else {
100 while (num > 0) {
101 int8 i = FioReadByte();
102 if (i >= 0) {
103 int size = (i == 0) ? 0x80 : i;
104 if (size > num) return false;
105 num -= size;
106 FioSkipBytes(size);
107 } else {
108 i = -(i >> 3);
109 num -= i;
110 FioReadByte();
111 }
112 }
113 }
114 return true;
115 }
116
117 /* Check if the given Sprite ID exists */
118 bool SpriteExists(SpriteID id)
119 {
120 if (id >= _spritecache_items) return false;
121
122 /* Special case for Sprite ID zero -- its position is also 0... */
123 if (id == 0) return true;
124 return !(GetSpriteCache(id)->file_pos == 0 && GetSpriteCache(id)->file_slot == 0);
125 }
126
132 SpriteType GetSpriteType(SpriteID sprite)
133 {
134 if (!SpriteExists(sprite)) return ST_INVALID;
135 return GetSpriteCache(sprite)->type;
136 }
137
143 uint GetOriginFileSlot(SpriteID sprite)
144 {
145 if (!SpriteExists(sprite)) return 0;
146 return GetSpriteCache(sprite)->file_slot;
147 }
148
154 uint32 GetSpriteLocalID(SpriteID sprite)
155 {
156 if (!SpriteExists(sprite)) return 0;
157 return GetSpriteCache(sprite)->id;
158 }
159
167 uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end)
168 {
169 uint count = 0;
170 for (SpriteID i = begin; i != end; i++) {
171 if (SpriteExists(i)) {
172 SpriteCache *sc = GetSpriteCache(i);
173 if (sc->file_slot == file_slot) count++;
174 }
175 }
176 return count;
177 }
178
187 uint GetMaxSpriteID()
188 {
189 return _spritecache_items;
190 }
191
192 static bool ResizeSpriteIn(SpriteLoader::Sprite *sprite, ZoomLevel src, ZoomLevel tgt)
193 {
194 uint8 scaled_1 = ScaleByZoom(1, (ZoomLevel)(src - tgt));
195
196 /* Check for possible memory overflow. */
197 if (sprite[src].width * scaled_1 > UINT16_MAX || sprite[src].height * scaled_1 > UINT16_MAX) return false;
198
199 sprite[tgt].width = sprite[src].width * scaled_1;
200 sprite[tgt].height = sprite[src].height * scaled_1;
201 sprite[tgt].x_offs = sprite[src].x_offs * scaled_1;
202 sprite[tgt].y_offs = sprite[src].y_offs * scaled_1;
203 sprite[tgt].colours = sprite[src].colours;
204
205 sprite[tgt].AllocateData(tgt, sprite[tgt].width * sprite[tgt].height);
206
207 SpriteLoader::CommonPixel *dst = sprite[tgt].data;
208 for (int y = 0; y < sprite[tgt].height; y++) {
209 const SpriteLoader::CommonPixel *src_ln = &sprite[src].data[y / scaled_1 * sprite[src].width];
210 for (int x = 0; x < sprite[tgt].width; x++) {
211 *dst = src_ln[x / scaled_1];
212 dst++;
213 }
214 }
215
216 return true;
217 }
218
219 static void ResizeSpriteOut(SpriteLoader::Sprite *sprite, ZoomLevel zoom)
220 {
221 /* Algorithm based on 32bpp_Optimized::ResizeSprite() */
222 sprite[zoom].width = UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].width, zoom);
223 sprite[zoom].height = UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].height, zoom);
224 sprite[zoom].x_offs = UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].x_offs, zoom);
225 sprite[zoom].y_offs = UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].y_offs, zoom);
226 sprite[zoom].colours = sprite[ZOOM_LVL_NORMAL].colours;
227
228 sprite[zoom].AllocateData(zoom, sprite[zoom].height * sprite[zoom].width);
229
230 SpriteLoader::CommonPixel *dst = sprite[zoom].data;
231 const SpriteLoader::CommonPixel *src = sprite[zoom - 1].data;
232 const SpriteLoader::CommonPixel *src_end = src + sprite[zoom - 1].height * sprite[zoom - 1].width;
233
234 for (uint y = 0; y < sprite[zoom].height; y++) {
235 const SpriteLoader::CommonPixel *src_ln = src + sprite[zoom - 1].width;
236 assert(src_ln <= src_end);
237 for (uint x = 0; x < sprite[zoom].width; x++) {
238 assert(src < src_ln);
239 if (src + 1 != src_ln && (src + 1)->a != 0) {
240 *dst = *(src + 1);
241 } else {
242 *dst = *src;
243 }
244 dst++;
245 src += 2;
246 }
247 src = src_ln + sprite[zoom - 1].width;
248 }
249 }
250
251 static bool PadSingleSprite(SpriteLoader::Sprite *sprite, ZoomLevel zoom, uint pad_left, uint pad_top, uint pad_right, uint pad_bottom)
252 {
253 uint width = sprite->width + pad_left + pad_right;
254 uint height = sprite->height + pad_top + pad_bottom;
255
256 if (width > UINT16_MAX || height > UINT16_MAX) return false;
257
258 /* Copy source data and reallocate sprite memory. */
259 SpriteLoader::CommonPixel *src_data = MallocT<SpriteLoader::CommonPixel>(sprite->width * sprite->height);
260 MemCpyT(src_data, sprite->data, sprite->width * sprite->height);
261 sprite->AllocateData(zoom, width * height);
262
263 /* Copy with padding to destination. */
264 SpriteLoader::CommonPixel *src = src_data;
265 SpriteLoader::CommonPixel *data = sprite->data;
266 for (uint y = 0; y < height; y++) {
267 if (y < pad_top || pad_bottom + y >= height) {
268 /* Top/bottom padding. */
269 MemSetT(data, 0, width);
270 data += width;
271 } else {
272 if (pad_left > 0) {
273 /* Pad left. */
274 MemSetT(data, 0, pad_left);
275 data += pad_left;
276 }
277
278 /* Copy pixels. */
279 MemCpyT(data, src, sprite->width);
280 src += sprite->width;
281 data += sprite->width;
282
283 if (pad_right > 0) {
284 /* Pad right. */
285 MemSetT(data, 0, pad_right);
286 data += pad_right;
287 }
288 }
289 }
290 free(src_data);
291
292 /* Update sprite size. */
293 sprite->width = width;
294 sprite->height = height;
295 sprite->x_offs -= pad_left;
296 sprite->y_offs -= pad_top;
297
298 return true;
299 }
300
301 static bool PadSprites(SpriteLoader::Sprite *sprite, uint8 sprite_avail, SpriteEncoder *encoder)
302 {
303 /* Get minimum top left corner coordinates. */
304 int min_xoffs = INT32_MAX;
305 int min_yoffs = INT32_MAX;
306 for (ZoomLevel zoom = ZOOM_LVL_BEGIN; zoom != ZOOM_LVL_END; zoom++) {
307 if (HasBit(sprite_avail, zoom)) {
308 min_xoffs = std::min(min_xoffs, ScaleByZoom(sprite[zoom].x_offs, zoom));
309 min_yoffs = std::min(min_yoffs, ScaleByZoom(sprite[zoom].y_offs, zoom));
310 }
311 }
312
313 /* Get maximum dimensions taking necessary padding at the top left into account. */
314 int max_width = INT32_MIN;
315 int max_height = INT32_MIN;
316 for (ZoomLevel zoom = ZOOM_LVL_BEGIN; zoom != ZOOM_LVL_END; zoom++) {
317 if (HasBit(sprite_avail, zoom)) {
318 max_width = std::max(max_width, ScaleByZoom(sprite[zoom].width + sprite[zoom].x_offs - UnScaleByZoom(min_xoffs, zoom), zoom));
319 max_height = std::max(max_height, ScaleByZoom(sprite[zoom].height + sprite[zoom].y_offs - UnScaleByZoom(min_yoffs, zoom), zoom));
320 }
321 }
322
323 /* Align height and width if required to match the needs of the sprite encoder. */
324 uint align = encoder->GetSpriteAlignment();
325 if (align != 0) {
326 max_width = Align(max_width, align);
327 max_height = Align(max_height, align);
328 }
329
330 /* Pad sprites where needed. */
331 for (ZoomLevel zoom = ZOOM_LVL_BEGIN; zoom != ZOOM_LVL_END; zoom++) {
332 if (HasBit(sprite_avail, zoom)) {
333 /* Scaling the sprite dimensions in the blitter is done with rounding up,
334 * so a negative padding here is not an error. */
335 int pad_left = std::max(0, sprite[zoom].x_offs - UnScaleByZoom(min_xoffs, zoom));
336 int pad_top = std::max(0, sprite[zoom].y_offs - UnScaleByZoom(min_yoffs, zoom));
337 int pad_right = std::max(0, UnScaleByZoom(max_width, zoom) - sprite[zoom].width - pad_left);
338 int pad_bottom = std::max(0, UnScaleByZoom(max_height, zoom) - sprite[zoom].height - pad_top);
339
340 if (pad_left > 0 || pad_right > 0 || pad_top > 0 || pad_bottom > 0) {
341 if (!PadSingleSprite(&sprite[zoom], zoom, pad_left, pad_top, pad_right, pad_bottom)) return false;
342 }
343 }
344 }
345
346 return true;
347 }
348
349 static bool ResizeSprites(SpriteLoader::Sprite *sprite, uint8 sprite_avail, uint32 file_slot, uint32 file_pos, SpriteEncoder *encoder)
350 {
351 /* Create a fully zoomed image if it does not exist */
352 ZoomLevel first_avail = static_cast<ZoomLevel>(FIND_FIRST_BIT(sprite_avail));
353 if (first_avail != ZOOM_LVL_NORMAL) {
354 if (!ResizeSpriteIn(sprite, first_avail, ZOOM_LVL_NORMAL)) return false;
355 SetBit(sprite_avail, ZOOM_LVL_NORMAL);
356 }
357
358 /* Pad sprites to make sizes match. */
359 if (!PadSprites(sprite, sprite_avail, encoder)) return false;
360
361 /* Create other missing zoom levels */
362 for (ZoomLevel zoom = ZOOM_LVL_OUT_2X; zoom != ZOOM_LVL_END; zoom++) {
363 if (HasBit(sprite_avail, zoom)) {
364 /* Check that size and offsets match the fully zoomed image. */
365 assert(sprite[zoom].width == UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].width, zoom));
366 assert(sprite[zoom].height == UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].height, zoom));
367 assert(sprite[zoom].x_offs == UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].x_offs, zoom));
368 assert(sprite[zoom].y_offs == UnScaleByZoom(sprite[ZOOM_LVL_NORMAL].y_offs, zoom));
369 }
370
371 /* Zoom level is not available, or unusable, so create it */
372 if (!HasBit(sprite_avail, zoom)) ResizeSpriteOut(sprite, zoom);
373 }
374
375 return true;
376 }
377
384 static void *ReadRecolourSprite(uint16 file_slot, uint num)
385 {
386 /* "Normal" recolour sprites are ALWAYS 257 bytes. Then there is a small
387 * number of recolour sprites that are 17 bytes that only exist in DOS
388 * GRFs which are the same as 257 byte recolour sprites, but with the last
389 * 240 bytes zeroed. */
390 static const uint RECOLOUR_SPRITE_SIZE = 257;
391 byte *dest = (byte *)AllocSprite(std::max(RECOLOUR_SPRITE_SIZE, num));
392
393 if (_palette_remap_grf[file_slot]) {
394 byte *dest_tmp = AllocaM(byte, std::max(RECOLOUR_SPRITE_SIZE, num));
395
396 /* Only a few recolour sprites are less than 257 bytes */
397 if (num < RECOLOUR_SPRITE_SIZE) memset(dest_tmp, 0, RECOLOUR_SPRITE_SIZE);
398 FioReadBlock(dest_tmp, num);
399
400 /* The data of index 0 is never used; "literal 00" according to the (New)GRF specs. */
401 for (uint i = 1; i < RECOLOUR_SPRITE_SIZE; i++) {
402 dest[i] = _palmap_w2d[dest_tmp[_palmap_d2w[i - 1] + 1]];
403 }
404 } else {
405 FioReadBlock(dest, num);
406 }
407
408 return dest;
409 }
410
420 static void *ReadSprite(const SpriteCache *sc, SpriteID id, SpriteType sprite_type, AllocatorProc *allocator, SpriteEncoder *encoder)
421 {
422 /* Use current blitter if no other sprite encoder is given. */
423 if (encoder == nullptr) encoder = BlitterFactory::GetCurrentBlitter();
424
425 uint8 file_slot = sc->file_slot;
426 size_t file_pos = sc->file_pos;
427
428 assert(sprite_type != ST_RECOLOUR);
429 assert(IsMapgenSpriteID(id) == (sprite_type == ST_MAPGEN));
430 assert(sc->type == sprite_type);
431
432 DEBUG(sprite, 9, "Load sprite %d", id);
433
434 SpriteLoader::Sprite sprite[ZOOM_LVL_COUNT];
435 uint8 sprite_avail = 0;
436 sprite[ZOOM_LVL_NORMAL].type = sprite_type;
437
438 SpriteLoaderGrf sprite_loader(sc->container_ver);
439 if (sprite_type != ST_MAPGEN && encoder->Is32BppSupported()) {
440 /* Try for 32bpp sprites first. */
441 sprite_avail = sprite_loader.LoadSprite(sprite, file_slot, file_pos, sprite_type, true);
442 }
443 if (sprite_avail == 0) {
444 sprite_avail = sprite_loader.LoadSprite(sprite, file_slot, file_pos, sprite_type, false);
445 }
446
447 if (sprite_avail == 0) {
448 if (sprite_type == ST_MAPGEN) return nullptr;
449 if (id == SPR_IMG_QUERY) usererror("Okay... something went horribly wrong. I couldn't load the fallback sprite. What should I do?");
450 return (void*)GetRawSprite(SPR_IMG_QUERY, ST_NORMAL, allocator, encoder);
451 }
452
453 if (sprite_type == ST_MAPGEN) {
454 /* Ugly hack to work around the problem that the old landscape
455 * generator assumes that those sprites are stored uncompressed in
456 * the memory, and they are only read directly by the code, never
457 * send to the blitter. So do not send it to the blitter (which will
458 * result in a data array in the format the blitter likes most), but
459 * extract the data directly and store that as sprite.
460 * Ugly: yes. Other solution: no. Blame the original author or
461 * something ;) The image should really have been a data-stream
462 * (so type = 0xFF basically). */
463 uint num = sprite[ZOOM_LVL_NORMAL].width * sprite[ZOOM_LVL_NORMAL].height;
464
465 Sprite *s = (Sprite *)allocator(sizeof(*s) + num);
466 s->width = sprite[ZOOM_LVL_NORMAL].width;
467 s->height = sprite[ZOOM_LVL_NORMAL].height;
468 s->x_offs = sprite[ZOOM_LVL_NORMAL].x_offs;
469 s->y_offs = sprite[ZOOM_LVL_NORMAL].y_offs;
470
471 SpriteLoader::CommonPixel *src = sprite[ZOOM_LVL_NORMAL].data;
472 byte *dest = s->data;
473 while (num-- > 0) {
474 *dest++ = src->m;
475 src++;
476 }
477
478 return s;
479 }
480
481 if (!ResizeSprites(sprite, sprite_avail, file_slot, sc->id, encoder)) {
482 if (id == SPR_IMG_QUERY) usererror("Okay... something went horribly wrong. I couldn't resize the fallback sprite. What should I do?");
483 return (void*)GetRawSprite(SPR_IMG_QUERY, ST_NORMAL, allocator, encoder);
484 }
485
486 if (sprite->type == ST_FONT && ZOOM_LVL_FONT != ZOOM_LVL_NORMAL) {
487 /* Make ZOOM_LVL_NORMAL be ZOOM_LVL_FONT */
488 sprite[ZOOM_LVL_NORMAL].width = sprite[ZOOM_LVL_FONT].width;
489 sprite[ZOOM_LVL_NORMAL].height = sprite[ZOOM_LVL_FONT].height;
490 sprite[ZOOM_LVL_NORMAL].x_offs = sprite[ZOOM_LVL_FONT].x_offs;
491 sprite[ZOOM_LVL_NORMAL].y_offs = sprite[ZOOM_LVL_FONT].y_offs;
492 sprite[ZOOM_LVL_NORMAL].data = sprite[ZOOM_LVL_FONT].data;
493 sprite[ZOOM_LVL_NORMAL].colours = sprite[ZOOM_LVL_FONT].colours;
494 }
495
496 return encoder->Encode(sprite, allocator);
497 }
498
499
501 static std::map<uint32, size_t> _grf_sprite_offsets;
502
508 size_t GetGRFSpriteOffset(uint32 id)
509 {
510 return _grf_sprite_offsets.find(id) != _grf_sprite_offsets.end() ? _grf_sprite_offsets[id] : SIZE_MAX;
511 }
512
517 void ReadGRFSpriteOffsets(byte container_version)
518 {
519 _grf_sprite_offsets.clear();
520
521 if (container_version >= 2) {
522 /* Seek to sprite section of the GRF. */
523 size_t data_offset = FioReadDword();
524 size_t old_pos = FioGetPos();
525 FioSeekTo(data_offset, SEEK_CUR);
526
527 /* Loop over all sprite section entries and store the file
528 * offset for each newly encountered ID. */
529 uint32 id, prev_id = 0;
530 while ((id = FioReadDword()) != 0) {
531 if (id != prev_id) _grf_sprite_offsets[id] = FioGetPos() - 4;
532 prev_id = id;
533 FioSkipBytes(FioReadDword());
534 }
535
536 /* Continue processing the data section. */
537 FioSeekTo(old_pos, SEEK_SET);
538 }
539 }
540
541
550 bool LoadNextSprite(int load_index, byte file_slot, uint file_sprite_id, byte container_version)
551 {
552 size_t file_pos = FioGetPos();
553
554 /* Read sprite header. */
555 uint32 num = container_version >= 2 ? FioReadDword() : FioReadWord();
556 if (num == 0) return false;
557 byte grf_type = FioReadByte();
558
559 SpriteType type;
560 void *data = nullptr;
561 if (grf_type == 0xFF) {
562 /* Some NewGRF files have "empty" pseudo-sprites which are 1
563 * byte long. Catch these so the sprites won't be displayed. */
564 if (num == 1) {
565 FioReadByte();
566 return false;
567 }
568 type = ST_RECOLOUR;
569 data = ReadRecolourSprite(file_slot, num);
570 } else if (container_version >= 2 && grf_type == 0xFD) {
571 if (num != 4) {
572 /* Invalid sprite section include, ignore. */
573 FioSkipBytes(num);
574 return false;
575 }
576 /* It is not an error if no sprite with the provided ID is found in the sprite section. */
577 file_pos = GetGRFSpriteOffset(FioReadDword());
578 type = ST_NORMAL;
579 } else {
580 FioSkipBytes(7);
581 type = SkipSpriteData(grf_type, num - 8) ? ST_NORMAL : ST_INVALID;
582 /* Inline sprites are not supported for container version >= 2. */
583 if (container_version >= 2) return false;
584 }
585
586 if (type == ST_INVALID) return false;
587
588 if (load_index >= MAX_SPRITES) {
589 usererror("Tried to load too many sprites (#%d; max %d)", load_index, MAX_SPRITES);
590 }
591
592 bool is_mapgen = IsMapgenSpriteID(load_index);
593
594 if (is_mapgen) {
595 if (type != ST_NORMAL) usererror("Uhm, would you be so kind not to load a NewGRF that changes the type of the map generator sprites?");
596 type = ST_MAPGEN;
597 }
598
599 SpriteCache *sc = AllocateSpriteCache(load_index);
600 sc->file_slot = file_slot;
601 sc->file_pos = file_pos;
602 sc->ptr = data;
603 sc->lru = 0;
604 sc->id = file_sprite_id;
605 sc->type = type;
606 sc->warned = false;
607 sc->container_ver = container_version;
608
609 return true;
610 }
611
612
613 void DupSprite(SpriteID old_spr, SpriteID new_spr)
614 {
615 SpriteCache *scnew = AllocateSpriteCache(new_spr); // may reallocate: so put it first
616 SpriteCache *scold = GetSpriteCache(old_spr);
617
618 scnew->file_slot = scold->file_slot;
619 scnew->file_pos = scold->file_pos;
620 scnew->ptr = nullptr;
621 scnew->id = scold->id;
622 scnew->type = scold->type;
623 scnew->warned = false;
624 scnew->container_ver = scold->container_ver;
625 }
626
633 static const size_t S_FREE_MASK = sizeof(size_t) - 1;
634
635 /* to make sure nobody adds things to MemBlock without checking S_FREE_MASK first */
636 static_assert(sizeof(MemBlock) == sizeof(size_t));
637 /* make sure it's a power of two */
638 static_assert((sizeof(size_t) & (sizeof(size_t) - 1)) == 0);
639
640 static inline MemBlock *NextBlock(MemBlock *block)
641 {
642 return (MemBlock*)((byte*)block + (block->size & ~S_FREE_MASK));
643 }
644
645 static size_t GetSpriteCacheUsage()
646 {
647 size_t tot_size = 0;
648 MemBlock *s;
649
650 for (s = _spritecache_ptr; s->size != 0; s = NextBlock(s)) {
651 if (!(s->size & S_FREE_MASK)) tot_size += s->size;
652 }
653
654 return tot_size;
655 }
656
657
658 void IncreaseSpriteLRU()
659 {
660 /* Increase all LRU values */
661 if (_sprite_lru_counter > 16384) {
662 SpriteID i;
663
664 DEBUG(sprite, 3, "Fixing lru %u, inuse=" PRINTF_SIZE, _sprite_lru_counter, GetSpriteCacheUsage());
665
666 for (i = 0; i != _spritecache_items; i++) {
667 SpriteCache *sc = GetSpriteCache(i);
668 if (sc->ptr != nullptr) {
669 if (sc->lru >= 0) {
670 sc->lru = -1;
671 } else if (sc->lru != -32768) {
672 sc->lru--;
673 }
674 }
675 }
676 _sprite_lru_counter = 0;
677 }
678
679 /* Compact sprite cache every now and then. */
680 if (++_compact_cache_counter >= 740) {
681 CompactSpriteCache();
682 _compact_cache_counter = 0;
683 }
684 }
685
690 static void CompactSpriteCache()
691 {
692 MemBlock *s;
693
694 DEBUG(sprite, 3, "Compacting sprite cache, inuse=" PRINTF_SIZE, GetSpriteCacheUsage());
695
696 for (s = _spritecache_ptr; s->size != 0;) {
697 if (s->size & S_FREE_MASK) {
698 MemBlock *next = NextBlock(s);
699 MemBlock temp;
700 SpriteID i;
701
702 /* Since free blocks are automatically coalesced, this should hold true. */
703 assert(!(next->size & S_FREE_MASK));
704
705 /* If the next block is the sentinel block, we can safely return */
706 if (next->size == 0) break;
707
708 /* Locate the sprite belonging to the next pointer. */
709 for (i = 0; GetSpriteCache(i)->ptr != next->data; i++) {
710 assert(i != _spritecache_items);
711 }
712
713 GetSpriteCache(i)->ptr = s->data; // Adjust sprite array entry
714 /* Swap this and the next block */
715 temp = *s;
716 memmove(s, next, next->size);
717 s = NextBlock(s);
718 *s = temp;
719
720 /* Coalesce free blocks */
721 while (NextBlock(s)->size & S_FREE_MASK) {
722 s->size += NextBlock(s)->size & ~S_FREE_MASK;
723 }
724 } else {
725 s = NextBlock(s);
726 }
727 }
728 }
729
734 static void DeleteEntryFromSpriteCache(uint item)
735 {
736 /* Mark the block as free (the block must be in use) */
737 MemBlock *s = (MemBlock*)GetSpriteCache(item)->ptr - 1;
738 assert(!(s->size & S_FREE_MASK));
739 s->size |= S_FREE_MASK;
740 GetSpriteCache(item)->ptr = nullptr;
741
742 /* And coalesce adjacent free blocks */
743 for (s = _spritecache_ptr; s->size != 0; s = NextBlock(s)) {
744 if (s->size & S_FREE_MASK) {
745 while (NextBlock(s)->size & S_FREE_MASK) {
746 s->size += NextBlock(s)->size & ~S_FREE_MASK;
747 }
748 }
749 }
750 }
751
752 static void DeleteEntryFromSpriteCache()
753 {
754 uint best = UINT_MAX;
755 int cur_lru;
756
757 DEBUG(sprite, 3, "DeleteEntryFromSpriteCache, inuse=" PRINTF_SIZE, GetSpriteCacheUsage());
758
759 cur_lru = 0xffff;
760 for (SpriteID i = 0; i != _spritecache_items; i++) {
761 SpriteCache *sc = GetSpriteCache(i);
762 if (sc->type != ST_RECOLOUR && sc->ptr != nullptr && sc->lru < cur_lru) {
763 cur_lru = sc->lru;
764 best = i;
765 }
766 }
767
768 /* Display an error message and die, in case we found no sprite at all.
769 * This shouldn't really happen, unless all sprites are locked. */
770 if (best == UINT_MAX) error("Out of sprite memory");
771
772 DeleteEntryFromSpriteCache(best);
773 }
774
775 static void *AllocSprite(size_t mem_req)
776 {
777 mem_req += sizeof(MemBlock);
778
779 /* Align this to correct boundary. This also makes sure at least one
780 * bit is not used, so we can use it for other things. */
781 mem_req = Align(mem_req, S_FREE_MASK + 1);
782
783 for (;;) {
784 MemBlock *s;
785
786 for (s = _spritecache_ptr; s->size != 0; s = NextBlock(s)) {
787 if (s->size & S_FREE_MASK) {
788 size_t cur_size = s->size & ~S_FREE_MASK;
789
790 /* Is the block exactly the size we need or
791 * big enough for an additional free block? */
792 if (cur_size == mem_req ||
793 cur_size >= mem_req + sizeof(MemBlock)) {
794 /* Set size and in use */
795 s->size = mem_req;
796
797 /* Do we need to inject a free block too? */
798 if (cur_size != mem_req) {
799 NextBlock(s)->size = (cur_size - mem_req) | S_FREE_MASK;
800 }
801
802 return s->data;
803 }
804 }
805 }
806
807 /* Reached sentinel, but no block found yet. Delete some old entry. */
808 DeleteEntryFromSpriteCache();
809 }
810 }
811
815 void *SimpleSpriteAlloc(size_t size)
816 {
817 return MallocT<byte>(size);
818 }
819
829 static void *HandleInvalidSpriteRequest(SpriteID sprite, SpriteType requested, SpriteCache *sc, AllocatorProc *allocator)
830 {
831 static const char * const sprite_types[] = {
832 "normal", // ST_NORMAL
833 "map generator", // ST_MAPGEN
834 "character", // ST_FONT
835 "recolour", // ST_RECOLOUR
836 };
837
838 SpriteType available = sc->type;
839 if (requested == ST_FONT && available == ST_NORMAL) {
840 if (sc->ptr == nullptr) sc->type = ST_FONT;
841 return GetRawSprite(sprite, sc->type, allocator);
842 }
843
844 byte warning_level = sc->warned ? 6 : 0;
845 sc->warned = true;
846 DEBUG(sprite, warning_level, "Tried to load %s sprite #%d as a %s sprite. Probable cause: NewGRF interference", sprite_types[available], sprite, sprite_types[requested]);
847
848 switch (requested) {
849 case ST_NORMAL:
850 if (sprite == SPR_IMG_QUERY) usererror("Uhm, would you be so kind not to load a NewGRF that makes the 'query' sprite a non-normal sprite?");
851 FALLTHROUGH;
852 case ST_FONT:
853 return GetRawSprite(SPR_IMG_QUERY, ST_NORMAL, allocator);
854 case ST_RECOLOUR:
855 if (sprite == PALETTE_TO_DARK_BLUE) usererror("Uhm, would you be so kind not to load a NewGRF that makes the 'PALETTE_TO_DARK_BLUE' sprite a non-remap sprite?");
856 return GetRawSprite(PALETTE_TO_DARK_BLUE, ST_RECOLOUR, allocator);
857 case ST_MAPGEN:
858 /* this shouldn't happen, overriding of ST_MAPGEN sprites is checked in LoadNextSprite()
859 * (the only case the check fails is when these sprites weren't even loaded...) */
860 default:
861 NOT_REACHED();
862 }
863 }
864
874 void *GetRawSprite(SpriteID sprite, SpriteType type, AllocatorProc *allocator, SpriteEncoder *encoder)
875 {
876 assert(type != ST_MAPGEN || IsMapgenSpriteID(sprite));
877 assert(type < ST_INVALID);
878
879 if (!SpriteExists(sprite)) {
880 DEBUG(sprite, 1, "Tried to load non-existing sprite #%d. Probable cause: Wrong/missing NewGRFs", sprite);
881
882 /* SPR_IMG_QUERY is a BIG FAT RED ? */
883 sprite = SPR_IMG_QUERY;
884 }
885
886 SpriteCache *sc = GetSpriteCache(sprite);
887
888 if (sc->type != type) return HandleInvalidSpriteRequest(sprite, type, sc, allocator);
889
890 if (allocator == nullptr && encoder == nullptr) {
891 /* Load sprite into/from spritecache */
892
893 /* Update LRU */
894 sc->lru = ++_sprite_lru_counter;
895
896 /* Load the sprite, if it is not loaded, yet */
897 if (sc->ptr == nullptr) sc->ptr = ReadSprite(sc, sprite, type, AllocSprite, nullptr);
898
899 return sc->ptr;
900 } else {
901 /* Do not use the spritecache, but a different allocator. */
902 return ReadSprite(sc, sprite, type, allocator, encoder);
903 }
904 }
905
906
907 static void GfxInitSpriteCache()
908 {
909 /* initialize sprite cache heap */
910 int bpp = BlitterFactory::GetCurrentBlitter()->GetScreenDepth();
911 uint target_size = (bpp > 0 ? _sprite_cache_size * bpp / 8 : 1) * 1024 * 1024;
912
913 /* Remember 'target_size' from the previous allocation attempt, so we do not try to reach the target_size multiple times in case of failure. */
914 static uint last_alloc_attempt = 0;
915
916 if (_spritecache_ptr == nullptr || (_allocated_sprite_cache_size != target_size && target_size != last_alloc_attempt)) {
917 delete[] reinterpret_cast<byte *>(_spritecache_ptr);
918
919 last_alloc_attempt = target_size;
920 _allocated_sprite_cache_size = target_size;
921
922 do {
923 try {
924 /* Try to allocate 50% more to make sure we do not allocate almost all available. */
925 _spritecache_ptr = reinterpret_cast<MemBlock *>(new byte[_allocated_sprite_cache_size + _allocated_sprite_cache_size / 2]);
926 } catch (std::bad_alloc &) {
927 _spritecache_ptr = nullptr;
928 }
929
930 if (_spritecache_ptr != nullptr) {
931 /* Allocation succeeded, but we wanted less. */
932 delete[] reinterpret_cast<byte *>(_spritecache_ptr);
933 _spritecache_ptr = reinterpret_cast<MemBlock *>(new byte[_allocated_sprite_cache_size]);
934 } else if (_allocated_sprite_cache_size < 2 * 1024 * 1024) {
935 usererror("Cannot allocate spritecache");
936 } else {
937 /* Try again to allocate half. */
938 _allocated_sprite_cache_size >>= 1;
939 }
940 } while (_spritecache_ptr == nullptr);
941
942 if (_allocated_sprite_cache_size != target_size) {
943 DEBUG(misc, 0, "Not enough memory to allocate %d MiB of spritecache. Spritecache was reduced to %d MiB.", target_size / 1024 / 1024, _allocated_sprite_cache_size / 1024 / 1024);
944
945 ErrorMessageData msg(STR_CONFIG_ERROR_OUT_OF_MEMORY, STR_CONFIG_ERROR_SPRITECACHE_TOO_BIG);
946 msg.SetDParam(0, target_size);
947 msg.SetDParam(1, _allocated_sprite_cache_size);
948 ScheduleErrorMessage(msg);
949 }
950 }
951
952 /* A big free block */
953 _spritecache_ptr->size = (_allocated_sprite_cache_size - sizeof(MemBlock)) | S_FREE_MASK;
954 /* Sentinel block (identified by size == 0) */
955 NextBlock(_spritecache_ptr)->size = 0;
956 }
957
958 void GfxInitSpriteMem()
959 {
960 GfxInitSpriteCache();
961
962 /* Reset the spritecache 'pool' */
963 free(_spritecache);
964 _spritecache_items = 0;
965 _spritecache = nullptr;
966
967 _compact_cache_counter = 0;
968 }
969
974 void GfxClearSpriteCache()
975 {
976 /* Clear sprite ptr for all cached items */
977 for (uint i = 0; i != _spritecache_items; i++) {
978 SpriteCache *sc = GetSpriteCache(i);
979 if (sc->type != ST_RECOLOUR && sc->ptr != nullptr) DeleteEntryFromSpriteCache(i);
980 }
981
982 VideoDriver::GetInstance()->ClearSystemSprites();
983 }
984
985 /* static */ ReusableBuffer<SpriteLoader::CommonPixel> SpriteLoader::Sprite::buffer[ZOOM_LVL_COUNT];
SpriteLoader::CommonPixel::m
uint8 m
Remap-channel.
Definition: spriteloader.hpp:38
factory.hpp
ZOOM_LVL_OUT_2X
@ ZOOM_LVL_OUT_2X
Zoomed 2 times out.
Definition: zoom_type.h:25
FioReadBlock
void FioReadBlock(void *ptr, size_t size)
Read a block.
Definition: fileio.cpp:161
usererror
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:102
ST_FONT
@ ST_FONT
A sprite used for fonts.
Definition: gfx_type.h:304
ReusableBuffer< SpriteLoader::CommonPixel >
FioReadWord
uint16 FioReadWord()
Read a word (16 bits) from the file (in low endian format).
Definition: fileio.cpp:140
mem_func.hpp
Sprite::data
byte data[]
Sprite data.
Definition: spritecache.h:22
HandleInvalidSpriteRequest
static void * HandleInvalidSpriteRequest(SpriteID sprite, SpriteType requested, SpriteCache *sc, AllocatorProc *allocator)
Handles the case when a sprite of different type is requested than is present in the SpriteCache.
Definition: spritecache.cpp:829
SpriteLoader::Sprite::AllocateData
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Definition: spriteloader.hpp:61
ZOOM_LVL_END
@ ZOOM_LVL_END
End for iteration.
Definition: zoom_type.h:30
Blitter::GetScreenDepth
virtual uint8 GetScreenDepth()=0
Get the screen depth this blitter works for.
math_func.hpp
S_FREE_MASK
static const size_t S_FREE_MASK
S_FREE_MASK is used to mask-out lower bits of MemBlock::size If they are non-zero,...
Definition: spritecache.cpp:633
SpriteLoaderGrf::LoadSprite
uint8 LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)
Load a sprite from the disk and return a sprite struct which is the same for all loaders.
Definition: grf.cpp:330
ZOOM_LVL_COUNT
@ ZOOM_LVL_COUNT
Number of zoom levels.
Definition: zoom_type.h:32
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
ReadRecolourSprite
static void * ReadRecolourSprite(uint16 file_slot, uint num)
Load a recolour sprite into memory.
Definition: spritecache.cpp:384
Sprite::height
uint16 height
Height of the sprite.
Definition: spritecache.h:18
ReadGRFSpriteOffsets
void ReadGRFSpriteOffsets(byte container_version)
Parse the sprite section of GRFs.
Definition: spritecache.cpp:517
zoom_func.h
Sprite::x_offs
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:20
fileio_func.h
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
SpriteLoader::Sprite::buffer
static ReusableBuffer< SpriteLoader::CommonPixel > buffer[ZOOM_LVL_COUNT]
Allocated memory to pass sprite data around.
Definition: spriteloader.hpp:64
_palmap_w2d
const byte _palmap_w2d[]
Converting from the Windows palette to the DOS palette.
ST_NORMAL
@ ST_NORMAL
The most basic (normal) sprite.
Definition: gfx_type.h:302
SpriteEncoder::Encode
virtual Sprite * Encode(const SpriteLoader::Sprite *sprite, AllocatorProc *allocator)=0
Convert a sprite from the loader to our own format.
DeleteEntryFromSpriteCache
static void DeleteEntryFromSpriteCache(uint item)
Delete a single entry from the sprite cache.
Definition: spritecache.cpp:734
GetSpriteType
SpriteType GetSpriteType(SpriteID sprite)
Get the sprite type of a given sprite.
Definition: spritecache.cpp:132
VideoDriver::ClearSystemSprites
virtual void ClearSystemSprites()
Clear all cached sprites.
Definition: video_driver.hpp:100
MemCpyT
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
Definition: mem_func.hpp:23
grf.hpp
ZOOM_LVL_BEGIN
@ ZOOM_LVL_BEGIN
Begin for iteration.
Definition: zoom_type.h:23
FioReadDword
uint32 FioReadDword()
Read a double word (32 bits) from the file (in low endian format).
Definition: fileio.cpp:150
ST_INVALID
@ ST_INVALID
Pseudosprite or other unusable sprite, used only internally.
Definition: gfx_type.h:306
IsInsideMM
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:204
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
gfx_func.h
SpriteLoader::Sprite::data
SpriteLoader::CommonPixel * data
The sprite itself.
Definition: spriteloader.hpp:54
FioSkipBytes
void FioSkipBytes(int n)
Skip n bytes ahead in the file.
Definition: fileio.cpp:124
Align
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:35
SpriteCache::warned
bool warned
True iff the user has been warned about incorrect use of this sprite.
Definition: spritecache.cpp:38
MAX_SPRITES
@ MAX_SPRITES
Maximum number of sprites that can be loaded at a given time.
Definition: sprites.h:1543
SpriteLoader::Sprite::type
SpriteType type
The sprite type.
Definition: spriteloader.hpp:52
GfxClearSpriteCache
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information.
Definition: spritecache.cpp:974
SpriteEncoder::GetSpriteAlignment
virtual uint GetSpriteAlignment()
Get the value which the height and width on a sprite have to be aligned by.
Definition: spriteloader.hpp:101
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
SkipSpriteData
bool SkipSpriteData(byte type, uint16 num)
Skip the given amount of sprite graphics data.
Definition: spritecache.cpp:95
GetGRFSpriteOffset
size_t GetGRFSpriteOffset(uint32 id)
Get the file offset for a specific sprite in the sprite section of a GRF.
Definition: spritecache.cpp:508
SpriteLoader::CommonPixel
Definition of a common pixel in OpenTTD's realm.
Definition: spriteloader.hpp:33
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:140
safeguards.h
Sprite::width
uint16 width
Width of the sprite.
Definition: spritecache.h:19
_grf_sprite_offsets
static std::map< uint32, size_t > _grf_sprite_offsets
Map from sprite numbers to position in the GRF file.
Definition: spritecache.cpp:501
SpriteLoader::Sprite::x_offs
int16 x_offs
The x-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:50
SpriteLoaderGrf
Sprite loader for graphics coming from a (New)GRF.
Definition: grf.hpp:16
settings_type.h
ErrorMessageData
The data of the error message.
Definition: error.h:29
sprites.h
error.h
SpriteEncoder
Interface for something that can encode a sprite.
Definition: spriteloader.hpp:82
UnScaleByZoom
static int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL) When shifting right,...
Definition: zoom_func.h:34
stdafx.h
FioSeekTo
void FioSeekTo(size_t pos, int mode)
Seek in the current file.
Definition: fileio.cpp:79
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:187
SpriteLoader::Sprite::colours
SpriteColourComponent colours
The colour components of the sprite with useful information.
Definition: spriteloader.hpp:53
SpriteCache
Definition: spritecache.cpp:31
FioGetPos
size_t FioGetPos()
Get position in the current file.
Definition: fileio.cpp:59
LoadNextSprite
bool LoadNextSprite(int load_index, byte file_slot, uint file_sprite_id, byte container_version)
Load a real or recolour sprite.
Definition: spritecache.cpp:550
FioReadByte
byte FioReadByte()
Read a byte from the file.
Definition: fileio.cpp:107
palette_convert.h
SpriteEncoder::Is32BppSupported
virtual bool Is32BppSupported()=0
Can the sprite encoder make use of RGBA sprites?
SpriteLoader::Sprite::width
uint16 width
Width of the sprite.
Definition: spriteloader.hpp:49
ScaleByZoom
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right,...
Definition: zoom_func.h:22
GetRawSprite
void * GetRawSprite(SpriteID sprite, SpriteType type, AllocatorProc *allocator, SpriteEncoder *encoder)
Reads a sprite (from disk or sprite cache).
Definition: spritecache.cpp:874
video_driver.hpp
GetMaxSpriteID
uint GetMaxSpriteID()
Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no spr...
Definition: spritecache.cpp:187
CompactSpriteCache
static void CompactSpriteCache()
Called when holes in the sprite cache should be removed.
Definition: spritecache.cpp:690
SpriteCache::type
SpriteType type
In some cases a single sprite is misused by two NewGRFs. Once as real sprite and once as recolour spr...
Definition: spritecache.cpp:37
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:301
ScheduleErrorMessage
void ScheduleErrorMessage(const ErrorMessageData &data)
Schedule an error.
Definition: error_gui.cpp:447
GetSpriteLocalID
uint32 GetSpriteLocalID(SpriteID sprite)
Get the GRF-local sprite id of a given sprite.
Definition: spritecache.cpp:154
Sprite::y_offs
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:21
ReallocT
static T * ReallocT(T *t_ptr, size_t num_elements)
Simplified reallocation function that allocates the specified number of elements of the given type.
Definition: alloc_func.hpp:111
SpriteLoader::Sprite
Structure for passing information from the sprite loader to the blitter.
Definition: spriteloader.hpp:47
_palette_remap_grf
bool _palette_remap_grf[]
Whether the given NewGRFs must get a palette remap from windows to DOS or not.
Definition: gfxinit.cpp:30
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:131
ReadSprite
static void * ReadSprite(const SpriteCache *sc, SpriteID id, SpriteType sprite_type, AllocatorProc *allocator, SpriteEncoder *encoder)
Read a sprite from disk.
Definition: spritecache.cpp:420
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
SpriteCache::container_ver
byte container_ver
Container version of the GRF the sprite is from.
Definition: spritecache.cpp:39
MemSetT
static void MemSetT(T *ptr, byte value, size_t num=1)
Type-safe version of memset().
Definition: mem_func.hpp:49
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:24
ST_RECOLOUR
@ ST_RECOLOUR
Recolour sprite.
Definition: gfx_type.h:305
SpriteLoader::Sprite::y_offs
int16 y_offs
The y-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:51
SpriteLoader::Sprite::height
uint16 height
Height of the sprite.
Definition: spriteloader.hpp:48
GetOriginFileSlot
uint GetOriginFileSlot(SpriteID sprite)
Get the (FIOS) file slot of a given sprite.
Definition: spritecache.cpp:143
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:454
SimpleSpriteAlloc
void * SimpleSpriteAlloc(size_t size)
Sprite allocator simply using malloc.
Definition: spritecache.cpp:815
FIND_FIRST_BIT
#define FIND_FIRST_BIT(x)
Returns the first non-zero bit in a 6-bit value (from right).
Definition: bitmath_func.hpp:200
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
MemBlock
Definition: spritecache.cpp:76
ST_MAPGEN
@ ST_MAPGEN
Special sprite for the map generator.
Definition: gfx_type.h:303
_palmap_d2w
static const byte _palmap_d2w[]
Converting from the DOS palette to the Windows palette.
Definition: palette_convert.h:47
GetSpriteCountForSlot
uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end)
Count the sprites which originate from a specific file slot in a range of SpriteIDs.
Definition: spritecache.cpp:167
AllocaM
#define AllocaM(T, num_elements)
alloca() has to be called in the parent function, so define AllocaM() as a macro
Definition: alloc_func.hpp:132