OpenTTD
spritecache.h
Go to the documentation of this file.
1 /* $Id: spritecache.h 23887 2012-02-04 13:29:04Z michi_cc $ */
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 
12 #ifndef SPRITECACHE_H
13 #define SPRITECACHE_H
14 
15 #include "gfx_type.h"
16 
18 struct Sprite {
19  uint16 height;
20  uint16 width;
21  int16 x_offs;
22  int16 y_offs;
23  byte 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 = NULL);
31 bool SpriteExists(SpriteID sprite);
32 
34 uint GetOriginFileSlot(SpriteID sprite);
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 */