OpenTTD

spriteloader.hpp
Go to the documentation of this file.
1 /* $Id: spriteloader.hpp 23897 2012-02-04 22:18:57Z michi_cc $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef SPRITELOADER_HPP
13 #define SPRITELOADER_HPP
14
15 #include "../core/alloc_type.hpp"
16 #include "../gfx_type.h"
17
19 class SpriteLoader {
20 public:
22 struct CommonPixel {
23 uint8 r;
24 uint8 g;
25 uint8 b;
26 uint8 a;
27 uint8 m;
28 };
29
36 struct Sprite {
37 uint16 height;
38 uint16 width;
39 int16 x_offs;
40 int16 y_offs;
41 SpriteType type;
42 SpriteLoader::CommonPixel *data;
43
49 void AllocateData(ZoomLevel zoom, size_t size) { this->data = Sprite::buffer[zoom].ZeroAllocate(size); }
50 private:
52 static ReusableBuffer<SpriteLoader::CommonPixel> buffer[ZOOM_LVL_COUNT];
53 };
54
64 virtual uint8 LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp) = 0;
65
66 virtual ~SpriteLoader() { }
67 };
68
69 #endif /* SPRITELOADER_HPP */
SpriteLoader::CommonPixel::a
uint8 a
Alpha-channel.
Definition: spriteloader.hpp:26
SpriteLoader::Sprite::buffer
static ReusableBuffer< SpriteLoader::CommonPixel > buffer[ZOOM_LVL_COUNT]
Allocated memory to pass sprite data around.
Definition: spriteloader.hpp:52
SpriteLoader::LoadSprite
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.
ReusableBuffer::ZeroAllocate
T * ZeroAllocate(size_t count)
Get buffer of at least count times T with zeroed memory.
Definition: alloc_type.hpp:124
SpriteLoader::Sprite::AllocateData
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Definition: spriteloader.hpp:49
SpriteLoader::CommonPixel
Definition of a common pixel in OpenTTD&#39;s realm.
Definition: spriteloader.hpp:22
SpriteLoader::Sprite::type
SpriteType type
The sprite type.
Definition: spriteloader.hpp:41
SpriteLoader::CommonPixel::b
uint8 b
Blue-channel.
Definition: spriteloader.hpp:25
ZOOM_LVL_COUNT
Number of zoom levels.
Definition: zoom_type.h:32
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:297
SpriteLoader::Sprite::x_offs
int16 x_offs
The x-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:39
SpriteLoader::Sprite::data
SpriteLoader::CommonPixel * data
The sprite itself.
Definition: spriteloader.hpp:42
ReusableBuffer< SpriteLoader::CommonPixel >
SpriteLoader::Sprite
Structure for passing information from the sprite loader to the blitter.
Definition: spriteloader.hpp:36
SpriteLoader::CommonPixel::m
uint8 m
Remap-channel.
Definition: spriteloader.hpp:27
SpriteLoader::Sprite::width
uint16 width
Width of the sprite.
Definition: spriteloader.hpp:38
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
SpriteLoader::Sprite::height
uint16 height
Height of the sprite.
Definition: spriteloader.hpp:37
SpriteLoader::Sprite::y_offs
int16 y_offs
The y-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:40
SpriteLoader
Interface for the loader of our sprites.
Definition: spriteloader.hpp:19
SpriteLoader::CommonPixel::r
uint8 r
Red-channel.
Definition: spriteloader.hpp:23
SpriteLoader::CommonPixel::g
uint8 g
Green-channel.
Definition: spriteloader.hpp:24