src/spritecache.h

   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
   8 /** @file spritecache.h Functions to cache sprites in memory. */
   9
  10 #ifndef SPRITECACHE_H
  11 #define SPRITECACHE_H
  12
  13 #include "gfx_type.h"
  14
  15 /** Data structure describing a sprite. */
  16 struct Sprite {
  17         uint16 height; ///< Height of the sprite.
  18         uint16 width;  ///< Width of the sprite.
  19         int16 x_offs;  ///< Number of pixels to shift the sprite to the right.
  20         int16 y_offs;  ///< Number of pixels to shift the sprite downwards.
  21         byte data[];   ///< Sprite data.
  22 };
  23
  24 extern uint _sprite_cache_size;
  25
  26 typedef void *AllocatorProc(size_t size);
  27
  28 void *GetRawSprite(SpriteID sprite, SpriteType type, AllocatorProc *allocator = nullptr);
  29 bool SpriteExists(SpriteID sprite);
  30
  31 SpriteType GetSpriteType(SpriteID sprite);
  32 uint GetOriginFileSlot(SpriteID sprite);
  33 uint32 GetSpriteLocalID(SpriteID sprite);
  34 uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end);
  35 uint GetMaxSpriteID();
  36
  37
  38 static inline const Sprite *GetSprite(SpriteID sprite, SpriteType type)
  39 {
  40         assert(type != ST_RECOLOUR);
  41         return (Sprite*)GetRawSprite(sprite, type);
  42 }
  43
  44 static inline const byte *GetNonSprite(SpriteID sprite, SpriteType type)
  45 {
  46         assert(type == ST_RECOLOUR);
  47         return (byte*)GetRawSprite(sprite, type);
  48 }
  49
  50 void GfxInitSpriteMem();
  51 void GfxClearSpriteCache();
  52 void IncreaseSpriteLRU();
  53
  54 void ReadGRFSpriteOffsets(byte container_version);
  55 size_t GetGRFSpriteOffset(uint32 id);
  56 bool LoadNextSprite(int load_index, byte file_index, uint file_sprite_id, byte container_version);
  57 bool SkipSpriteData(byte type, uint16 num);
  58 void DupSprite(SpriteID old_spr, SpriteID new_spr);
  59
  60 #endif /* SPRITECACHE_H */