| OpenTTD
    | 
Caching of sprites. More...
#include "stdafx.h"#include "fileio_func.h"#include "spriteloader/grf.hpp"#include "gfx_func.h"#include "error.h"#include "zoom_func.h"#include "settings_type.h"#include "blitter/factory.hpp"#include "core/math_func.hpp"#include "core/mem_func.hpp"#include "table/sprites.h"#include "table/strings.h"#include "table/palette_convert.h"#include "safeguards.h"Go to the source code of this file.
| Data Structures | |
| struct | SpriteCache | 
| struct | MemBlock | 
| Typedefs | |
| typedef SimpleTinyEnumT < SpriteType, byte > | SpriteTypeByte | 
| Functions | |
| static SpriteCache * | GetSpriteCache (uint index) | 
| static bool | IsMapgenSpriteID (SpriteID sprite) | 
| static SpriteCache * | AllocateSpriteCache (uint index) | 
| static void | CompactSpriteCache () | 
| Called when holes in the sprite cache should be removed. | |
| static void * | AllocSprite (size_t mem_req) | 
| bool | SkipSpriteData (byte type, uint16 num) | 
| Skip the given amount of sprite graphics data. | |
| bool | SpriteExists (SpriteID id) | 
| SpriteType | GetSpriteType (SpriteID sprite) | 
| Get the sprite type of a given sprite. | |
| uint | GetOriginFileSlot (SpriteID sprite) | 
| Get the (FIOS) file slot of a given sprite. | |
| uint | GetMaxSpriteID () | 
| Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no sprites with a higher SpriteID, although there might be up to roughly a thousand unused SpriteIDs below this number. | |
| static bool | ResizeSpriteIn (SpriteLoader::Sprite *sprite, ZoomLevel src, ZoomLevel tgt) | 
| static void | ResizeSpriteOut (SpriteLoader::Sprite *sprite, ZoomLevel zoom) | 
| static bool | PadSingleSprite (SpriteLoader::Sprite *sprite, ZoomLevel zoom, uint pad_left, uint pad_top, uint pad_right, uint pad_bottom) | 
| static bool | PadSprites (SpriteLoader::Sprite *sprite, uint8 sprite_avail) | 
| static bool | ResizeSprites (SpriteLoader::Sprite *sprite, uint8 sprite_avail, uint32 file_slot, uint32 file_pos) | 
| static void * | ReadRecolourSprite (uint16 file_slot, uint num) | 
| Load a recolour sprite into memory. | |
| static void * | ReadSprite (const SpriteCache *sc, SpriteID id, SpriteType sprite_type, AllocatorProc *allocator) | 
| Read a sprite from disk. | |
| size_t | GetGRFSpriteOffset (uint32 id) | 
| Get the file offset for a specific sprite in the sprite section of a GRF. | |
| void | ReadGRFSpriteOffsets (byte container_version) | 
| Parse the sprite section of GRFs. | |
| bool | LoadNextSprite (int load_index, byte file_slot, uint file_sprite_id, byte container_version) | 
| Load a real or recolour sprite. | |
| void | DupSprite (SpriteID old_spr, SpriteID new_spr) | 
| assert_compile (sizeof(MemBlock)==sizeof(size_t)) | |
| assert_compile ((sizeof(size_t)&(sizeof(size_t)-1))==0) | |
| static MemBlock * | NextBlock (MemBlock *block) | 
| static size_t | GetSpriteCacheUsage () | 
| void | IncreaseSpriteLRU () | 
| static void | DeleteEntryFromSpriteCache (uint item) | 
| Delete a single entry from the sprite cache. | |
| static void | DeleteEntryFromSpriteCache () | 
| 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. | |
| void * | GetRawSprite (SpriteID sprite, SpriteType type, AllocatorProc *allocator) | 
| Reads a sprite (from disk or sprite cache). | |
| static void | GfxInitSpriteCache () | 
| void | GfxInitSpriteMem () | 
| void | GfxClearSpriteCache () | 
| Remove all encoded sprites from the sprite cache without discarding sprite location information. | |
| Variables | |
| uint | _sprite_cache_size = 4 | 
| static uint | _spritecache_items = 0 | 
| static SpriteCache * | _spritecache = NULL | 
| static uint | _sprite_lru_counter | 
| static MemBlock * | _spritecache_ptr | 
| static uint | _allocated_sprite_cache_size = 0 | 
| static int | _compact_cache_counter | 
| static std::map< uint32, size_t > | _grf_sprite_offsets | 
| Map from sprite numbers to position in the GRF file. | |
| static const size_t | S_FREE_MASK = sizeof(size_t) - 1 | 
| S_FREE_MASK is used to mask-out lower bits of MemBlock::size If they are non-zero, the block is free. | |
Caching of sprites.
Definition in file spritecache.cpp.
| 
 | static | 
Called when holes in the sprite cache should be removed.
That is accomplished by moving the cached data.
Definition at line 649 of file spritecache.cpp.
References DEBUG.
| 
 | static | 
