OpenTTD Source: SpriteEncoder Class Reference

OpenTTD Source 15.0-beta1

Public Member Functions
SpriteEncoder Class Referenceabstract

Interface for something that can encode a sprite. More...

`#include <spriteloader.hpp>`

Inheritance diagram for SpriteEncoder:

## Public Member Functions
virtual bool | Is32BppSupported ()=0
| Can the sprite encoder make use of RGBA sprites?
virtual Sprite * | Encode (const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator)=0
| Convert a sprite from the loader to our own format.
virtual uint | GetSpriteAlignment ()
| Get the value which the height and width on a sprite have to be aligned by.

## Detailed Description

Interface for something that can encode a sprite.

Definition at line 114 of file spriteloader.hpp.

## Member Function Documentation

## ◆ Encode()

virtual Sprite * SpriteEncoder::Encode | ( | const SpriteLoader::SpriteCollection & | sprite,
|  | SpriteAllocator & | allocator
| ) |  |
| pure virtual

Convert a sprite from the loader to our own format.

Implemented in Blitter_32bppOptimized, Blitter_32bppSimple, Blitter_40bppAnim, Blitter_8bppOptimized, Blitter_8bppSimple, Blitter_Null, and OpenGLBackend.

Referenced by ReadSprite().

## ◆ GetSpriteAlignment()

virtual uint SpriteEncoder::GetSpriteAlignment | ( |  | ) |
| inlinevirtual

Get the value which the height and width on a sprite have to be aligned by.

Returns
  The needed alignment or 0 if any alignment is accepted.

Reimplemented in OpenGLBackend.

Definition at line 133 of file spriteloader.hpp.

## ◆ Is32BppSupported()

virtual bool SpriteEncoder::Is32BppSupported | ( |  | ) |
| pure virtual

Can the sprite encoder make use of RGBA sprites?

Implemented in Blitter, and OpenGLBackend.

Referenced by ReadSprite().

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

- src/spriteloader/spriteloader.hpp