OpenTTD Source: SpriteLoader Class Reference

OpenTTD Source 13.2.1

Data Structures | Public Member Functions
SpriteLoader Class Referenceabstract

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

`#include <spriteloader.hpp>`

Inheritance diagram for SpriteLoader:

## 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, SpriteFile &file, size_t file_pos, SpriteType sprite_type, bool load_32bpp, byte control_flags)=0
| Load a sprite from the disk and return a sprite struct which is the same for all loaders. More...

## Detailed Description

Interface for the loader of our sprites.

Definition at line 31 of file spriteloader.hpp.

## Member Function Documentation

## ◆ LoadSprite()

virtual uint8 SpriteLoader::LoadSprite | ( | SpriteLoader::Sprite * | sprite,
|  | SpriteFile & | file,
|  | size_t | file_pos,
|  | SpriteType | sprite_type,
|  | bool | load_32bpp,
|  | byte | control_flags
| ) |  |
| pure virtual

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

Parameters

  [out] | sprite | The sprites to fill with data.
  | file_slot | The file "descriptor" of the file we read from.
  | file_pos | The position within the file the image begins.
  | sprite_type | The type of sprite we're trying to load.
  | load_32bpp | True if 32bpp sprites should be loaded, false for a 8bpp sprite.
  | control_flags | Control flags, see SpriteCacheCtrlFlags.

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:

- src/spriteloader/spriteloader.hpp