#include <null.hpp>

Inheritance diagram for Blitter_Null:

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

void	Draw (Blitter::BlitterParams *, BlitterMode, ZoomLevel) override
	Draw an image to the screen, given an amount of params defined above.

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

Sprite *	Encode (const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override
	Convert a sprite from the loader to our own format.

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

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

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

void	DrawLine (void *, int, int, int, int, int, int, uint8_t, int, int) override
	Draw a line with a given colour.

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

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

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.

void	ScrollBuffer (void *, int &, int &, int &, int &, int, int) override
	Scroll the videobuffer some 'x' and 'y' value.

size_t	BufferSize (uint, uint) override
	Calculate how much memory there is needed for an image of this size in the video-buffer.

void	PaletteAnimate (const 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.

std::string_view	GetName () override
	Get the name of the blitter, the same as the Factory-instance returns.

Public Member Functions inherited from Blitter
bool	Is32BppSupported () override
	Can the sprite encoder make use of RGBA sprites?

virtual bool	NeedsAnimationBuffer ()
	Does this blitter require a separate animation buffer from the video backend?

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 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	PaletteAnimation { PALETTE_ANIMATION_NONE , PALETTE_ANIMATION_VIDEO_BACKEND , PALETTE_ANIMATION_BLITTER }
	Types of palette animation. More...

Detailed Description

Blitter that does nothing.

Definition at line 16 of file null.hpp.

Member Function Documentation

◆ BufferSize()

size_t Blitter_Null::BufferSize	(	uint	width,
		uint	height
	)

inlineoverridevirtual

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 30 of file null.hpp.

◆ CopyFromBuffer()

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

inlineoverridevirtual

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 26 of file null.hpp.

◆ CopyImageToBuffer()

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

inlineoverridevirtual

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 28 of file null.hpp.

◆ CopyToBuffer()

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

inlineoverridevirtual

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 27 of file null.hpp.

◆ Draw()

void Blitter_Null::Draw	(	Blitter::BlitterParams *	bp,
		BlitterMode	mode,
		ZoomLevel	zoom
	)

inlineoverridevirtual

Draw an image to the screen, given an amount of params defined above.

Implements Blitter.

Definition at line 19 of file null.hpp.

◆ DrawColourMappingRect()

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

inlineoverridevirtual

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 20 of file null.hpp.

◆ DrawLine()

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

inlineoverridevirtual

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 8bpp mapping colour.
width	Line width.
dash	Length of dashes for dashed lines. 0 means solid line.

Implements Blitter.

Definition at line 25 of file null.hpp.

◆ DrawRect()

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

inlineoverridevirtual

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 8bpp mapping colour.

Implements Blitter.

Definition at line 24 of file null.hpp.

◆ Encode()

Sprite * Blitter_Null::Encode	(	const SpriteLoader::SpriteCollection &	sprite,
		SpriteAllocator &	allocator
	)

overridevirtual

Convert a sprite from the loader to our own format.

Implements SpriteEncoder.

Definition at line 18 of file null.cpp.

References SpriteAllocator::Allocate(), Sprite::height, Sprite::width, Sprite::x_offs, Sprite::y_offs, and ZOOM_LVL_MIN.

◆ GetName()

std::string_view Blitter_Null::GetName ( )

inlineoverridevirtual

Get the name of the blitter, the same as the Factory-instance returns.

Implements Blitter.

Definition at line 34 of file null.hpp.

◆ GetScreenDepth()

uint8_t Blitter_Null::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 null.hpp.

◆ MoveTo()

void * Blitter_Null::MoveTo	(	void *	video,
		int	x,
		int	y
	)

inlineoverridevirtual

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 22 of file null.hpp.

◆ PaletteAnimate()

void Blitter_Null::PaletteAnimate ( const Palette & palette )

inlineoverridevirtual

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 31 of file null.hpp.

◆ ScrollBuffer()

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

inlineoverridevirtual

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 29 of file null.hpp.

◆ SetPixel()

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

inlineoverridevirtual

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 8bpp mapping colour.

Implements Blitter.

Definition at line 23 of file null.hpp.

◆ UsePaletteAnimation()

Blitter::PaletteAnimation Blitter_Null::UsePaletteAnimation ( )

inlineoverridevirtual

Check if the blitter uses palette animation at all.

Returns: True if it uses palette animation.

Implements Blitter.

Definition at line 32 of file null.hpp.

References Blitter::PALETTE_ANIMATION_NONE.

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

src/blitter/null.hpp
src/blitter/null.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BufferSize()

◆ CopyFromBuffer()

◆ CopyImageToBuffer()

◆ CopyToBuffer()

◆ Draw()

◆ DrawColourMappingRect()

◆ DrawLine()

◆ DrawRect()

◆ Encode()

◆ GetName()

◆ GetScreenDepth()

◆ MoveTo()

◆ PaletteAnimate()

◆ ScrollBuffer()

◆ SetPixel()

◆ UsePaletteAnimation()