OpenTTD Source  20240919-master-gdf0233f4c2
8bpp_optimized.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 BLITTER_8BPP_OPTIMIZED_HPP
11 #define BLITTER_8BPP_OPTIMIZED_HPP
12 
13 #include "8bpp_base.hpp"
14 #include "factory.hpp"
15 
18 public:
20  struct SpriteData {
21  uint32_t offset[ZOOM_LVL_END];
22  uint8_t data[];
23  };
24 
25  void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) override;
26  Sprite *Encode(const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override;
27 
28  std::string_view GetName() override { return "8bpp-optimized"; }
29 };
30 
33 public:
34  FBlitter_8bppOptimized() : BlitterFactory("8bpp-optimized", "8bpp Optimized Blitter (compression + all-ZoomLevel cache)") {}
35  Blitter *CreateInstance() override { return new Blitter_8bppOptimized(); }
36 };
37 
38 #endif /* BLITTER_8BPP_OPTIMIZED_HPP */
factory.hpp
Blitter_8bppOptimized::SpriteData
Data stored about a (single) sprite.
Definition: 8bpp_optimized.hpp:20
BlitterMode
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:17
Blitter
How all blitters should look like.
Definition: base.hpp:29
ZOOM_LVL_END
@ ZOOM_LVL_END
End for iteration.
Definition: zoom_type.h:25
BlitterFactory
The base factory, keeping track of all blitters.
Definition: factory.hpp:21
Blitter_8bppOptimized::Draw
void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) override
Draw an image to the screen, given an amount of params defined above.
Definition: 8bpp_optimized.cpp:22
Blitter_8bppOptimized
8bpp blitter optimised for speed.
Definition: 8bpp_optimized.hpp:17
SpriteAllocator
Interface for something that can allocate memory for a sprite.
Definition: spriteloader.hpp:88
SpriteLoader::SpriteCollection
std::array< Sprite, ZOOM_LVL_END > SpriteCollection
Type defining a collection of sprites, one for each zoom level.
Definition: spriteloader.hpp:70
FBlitter_8bppOptimized
Factory for the 8bpp blitter optimised for speed.
Definition: 8bpp_optimized.hpp:32
Blitter_8bppBase
Base for all 8bpp blitters.
Definition: 8bpp_base.hpp:16
Blitter_8bppOptimized::Encode
Sprite * Encode(const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override
Convert a sprite from the loader to our own format.
Definition: 8bpp_optimized.cpp:123
BlitterFactory::BlitterFactory
BlitterFactory(const char *name, const char *description, bool usable=true)
Construct the blitter, and register it.
Definition: factory.hpp:58
FBlitter_8bppOptimized::CreateInstance
Blitter * CreateInstance() override
Create an instance of this Blitter-class.
Definition: 8bpp_optimized.hpp:35
Blitter_8bppOptimized::GetName
std::string_view GetName() override
Get the name of the blitter, the same as the Factory-instance returns.
Definition: 8bpp_optimized.hpp:28
Blitter_8bppOptimized::SpriteData::offset
uint32_t offset[ZOOM_LVL_END]
Offsets (from .data) to streams for different zoom levels.
Definition: 8bpp_optimized.hpp:21
Blitter::BlitterParams
Parameters related to blitting.
Definition: base.hpp:32
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:16
Blitter_8bppOptimized::SpriteData::data
uint8_t data[]
Data, all zoomlevels.
Definition: 8bpp_optimized.hpp:22
8bpp_base.hpp