Base for all 8bpp blitters. More...

#include <8bpp_base.hpp>

Inheritance diagram for Blitter_8bppBase:

Public Member Functions
uint8_t	GetScreenDepth () override
	Get the screen depth this blitter works for.

void	DrawColourMappingRect (void *dst, int width, int height, PaletteID pal) override
	Draw a colourtable to the screen.

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.

void	SetPixel (void *video, int x, int y, PixelColour colour) override
	Draw a pixel with a given colour on the video-buffer.

void	DrawLine (void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, PixelColour colour, int width, int dash) override
	Draw a line with a given colour.

void	DrawRect (void *video, int width, int height, PixelColour colour) override
	Make a single horizontal line in a single colour on the video-buffer.

void	CopyFromBuffer (void video, const void src, int width, int height) override
	Copy from a buffer to the screen.

void	CopyToBuffer (const void video, void dst, int width, int height) override
	Copy from the screen to a buffer.

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.

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.

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.

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'.

Blitter::PaletteAnimation	UsePaletteAnimation () override
	Check if the blitter uses palette animation at all.

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 Sprite *	Encode (SpriteType sprite_type, 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.

Additional Inherited Members
Public Types inherited from Blitter
enum class	PaletteAnimation : uint8_t { None , VideoBackend , Blitter }
	Types of palette animation. More...

Static Public Member Functions inherited from Blitter
template<typename T >
static void	MovePixels (const T src, T dst, size_t width, size_t height, ptrdiff_t pitch)

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

width	The width of the buffer-to-be.
height	The height of the buffer-to-be.

Returns: The size needed for the buffer.

Implements Blitter.

Definition at line 138 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

video	The destination pointer (video-buffer).
src	The buffer from which the data will be read.
width	The width of the buffer.
height	The 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 53 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

video	The destination pointer (video-buffer).
dst	The buffer in which the data will be stored.
width	The width of the buffer.
height	The height of the buffer.
dst_pitch	The pitch (byte per line) of the destination buffer.

Implements Blitter.

Definition at line 77 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

video	The destination pointer (video-buffer).
dst	The buffer in which the data will be stored.
width	The width of the buffer.
height	The 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 65 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

dst	the destination pointer (video-buffer).
width	the width of the buffer.
height	the height of the buffer.
pal	the palette to use.

Implements Blitter.

Definition at line 17 of file 8bpp_base.cpp.

References Recolour.

◆ DrawLine()

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

overridevirtual

Draw a line with a given colour.

Parameters

video	The destination pointer (video-buffer).
x	The x coordinate from where the line starts.
y	The y coordinate from where the line starts.
x2	The x coordinate to where the line goes.
y2	The y coordinate to where the lines goes.
screen_width	The width of the screen you are drawing in (to avoid buffer-overflows).
screen_height	The height of the screen you are drawing in (to avoid buffer-overflows).
colour	A pixel colour.
width	Line width.
dash	Length of dashes for dashed lines. 0 means solid line.

Implements Blitter.

Definition at line 37 of file 8bpp_base.cpp.

References PixelColour::p.

◆ DrawRect()

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

overridevirtual

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

Parameters

video	The destination pointer (video-buffer).
width	The length of the line.
height	The height of the line.
colour	A pixel colour.

Implements Blitter.

Definition at line 44 of file 8bpp_base.cpp.

References PixelColour::p.

◆ 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

video	The destination pointer (video-buffer) to scroll.
x	How much you want to scroll to the right.
y	How 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

palette The new palette.

Implements Blitter.

Definition at line 143 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

video	The buffer to scroll into.
left	The left value of the screen to scroll.
top	The top value of the screen to scroll.
width	The width of the screen to scroll.
height	The height of the screen to scroll.
scroll_x	How much to scroll in X.
scroll_y	How much to scroll in Y.

Implements Blitter.

Definition at line 89 of file 8bpp_base.cpp.

◆ SetPixel()

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

overridevirtual

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

Parameters

video	The destination pointer (video-buffer).
x	The x position within video-buffer.
y	The y position within video-buffer.
colour	A pixel colour.

Implements Blitter.

Definition at line 32 of file 8bpp_base.cpp.

References PixelColour::p.

◆ 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 148 of file 8bpp_base.cpp.

References Blitter::VideoBackend.

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

src/blitter/8bpp_base.hpp
src/blitter/8bpp_base.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BufferSize()

◆ CopyFromBuffer()

◆ CopyImageToBuffer()

◆ CopyToBuffer()

◆ DrawColourMappingRect()

◆ DrawLine()

◆ DrawRect()

◆ GetScreenDepth()

◆ MoveTo()

◆ PaletteAnimate()

◆ ScrollBuffer()

◆ SetPixel()

◆ UsePaletteAnimation()