OpenTTD
null.hpp
Go to the documentation of this file.
1 /* $Id$ */
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 BLITTER_NULL_HPP
13 #define BLITTER_NULL_HPP
14 
15 #include "factory.hpp"
16 
18 class Blitter_Null : public Blitter {
19 public:
20  uint8 GetScreenDepth() override { return 0; }
21  void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) override {};
22  void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal) override {};
23  Sprite *Encode(const SpriteLoader::Sprite *sprite, AllocatorProc *allocator) override;
24  void *MoveTo(void *video, int x, int y) override { return nullptr; };
25  void SetPixel(void *video, int x, int y, uint8 colour) override {};
26  void DrawRect(void *video, int width, int height, uint8 colour) override {};
27  void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash) override {};
28  void CopyFromBuffer(void *video, const void *src, int width, int height) override {};
29  void CopyToBuffer(const void *video, void *dst, int width, int height) override {};
30  void CopyImageToBuffer(const void *video, void *dst, int width, int height, int dst_pitch) override {};
31  void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y) override {};
32  int BufferSize(int width, int height) override { return 0; };
33  void PaletteAnimate(const Palette &palette) override { };
35 
36  const char *GetName() override { return "null"; }
37  int GetBytesPerPixel() override { return 0; }
38 };
39 
41 class FBlitter_Null : public BlitterFactory {
42 public:
43  FBlitter_Null() : BlitterFactory("null", "Null Blitter (does nothing)") {}
44  Blitter *CreateInstance() override { return new Blitter_Null(); }
45 };
46 
47 #endif /* BLITTER_NULL_HPP */
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
void * MoveTo(void *video, int x, int y) override
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
Definition: null.hpp:24
int BufferSize(int width, int height) override
Calculate how much memory there is needed for an image of this size in the video-buffer.
Definition: null.hpp:32
Information about the currently used palette.
Definition: gfx_type.h:309
Data structure describing a sprite.
Definition: spritecache.h:18
No palette animation.
Definition: base.hpp:52
Blitter that does nothing.
Definition: null.hpp:18
How all blitters should look like.
Definition: base.hpp:30
int GetBytesPerPixel() override
Get how many bytes are needed to store a pixel.
Definition: null.hpp:37
uint8 GetScreenDepth() override
Get the screen depth this blitter works for.
Definition: null.hpp:20
Parameters related to blitting.
Definition: base.hpp:33
Structure for passing information from the sprite loader to the blitter.
void PaletteAnimate(const Palette &palette) override
Called when the 8bpp palette is changed; you should redraw all pixels on the screen that are equal to...
Definition: null.hpp:33
Blitter * CreateInstance() override
Create an instance of this Blitter-class.
Definition: null.hpp:44
void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash) override
Draw a line with a given colour.
Definition: null.hpp:27
Blitter::PaletteAnimation UsePaletteAnimation() override
Check if the blitter uses palette animation at all.
Definition: null.hpp:34
Sprite * Encode(const SpriteLoader::Sprite *sprite, AllocatorProc *allocator) override
Convert a sprite from the loader to our own format.
Definition: null.cpp:20
void CopyFromBuffer(void *video, const void *src, int width, int height) override
Copy from a buffer to the screen.
Definition: null.hpp:28
void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal) override
Draw a colourtable to the screen.
Definition: null.hpp:22
void CopyToBuffer(const void *video, void *dst, int width, int height) override
Copy from the screen to a buffer.
Definition: null.hpp:29
void CopyImageToBuffer(const void *video, void *dst, int width, int height, int dst_pitch) override
Copy from the screen to a buffer in a palette format for 8bpp and RGBA format for 32bpp...
Definition: null.hpp:30
void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y) override
Scroll the videobuffer some &#39;x&#39; and &#39;y&#39; value.
Definition: null.hpp:31
const char * GetName() override
Get the name of the blitter, the same as the Factory-instance returns.
Definition: null.hpp:36
Factory for the blitter that does nothing.
Definition: null.hpp:41
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:19
PaletteAnimation
Types of palette animation.
Definition: base.hpp:51
void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) override
Draw an image to the screen, given an amount of params defined above.
Definition: null.hpp:21
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
void SetPixel(void *video, int x, int y, uint8 colour) override
Draw a pixel with a given colour on the video-buffer.
Definition: null.hpp:25
The base factory, keeping track of all blitters.
Definition: factory.hpp:28
Factory to &#39;query&#39; all available blitters.
void DrawRect(void *video, int width, int height, uint8 colour) override
Make a single horizontal line in a single colour on the video-buffer.
Definition: null.hpp:26