OpenTTD Source: src/blitter/null.hpp Source File

OpenTTD Source 15.3

null.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef BLITTER_NULL_HPP
11#define BLITTER_NULL_HPP
12
13#include "factory.hpp"
14
16 class Blitter_Null : public Blitter {
17public:
18 uint8_t GetScreenDepth() override { return 0; }
19 void Draw(Blitter::BlitterParams *, BlitterMode, ZoomLevel) override {};
20 void DrawColourMappingRect(void *, int, int, PaletteID) override {};
21 Sprite *Encode(SpriteType sprite_type, const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override;
22 void *MoveTo(void *, int, int) override { return nullptr; };
23 void SetPixel(void *, int, int, PixelColour) override {};
24 void DrawRect(void *, int, int, PixelColour) override {};
25 void DrawLine(void *, int, int, int, int, int, int, PixelColour, int, int) override {};
26 void CopyFromBuffer(void *, const void *, int, int) override {};
27 void CopyToBuffer(const void *, void *, int, int) override {};
28 void CopyImageToBuffer(const void *, void *, int, int, int) override {};
29 void ScrollBuffer(void *, int &, int &, int &, int &, int, int) override {};
30 size_t BufferSize(uint, uint) override { return 0; };
31 void PaletteAnimate(const Palette &) override { };
32 Blitter::PaletteAnimation UsePaletteAnimation() override { return Blitter::PaletteAnimation::None; };
33
34 std::string_view GetName() override { return "null"; }
35};
36
38 class FBlitter_Null : public BlitterFactory {
39public:
40 FBlitter_Null() : BlitterFactory("null", "Null Blitter (does nothing)") {}
41 std::unique_ptr<Blitter> CreateInstance() override { return std::make_unique<Blitter_Null>(); }
42};
43
44#endif /* BLITTER_NULL_HPP */
BlitterMode
BlitterMode
The modes of blitting we can do.
Definition base.hpp:17
BlitterFactory
The base factory, keeping track of all blitters.
Definition factory.hpp:21
Blitter_Null
Blitter that does nothing.
Definition null.hpp:16
Blitter_Null::DrawColourMappingRect
void DrawColourMappingRect(void *, int, int, PaletteID) override
Draw a colourtable to the screen.
Definition null.hpp:20
Blitter_Null::DrawLine
void DrawLine(void *, int, int, int, int, int, int, PixelColour, int, int) override
Draw a line with a given colour.
Definition null.hpp:25
Blitter_Null::SetPixel
void SetPixel(void *, int, int, PixelColour) override
Draw a pixel with a given colour on the video-buffer.
Definition null.hpp:23
Blitter_Null::GetName
std::string_view GetName() override
Get the name of the blitter, the same as the Factory-instance returns.
Definition null.hpp:34
Blitter_Null::BufferSize
size_t BufferSize(uint, uint) override
Calculate how much memory there is needed for an image of this size in the video-buffer.
Definition null.hpp:30
Blitter_Null::PaletteAnimate
void PaletteAnimate(const Palette &) override
Called when the 8bpp palette is changed; you should redraw all pixels on the screen that are equal to...
Definition null.hpp:31
Blitter_Null::MoveTo
void * MoveTo(void *, int, int) override
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
Definition null.hpp:22
Blitter_Null::DrawRect
void DrawRect(void *, int, int, PixelColour) override
Make a single horizontal line in a single colour on the video-buffer.
Definition null.hpp:24
Blitter_Null::GetScreenDepth
uint8_t GetScreenDepth() override
Get the screen depth this blitter works for.
Definition null.hpp:18
Blitter_Null::ScrollBuffer
void ScrollBuffer(void *, int &, int &, int &, int &, int, int) override
Scroll the videobuffer some 'x' and 'y' value.
Definition null.hpp:29
Blitter_Null::Encode
Sprite * Encode(SpriteType sprite_type, const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override
Convert a sprite from the loader to our own format.
Definition null.cpp:18
Blitter_Null::CopyToBuffer
void CopyToBuffer(const void *, void *, int, int) override
Copy from the screen to a buffer.
Definition null.hpp:27
Blitter_Null::UsePaletteAnimation
Blitter::PaletteAnimation UsePaletteAnimation() override
Check if the blitter uses palette animation at all.
Definition null.hpp:32
Blitter_Null::CopyImageToBuffer
void CopyImageToBuffer(const void *, void *, int, int, int) override
Copy from the screen to a buffer in a palette format for 8bpp and RGBA format for 32bpp.
Definition null.hpp:28
Blitter_Null::Draw
void Draw(Blitter::BlitterParams *, BlitterMode, ZoomLevel) override
Draw an image to the screen, given an amount of params defined above.
Definition null.hpp:19
Blitter_Null::CopyFromBuffer
void CopyFromBuffer(void *, const void *, int, int) override
Copy from a buffer to the screen.
Definition null.hpp:26
Blitter
How all blitters should look like.
Definition base.hpp:29
Blitter::PaletteAnimation
PaletteAnimation
Types of palette animation.
Definition base.hpp:50
Blitter::PaletteAnimation::None
@ None
No palette animation.
FBlitter_Null
Factory for the blitter that does nothing.
Definition null.hpp:38
FBlitter_Null::CreateInstance
std::unique_ptr< Blitter > CreateInstance() override
Create an instance of this Blitter-class.
Definition null.hpp:41
SpriteAllocator
Interface for something that can allocate memory for a sprite.
Definition spriteloader.hpp:104
SpriteCollMap
Map zoom level to data.
Definition spriteloader.hpp:34
factory.hpp
Factory to 'query' all available blitters.
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition gfx_type.h:357
PaletteID
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
Blitter::BlitterParams
Parameters related to blitting.
Definition base.hpp:32
Palette
Information about the currently used palette.
Definition gfx_type.h:373
PixelColour
Colour for pixel/line drawing.
Definition gfx_type.h:405
Sprite
Data structure describing a sprite.
Definition spritecache_type.h:16
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition zoom_type.h:20