OpenTTD Source  20241108-master-g80f628063a
Blitter_8bppBase Class Reference

Base for all 8bpp blitters. More...

#include <8bpp_base.hpp>

Inheritance diagram for Blitter_8bppBase:
Blitter SpriteEncoder Blitter_8bppOptimized Blitter_8bppSimple

Public Member Functions

uint8_t GetScreenDepth () override
 Get the screen depth this blitter works for. More...
 
void DrawColourMappingRect (void *dst, int width, int height, PaletteID pal) override
 Draw a colourtable to the screen. More...
 
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 renderer. More...
 
void SetPixel (void *video, int x, int y, uint8_t colour) override
 Draw a pixel with a given colour on the video-buffer. More...
 
void DrawLine (void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t colour, int width, int dash) override
 Draw a line with a given colour. More...
 
void DrawRect (void *video, int width, int height, uint8_t colour) override
 Make a single horizontal line in a single colour on the video-buffer. More...
 
void CopyFromBuffer (void *video, const void *src, int width, int height) override
 Copy from a buffer to the screen. More...
 
void CopyToBuffer (const void *video, void *dst, int width, int height) override
 Copy from the screen to a buffer. More...
 
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. More...
 
void ScrollBuffer (void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y) override
 Scroll the videobuffer some 'x' and 'y' value. More...
 
size_t BufferSize (uint width, uint height) override
 Calculate how much memory there is needed for an image of this size in the video-buffer. More...
 
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 the 8bpp palette indexes 'first_dirty' to 'first_dirty + count_dirty'. More...
 
Blitter::PaletteAnimation UsePaletteAnimation () override
 Check if the blitter uses palette animation at all. More...
 
- Public Member Functions inherited from Blitter
bool Is32BppSupported () override
 Can the sprite encoder make use of RGBA sprites?
 
virtual void Draw (Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom)=0
 Draw an image to the screen, given an amount of params defined above.
 
virtual bool NeedsAnimationBuffer ()
 Does this blitter require a separate animation buffer from the video backend?
 
virtual std::string_view GetName ()=0
 Get the name of the blitter, the same as the Factory-instance returns.
 
virtual void PostResize ()
 Post resize event.
 
template<typename SetPixelT >
void DrawLineGeneric (int x, int y, int x2, int y2, int screen_width, int screen_height, int width, int dash, SetPixelT set_pixel)
 
- Public Member Functions inherited from SpriteEncoder
virtual SpriteEncode (const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator)=0
 Convert a sprite from the loader to our own format.
 
virtual uint GetSpriteAlignment ()
 Get the value which the height and width on a sprite have to be aligned by. More...
 

Additional Inherited Members

- Public Types inherited from Blitter
enum  PaletteAnimation { PALETTE_ANIMATION_NONE , PALETTE_ANIMATION_VIDEO_BACKEND , PALETTE_ANIMATION_BLITTER }
 Types of palette animation. More...
 

Detailed Description

Base for all 8bpp blitters.

Definition at line 16 of file 8bpp_base.hpp.

Member Function Documentation

◆ BufferSize()

size_t Blitter_8bppBase::BufferSize ( uint  width,
uint  height 
)
overridevirtual

Calculate how much memory there is needed for an image of this size in the video-buffer.

Parameters
widthThe width of the buffer-to-be.
heightThe height of the buffer-to-be.
Returns
The size needed for the buffer.

Implements Blitter.

Definition at line 147 of file 8bpp_base.cpp.

◆ CopyFromBuffer()

void Blitter_8bppBase::CopyFromBuffer ( void *  video,
const void *  src,
int  width,
int  height 
)
overridevirtual

Copy from a buffer to the screen.

Parameters
videoThe destination pointer (video-buffer).
srcThe buffer from which the data will be read.
widthThe width of the buffer.
heightThe height of the buffer.
Note
You can not do anything with the content of the buffer, as the blitter can store non-pixel data in it too!

Implements Blitter.

Definition at line 52 of file 8bpp_base.cpp.

◆ CopyImageToBuffer()

void Blitter_8bppBase::CopyImageToBuffer ( const void *  video,
void *  dst,
int  width,
int  height,
int  dst_pitch 
)
overridevirtual

Copy from the screen to a buffer in a palette format for 8bpp and RGBA format for 32bpp.

Parameters
videoThe destination pointer (video-buffer).
dstThe buffer in which the data will be stored.
widthThe width of the buffer.
heightThe height of the buffer.
dst_pitchThe pitch (byte per line) of the destination buffer.

Implements Blitter.

Definition at line 76 of file 8bpp_base.cpp.

◆ CopyToBuffer()

void Blitter_8bppBase::CopyToBuffer ( const void *  video,
void *  dst,
int  width,
int  height 
)
overridevirtual

Copy from the screen to a buffer.

