OpenTTD
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 "../gfx_type.h"
15 
17 class SpriteLoader {
18 public:
20  struct CommonPixel {
21  uint8 r;
22  uint8 g;
23  uint8 b;
24  uint8 a;
25  uint8 m;
26  };
27 
34  struct Sprite {
35  uint16 height;
36  uint16 width;
37  int16 x_offs;
38  int16 y_offs;
41 
47  void AllocateData(ZoomLevel zoom, size_t size) { this->data = Sprite::buffer[zoom].ZeroAllocate(size); }
48  private:
51  };
52 
62  virtual uint8 LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp) = 0;
63 
64  virtual ~SpriteLoader() { }
65 };
66 
67 #endif /* SPRITELOADER_HPP */
uint8 a
Alpha-channel.
static ReusableBuffer< SpriteLoader::CommonPixel > buffer[ZOOM_LVL_COUNT]
Allocated memory to pass sprite data around.
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.
T * ZeroAllocate(size_t count)
Get buffer of at least count times T with zeroed memory.
Definition: alloc_type.hpp:59
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Number of zoom levels.
Definition: zoom_type.h:30
Definition of a common pixel in OpenTTD&#39;s realm.
SpriteType type
The sprite type.
uint8 b
Blue-channel.
int16 x_offs
The x-offset of where the sprite will be drawn.
SpriteLoader::CommonPixel * data
The sprite itself.
Structure for passing information from the sprite loader to the blitter.
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:296
uint8 m
Remap-channel.
uint16 width
Width of the sprite.
uint16 height
Height of the sprite.
int16 y_offs
The y-offset of where the sprite will be drawn.
Interface for the loader of our sprites.
uint8 r
Red-channel.
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:19
uint8 g
Green-channel.