OpenTTD Source  14.0-beta1
spriteloader.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * 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/>.
6  */
7 
10 #ifndef SPRITELOADER_HPP
11 #define SPRITELOADER_HPP
12 
13 #include "../core/alloc_type.hpp"
14 #include "../core/enum_type.hpp"
15 #include "../gfx_type.h"
16 #include "sprite_file_type.hpp"
17 
18 struct Sprite;
19 typedef void *AllocatorProc(size_t size);
20 
22 enum SpriteColourComponent {
23  SCC_RGB = 1 << 0,
24  SCC_ALPHA = 1 << 1,
25  SCC_PAL = 1 << 2,
26  SCC_MASK = SCC_RGB | SCC_ALPHA | SCC_PAL,
27 };
28 DECLARE_ENUM_AS_BIT_SET(SpriteColourComponent)
29 
30 
31 class SpriteLoader {
32 public:
34  struct CommonPixel {
35  uint8_t r;
36  uint8_t g;
37  uint8_t b;
38  uint8_t a;
39  uint8_t m;
40  };
41 
48  struct Sprite {
49  uint16_t height;
50  uint16_t width;
51  int16_t x_offs;
52  int16_t y_offs;
53  SpriteType type;
54  SpriteColourComponent colours;
55  SpriteLoader::CommonPixel *data;
56 
62  void AllocateData(ZoomLevel zoom, size_t size) { this->data = Sprite::buffer[zoom].ZeroAllocate(size); }
63  private:
65  static ReusableBuffer<SpriteLoader::CommonPixel> buffer[ZOOM_LVL_END];
66  };
67 
71  using SpriteCollection = std::array<Sprite, ZOOM_LVL_END>;
72 
83  virtual uint8_t LoadSprite(SpriteLoader::SpriteCollection &sprite, SpriteFile &file, size_t file_pos, SpriteType sprite_type, bool load_32bpp, byte control_flags) = 0;
84 
85  virtual ~SpriteLoader() = default;
86 };
87 
89 class SpriteEncoder {
90 public:
91 
92  virtual ~SpriteEncoder() = default;
93 
97  virtual bool Is32BppSupported() = 0;
98 
102  virtual Sprite *Encode(const SpriteLoader::SpriteCollection &sprite, AllocatorProc *allocator) = 0;
103 
108  virtual uint GetSpriteAlignment()
109  {
110  return 0;
111  }
112 };
113 #endif /* SPRITELOADER_HPP */
Sprite::height
uint16_t height
Height of the sprite.
Definition: spritecache.h:18
SCC_PAL
@ SCC_PAL
Sprite has palette data.
Definition: spriteloader.hpp:25
SpriteLoader::Sprite::x_offs
int16_t x_offs
The x-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:51
ReusableBuffer< SpriteLoader::CommonPixel >
SpriteLoader::Sprite::AllocateData
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Definition: spriteloader.hpp:62
ZOOM_LVL_END
@ ZOOM_LVL_END
End for iteration.
Definition: zoom_type.h:28
SpriteLoader
Interface for the loader of our sprites.
Definition: spriteloader.hpp:31
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:19
SpriteLoader::SpriteCollection
std::array< Sprite, ZOOM_LVL_END > SpriteCollection
Type defining a collection of sprites, one for each zoom level.
Definition: spriteloader.hpp:71
SpriteLoader::Sprite::data
SpriteLoader::CommonPixel * data
The sprite itself.
Definition: spriteloader.hpp:55
SpriteLoader::Sprite::type
SpriteType type
The sprite type.
Definition: spriteloader.hpp:53
SpriteEncoder::GetSpriteAlignment
virtual uint GetSpriteAlignment()
Get the value which the height and width on a sprite have to be aligned by.
Definition: spriteloader.hpp:108
SpriteLoader::CommonPixel
Definition of a common pixel in OpenTTD's realm.
Definition: spriteloader.hpp:34
Sprite::width
uint16_t width
Width of the sprite.
Definition: spritecache.h:19
sprite_file_type.hpp
SpriteLoader::CommonPixel::m
uint8_t m
Remap-channel.
Definition: spriteloader.hpp:39
SpriteEncoder
Interface for something that can encode a sprite.
Definition: spriteloader.hpp:89
SpriteLoader::CommonPixel::b
uint8_t b
Blue-channel.
Definition: spriteloader.hpp:37
SpriteLoader::Sprite::colours
SpriteColourComponent colours
The colour components of the sprite with useful information.
Definition: spriteloader.hpp:54
SpriteLoader::Sprite::y_offs
int16_t y_offs
The y-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:52
SpriteFile
RandomAccessFile with some extra information specific for sprite files.
Definition: sprite_file_type.hpp:19
SCC_RGB
@ SCC_RGB
Sprite has RGB.
Definition: spriteloader.hpp:23
SpriteEncoder::Is32BppSupported
virtual bool Is32BppSupported()=0
Can the sprite encoder make use of RGBA sprites?
SCC_MASK
@ SCC_MASK
Mask of valid colour bits.
Definition: spriteloader.hpp:26
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:307
SCC_ALPHA
@ SCC_ALPHA
Sprite has alpha.
Definition: spriteloader.hpp:24
SpriteLoader::Sprite
Structure for passing information from the sprite loader to the blitter.
Definition: spriteloader.hpp:48
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
SpriteLoader::CommonPixel::g
uint8_t g
Green-channel.
Definition: spriteloader.hpp:36
SpriteLoader::CommonPixel::r
uint8_t r
Red-channel.
Definition: spriteloader.hpp:35
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
SpriteLoader::CommonPixel::a
uint8_t a
Alpha-channel.
Definition: spriteloader.hpp:38
SpriteColourComponent
SpriteColourComponent
The different colour components a sprite can have.
Definition: spriteloader.hpp:22
SpriteEncoder::Encode
virtual Sprite * Encode(const SpriteLoader::SpriteCollection &sprite, AllocatorProc *allocator)=0
Convert a sprite from the loader to our own format.