Parameters
videoThe destination pointer (video-buffer).
dstThe buffer in which the data will be stored.
widthThe width of the buffer.
heightThe height of the buffer.
Note
You can not do anything with the content of the buffer, as the blitter can store non-pixel data in it too!

Implements Blitter.

Definition at line 64 of file 8bpp_base.cpp.

◆ DrawColourMappingRect()

void Blitter_8bppBase::DrawColourMappingRect ( void *  dst,
int  width,
int  height,
PaletteID  pal 
)
overridevirtual

Draw a colourtable to the screen.

This is: the colour of the screen is read and is looked-up in the palette to match a new colour, which then is put on the screen again.

Parameters
dstthe destination pointer (video-buffer).
widththe width of the buffer.
heightthe height of the buffer.
palthe palette to use.

Implements Blitter.

Definition at line 17 of file 8bpp_base.cpp.

◆ DrawLine()

void Blitter_8bppBase::DrawLine ( void *  video,
int  x,
int  y,
int  x2,
int  y2,
int  screen_width,
int  screen_height,
uint8_t  colour,
int  width,
int  dash 
)
overridevirtual

Draw a line with a given colour.

Parameters
videoThe destination pointer (video-buffer).
xThe x coordinate from where the line starts.
yThe y coordinate from where the line starts.
x2The x coordinate to where the line goes.
y2The y coordinate to where the lines goes.
screen_widthThe width of the screen you are drawing in (to avoid buffer-overflows).
screen_heightThe height of the screen you are drawing in (to avoid buffer-overflows).
colourA 8bpp mapping colour.
widthLine width.
dashLength of dashes for dashed lines. 0 means solid line.

Implements Blitter.

Definition at line 37 of file 8bpp_base.cpp.

◆ DrawRect()

void Blitter_8bppBase::DrawRect ( void *  video,
int  width,
int  height,
uint8_t  colour 
)
overridevirtual

Make a single horizontal line in a single colour on the video-buffer.

Parameters
videoThe destination pointer (video-buffer).
widthThe length of the line.
heightThe height of the line.
colourA 8bpp mapping colour.

Implements Blitter.

Definition at line 44 of file 8bpp_base.cpp.

◆ GetScreenDepth()

uint8_t Blitter_8bppBase::GetScreenDepth ( )
inlineoverridevirtual

Get the screen depth this blitter works for.

This is either: 8, 16, 24 or 32.

Implements Blitter.

Definition at line 18 of file 8bpp_base.hpp.

◆ MoveTo()

void * Blitter_8bppBase::MoveTo ( void *  video,
int  x,
int  y 
)
overridevirtual

Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the renderer.

Parameters
videoThe destination pointer (video-buffer) to scroll.
xHow much you want to scroll to the right.
yHow much you want to scroll to the bottom.
Returns
A new destination pointer moved the the requested place.

Implements Blitter.

Definition at line 27 of file 8bpp_base.cpp.

◆ PaletteAnimate()

void Blitter_8bppBase::PaletteAnimate ( const Palette palette)
overridevirtual

Called when the 8bpp palette is changed; you should redraw all pixels on the screen that are equal to the 8bpp palette indexes 'first_dirty' to 'first_dirty + count_dirty'.

Parameters
paletteThe new palette.

Implements Blitter.

Definition at line 152 of file 8bpp_base.cpp.

◆ ScrollBuffer()

void Blitter_8bppBase::ScrollBuffer ( void *  video,
int &  left,
int &  top,
int &  width,
int &  height,
int  scroll_x,
int  scroll_y 
)
overridevirtual

Scroll the videobuffer some 'x' and 'y' value.

Parameters
videoThe buffer to scroll into.
leftThe left value of the screen to scroll.
topThe top value of the screen to scroll.
widthThe width of the screen to scroll.
heightThe height of the screen to scroll.
scroll_xHow much to scroll in X.
scroll_yHow much to scroll in Y.

Implements Blitter.

Definition at line 88 of file 8bpp_base.cpp.

◆ SetPixel()

void Blitter_8bppBase::SetPixel ( void *  video,
int  x,
int  y,
uint8_t  colour 
)
overridevirtual

Draw a pixel with a given colour on the video-buffer.

Parameters
videoThe destination pointer (video-buffer).
xThe x position within video-buffer.
yThe y position within video-buffer.
colourA 8bpp mapping colour.

Implements Blitter.

Definition at line 32 of file 8bpp_base.cpp.

◆ UsePaletteAnimation()

Blitter::PaletteAnimation Blitter_8bppBase::UsePaletteAnimation ( )
overridevirtual

Check if the blitter uses palette animation at all.

Returns
True if it uses palette animation.

Implements Blitter.

Definition at line 157 of file 8bpp_base.cpp.

References Blitter::PALETTE_ANIMATION_VIDEO_BACKEND.


The documentation for this class was generated from the following files: