OpenTTD
Data Structures | Public Member Functions
SpriteLoader Class Reference

Interface for the loader of our sprites. More...

#include <spriteloader.hpp>

Inheritance diagram for SpriteLoader:
SpriteLoaderGrf

Data Structures

struct  CommonPixel
 Definition of a common pixel in OpenTTD's realm. More...
struct  Sprite
 Structure for passing information from the sprite loader to the blitter. More...

Public Member Functions

virtual uint8 LoadSprite (SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)=0
 Load a sprite from the disk and return a sprite struct which is the same for all loaders.

Detailed Description

Interface for the loader of our sprites.

Definition at line 19 of file spriteloader.hpp.

Member Function Documentation

virtual uint8 SpriteLoader::LoadSprite ( SpriteLoader::Sprite sprite,
uint8  file_slot,
size_t  file_pos,
SpriteType  sprite_type,
bool  load_32bpp 
)
pure virtual

Load a sprite from the disk and return a sprite struct which is the same for all loaders.

Parameters
[out]spriteThe sprites to fill with data.
file_slotThe file "descriptor" of the file we read from.
file_posThe position within the file the image begins.
sprite_typeThe type of sprite we're trying to load.
load_32bppTrue if 32bpp sprites should be loaded, false for a 8bpp sprite.
Returns
Bit mask of the zoom levels successfully loaded or 0 if no sprite could be loaded.

Implemented in SpriteLoaderGrf.


The documentation for this class was generated from the following file: