src/spritecache.h

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