OpenTTD Source 20250205-master-gfd85ab1e2c
Public Member Functions | Private Attributes
SpriteLoaderMakeIndexed Class Reference

Sprite loader for converting graphics coming from another source. More...

#include <makeindexed.h>

Inheritance diagram for SpriteLoaderMakeIndexed:
SpriteLoader

Public Member Functions

 SpriteLoaderMakeIndexed (SpriteLoader &baseloader)
 
uint8_t LoadSprite (SpriteLoader::SpriteCollection &sprite, SpriteFile &file, size_t file_pos, SpriteType sprite_type, bool load_32bpp, uint8_t control_flags, uint8_t &avail_8bpp, uint8_t &avail_32bpp) override
 Load a sprite from the disk and return a sprite struct which is the same for all loaders.
 

Private Attributes

SpriteLoader & baseloader
 

Additional Inherited Members

- Public Types inherited from SpriteLoader
using SpriteCollection = std::array< Sprite, ZOOM_LVL_END >
 Type defining a collection of sprites, one for each zoom level.
 

Detailed Description

Sprite loader for converting graphics coming from another source.

Definition at line 16 of file makeindexed.h.

Constructor & Destructor Documentation

◆ SpriteLoaderMakeIndexed()

SpriteLoaderMakeIndexed::SpriteLoaderMakeIndexed ( SpriteLoader &  baseloader)
inline

Definition at line 19 of file makeindexed.h.

Member Function Documentation

◆ LoadSprite()

uint8_t SpriteLoaderMakeIndexed::LoadSprite ( SpriteLoader::SpriteCollection &  sprite,
SpriteFile &  file,
size_t  file_pos,
SpriteType  sprite_type,
bool  load_32bpp,
uint8_t  control_flags,
uint8_t &  avail_8bpp,
uint8_t &  avail_32bpp 
)
overridevirtual

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.
control_flagsControl flags, see SpriteCacheCtrlFlags.
Returns
Bit mask of the zoom levels successfully loaded or 0 if no sprite could be loaded.

Implements SpriteLoader.

Definition at line 51 of file makeindexed.cpp.

References Convert32bppTo8bpp(), HasBit(), SpriteLoader::LoadSprite(), ZOOM_LVL_BEGIN, and ZOOM_LVL_END.

Referenced by ReadSprite().

Field Documentation

◆ baseloader

SpriteLoader& SpriteLoaderMakeIndexed::baseloader
private

Definition at line 17 of file makeindexed.h.

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