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;
43 
49  void AllocateData(ZoomLevel zoom, size_t size) { this->data = Sprite::buffer[zoom].ZeroAllocate(size); }
50  private:
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 */
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:124
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Definition of a common pixel in OpenTTD&#39;s realm.
SpriteType type
The sprite type.
uint8 b
Blue-channel.
Number of zoom levels.
Definition: zoom_type.h:32
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:297
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.
uint8 m
Remap-channel.
uint16 width
Width of the sprite.
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
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.
uint8 g
Green-channel.