* 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/>.

 */

/** @file spritecache.h Functions to cache sprites in memory. */

#ifndef SPRITECACHE_H

#define SPRITECACHE_H

#include "gfx_type.h"

#include "spriteloader/spriteloader.hpp"

/** Data structure describing a sprite. */

struct Sprite {

	uint16 height; ///< Height of the sprite.

	uint16 width;  ///< Width of the sprite.

	int16 x_offs;  ///< Number of pixels to shift the sprite to the right.

	int16 y_offs;  ///< Number of pixels to shift the sprite downwards.

	byte data[];   ///< Sprite data.

};

extern uint _sprite_cache_size;

typedef void *AllocatorProc(size_t size);

void *GetRawSprite(SpriteID sprite, SpriteType type, AllocatorProc *allocator = nullptr, SpriteEncoder *encoder = nullptr);

bool SpriteExists(SpriteID sprite);

SpriteType GetSpriteType(SpriteID sprite);

uint GetOriginFileSlot(SpriteID sprite);

uint32 GetSpriteLocalID(SpriteID sprite);

uint GetSpriteCountForSlot(uint file_slot, SpriteID begin, SpriteID end);

uint GetMaxSpriteID();

static inline const Sprite *GetSprite(SpriteID sprite, SpriteType type)

{

	assert(type != ST_RECOLOUR);

	return (Sprite*)GetRawSprite(sprite, type);

}

static inline const byte *GetNonSprite(SpriteID sprite, SpriteType type)

{

	assert(type == ST_RECOLOUR);

	return (byte*)GetRawSprite(sprite, type);

}

void GfxInitSpriteMem();

void GfxClearSpriteCache();