OpenTTD
spritecache.h
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 #ifndef SPRITECACHE_H
11 #define SPRITECACHE_H
12 
13 #include "gfx_type.h"
14 
16 struct Sprite {
17  uint16 height;
18  uint16 width;
19  int16 x_offs;
20  int16 y_offs;
21  byte 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 
32 uint GetOriginFileSlot(SpriteID sprite);
33 uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end);
34 uint GetMaxSpriteID();
35 
36 
37 static inline const Sprite *GetSprite(SpriteID sprite, SpriteType type)
38 {
39  assert(type != ST_RECOLOUR);
40  return (Sprite*)GetRawSprite(sprite, type);
41 }
42 
43 static inline const byte *GetNonSprite(SpriteID sprite, SpriteType type)
44 {
45  assert(type == ST_RECOLOUR);
46  return (byte*)GetRawSprite(sprite, type);
47 }
48 
49 void GfxInitSpriteMem();
50 void GfxClearSpriteCache();
51 void IncreaseSpriteLRU();
52 
53 void ReadGRFSpriteOffsets(byte container_version);
54 size_t GetGRFSpriteOffset(uint32 id);
55 bool LoadNextSprite(int load_index, byte file_index, uint file_sprite_id, byte container_version);
56 bool SkipSpriteData(byte type, uint16 num);
57 void DupSprite(SpriteID old_spr, SpriteID new_spr);
58 
59 #endif /* SPRITECACHE_H */
SpriteType GetSpriteType(SpriteID sprite)
Get the sprite type of a given sprite.
void * GetRawSprite(SpriteID sprite, SpriteType type, AllocatorProc *allocator=nullptr)
Reads a sprite (from disk or sprite cache).
uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end)
Count the sprites which originate from a specific file slot in a range of SpriteIDs.
Data structure describing a sprite.
Definition: spritecache.h:16
uint GetMaxSpriteID()
Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no spr...
bool LoadNextSprite(int load_index, byte file_index, uint file_sprite_id, byte container_version)
Load a real or recolour sprite.
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:20
void ReadGRFSpriteOffsets(byte container_version)
Parse the sprite section of GRFs.
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information...
byte data[]
Sprite data.
Definition: spritecache.h:21
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:296
size_t GetGRFSpriteOffset(uint32 id)
Get the file offset for a specific sprite in the sprite section of a GRF.
uint16 height
Height of the sprite.
Definition: spritecache.h:17
uint16 width
Width of the sprite.
Definition: spritecache.h:18
Recolour sprite.
Definition: gfx_type.h:300
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:19
uint GetOriginFileSlot(SpriteID sprite)
Get the (FIOS) file slot of a given sprite.
bool SkipSpriteData(byte type, uint16 num)
Skip the given amount of sprite graphics data.
Definition: spritecache.cpp:94
Types related to the graphics and/or input devices.