Delete a single entry from the sprite cache.
| item | Entry to delete. | 
Definition at line 693 of file spritecache.cpp.
References S_FREE_MASK.
Referenced by GfxClearSpriteCache().
| size_t GetGRFSpriteOffset | ( | uint32 | id | ) | 
Get the file offset for a specific sprite in the sprite section of a GRF.
| id | ID of the sprite to look up. | 
Definition at line 467 of file spritecache.cpp.
Referenced by LoadNextSprite().
| uint GetMaxSpriteID | ( | ) | 
Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no sprites with a higher SpriteID, although there might be up to roughly a thousand unused SpriteIDs below this number.
Definition at line 160 of file spritecache.cpp.
Referenced by SpriteAlignerWindow::OnClick(), SpriteAlignerWindow::OnQueryTextFinished(), and UpdateCursorSize().
| uint GetOriginFileSlot | ( | SpriteID | sprite | ) | 
Get the (FIOS) file slot of a given sprite.
| sprite | The sprite to look at. | 
Definition at line 146 of file spritecache.cpp.
Referenced by SpriteAlignerWindow::SetStringParameters().
| void* GetRawSprite | ( | SpriteID | sprite, | 
| SpriteType | type, | ||
| AllocatorProc * | allocator | ||
| ) | 
Reads a sprite (from disk or sprite cache).
If the sprite is not available or of wrong type, a fallback sprite is returned.
| sprite | Sprite to read. | 
| type | Expected sprite type. | 
| allocator | Allocator function to use. Set to NULL to use the usual sprite cache. | 
Definition at line 824 of file spritecache.cpp.
References DEBUG, HandleInvalidSpriteRequest(), ReadSprite(), ST_INVALID, ST_MAPGEN, and SpriteCache::type.
Referenced by HandleInvalidSpriteRequest(), and ReadSprite().
| SpriteType GetSpriteType | ( | SpriteID | sprite | ) | 
Get the sprite type of a given sprite.
| sprite | The sprite to look at. | 
Definition at line 135 of file spritecache.cpp.
References ST_INVALID, and SpriteCache::type.
Referenced by SpriteAlignerWindow::OnClick(), and SpriteAlignerWindow::OnQueryTextFinished().
| 
 | static | 
Handles the case when a sprite of different type is requested than is present in the SpriteCache.
For ST_FONT sprites, it is normal. In other cases, default sprite is loaded instead.
| sprite | ID of loaded sprite | 
| requested | requested sprite type | 
| sc | the currently known sprite cache for the requested sprite | 
Definition at line 780 of file spritecache.cpp.
References DEBUG, GetRawSprite(), ST_FONT, ST_MAPGEN, ST_NORMAL, ST_RECOLOUR, SpriteCache::type, usererror(), and SpriteCache::warned.
Referenced by GetRawSprite().
| bool LoadNextSprite | ( | int | load_index, | 
| byte | file_slot, | ||
| uint | file_sprite_id, | ||
| byte | container_version | ||
| ) | 
Load a real or recolour sprite.
| load_index | Global sprite index. | 
| file_slot | GRF to load from. | 
| file_sprite_id | Sprite number in the GRF. | 
| container_version | Container version of the GRF. | 
Definition at line 509 of file spritecache.cpp.
References SpriteCache::container_ver, FioGetPos(), FioReadByte(), FioReadDword(), FioReadWord(), FioSkipBytes(), GetGRFSpriteOffset(), MAX_SPRITES, ReadRecolourSprite(), SkipSpriteData(), ST_INVALID, ST_MAPGEN, ST_NORMAL, ST_RECOLOUR, SpriteCache::type, usererror(), and SpriteCache::warned.
Referenced by LoadFontGlyph(), LoadGrfFile(), and LoadGrfFileIndexed().
| void ReadGRFSpriteOffsets | ( | byte | container_version | ) | 
Parse the sprite section of GRFs.
| container_version | Container version of the GRF we're currently processing. | 
Definition at line 476 of file spritecache.cpp.
References FioGetPos(), FioReadDword(), FioSeekTo(), and FioSkipBytes().
Referenced by LoadGrfFile(), LoadGrfFileIndexed(), and LoadNewGRFFile().
| 
 | static | 
Load a recolour sprite into memory.
| file_slot | GRF we're reading from. | 
| num | Size of the sprite in the GRF. | 
Definition at line 348 of file spritecache.cpp.
References _palette_remap_grf, _palmap_d2w, AllocaM, FioReadBlock(), and max().
Referenced by LoadNextSprite().
| 
 | static | 
Read a sprite from disk.
| sc | Location of sprite. | 
| id | Sprite number. | 
| sprite_type | Type of sprite. | 
| allocator | Allocator function to use. | 
Definition at line 383 of file spritecache.cpp.
References SpriteCache::container_ver, Sprite::data, SpriteLoader::Sprite::data, DEBUG, Blitter::Encode(), BlitterFactory::GetCurrentBlitter(), GetRawSprite(), Sprite::height, SpriteLoader::Sprite::height, SpriteLoaderGrf::LoadSprite(), SpriteLoader::CommonPixel::m, ST_FONT, ST_MAPGEN, ST_NORMAL, ST_RECOLOUR, SpriteCache::type, SpriteLoader::Sprite::type, usererror(), Sprite::width, SpriteLoader::Sprite::width, Sprite::x_offs, SpriteLoader::Sprite::x_offs, Sprite::y_offs, SpriteLoader::Sprite::y_offs, ZOOM_LVL_COUNT, and ZOOM_LVL_NORMAL.
Referenced by GetRawSprite().
| bool SkipSpriteData | ( | byte | type, | 
| uint16 | num | ||
| ) | 
Skip the given amount of sprite graphics data.
| type | the type of sprite (compressed etc) | 
| num | the amount of sprites to skip | 
Definition at line 98 of file spritecache.cpp.
References FioReadByte(), and FioSkipBytes().
Referenced by LoadNewGRFFile(), and LoadNextSprite().
| 
 | static | 
Map from sprite numbers to position in the GRF file.
Definition at line 460 of file spritecache.cpp.
| 
 | static | 
S_FREE_MASK is used to mask-out lower bits of MemBlock::size If they are non-zero, the block is free.
S_FREE_MASK has to ensure MemBlock is correctly aligned - it means 8B (S_FREE_MASK == 7) on 64bit systems!
Definition at line 592 of file spritecache.cpp.
Referenced by DeleteEntryFromSpriteCache().
 1.8.1.2
 1.8.1.2