Base for all 32bpp blitters. More...

#include <32bpp_base.hpp>

Inheritance diagram for Blitter_32bppBase:

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

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, uint8_t 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, uint8_t colour, int width, int dash) override
	Draw a line with a given colour.

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.

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 void	DrawColourMappingRect (void *dst, int width, int height, PaletteID pal)=0
	Draw a colourtable to the screen.

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

Static Public Member Functions
static Colour	LookupColourInPalette (uint index)
	Look up the colour in the current palette.

static Colour	ComposeColourRGBANoCheck (uint r, uint g, uint b, uint a, Colour current)
	Compose a colour based on RGBA values and the current pixel value.

static Colour	ComposeColourRGBA (uint r, uint g, uint b, uint a, Colour current)
	Compose a colour based on RGBA values and the current pixel value.

static Colour	ComposeColourPANoCheck (Colour colour, uint a, Colour current)
	Compose a colour based on Pixel value, alpha value, and the current pixel value.

static Colour	ComposeColourPA (Colour colour, uint a, Colour current)
	Compose a colour based on Pixel value, alpha value, and the current pixel value.

static Colour	MakeTransparent (Colour colour, uint nom, uint denom=256)
	Make a pixel looks like it is transparent.

static uint8_t	MakeDark (uint8_t r, uint8_t g, uint8_t b)
	Make a colour dark grey, for specialized 32bpp remapping.

static Colour	MakeDark (Colour colour)
	Make a colour dark grey, for specialized 32bpp remapping.

static Colour	MakeGrey (Colour colour)
	Make a colour grey - based.

static Colour	ReallyAdjustBrightness (Colour colour, uint8_t brightness)

static Colour	AdjustBrightness (Colour colour, uint8_t brightness)

static uint8_t	GetColourBrightness (Colour colour)

Static Public Attributes
static const int	DEFAULT_BRIGHTNESS = 128

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 32bpp blitters.

Definition at line 19 of file 32bpp_base.hpp.

Member Function Documentation

◆ AdjustBrightness()

static Colour Blitter_32bppBase::AdjustBrightness	(	Colour	colour,
		uint8_t	brightness
	)

inlinestatic

Definition at line 161 of file 32bpp_base.hpp.

◆ BufferSize()

size_t Blitter_32bppBase::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.

Reimplemented in Blitter_40bppAnim.

Definition at line 143 of file 32bpp_base.cpp.

◆ ComposeColourPA()

static Colour Blitter_32bppBase::ComposeColourPA	(	Colour	colour,
		uint	a,
		Colour	current
	)

inlinestatic

Compose a colour based on Pixel value, alpha value, and the current pixel value.

Handles fully transparent and solid pixels in a special (faster) way.

Definition at line 86 of file 32bpp_base.hpp.

References ComposeColourPANoCheck().

Referenced by Blitter_32bppSimple::Draw().

◆ ComposeColourPANoCheck()

static Colour Blitter_32bppBase::ComposeColourPANoCheck	(	Colour	colour,
		uint	a,
		Colour	current
	)

inlinestatic

Compose a colour based on Pixel value, alpha value, and the current pixel value.

Definition at line 73 of file 32bpp_base.hpp.

References Colour::b, and ComposeColourRGBANoCheck().

Referenced by ComposeColourPA(), Blitter_32bppOptimized::Draw(), and Blitter_40bppAnim::Draw().

◆ ComposeColourRGBA()

static Colour Blitter_32bppBase::ComposeColourRGBA	(	uint	r,
		uint	g,
		uint	b,
		uint	a,
		Colour	current
	)

inlinestatic

Compose a colour based on RGBA values and the current pixel value.

Handles fully transparent and solid pixels in a special (faster) way.

Definition at line 62 of file 32bpp_base.hpp.

References ComposeColourRGBANoCheck().

Referenced by Blitter_32bppSimple::Draw(), and Blitter_32bppOptimized::Draw().

◆ ComposeColourRGBANoCheck()

static Colour Blitter_32bppBase::ComposeColourRGBANoCheck	(	uint	r,
		uint	g,
		uint	b,
		uint	a,
		Colour	current
	)

inlinestatic

Compose a colour based on RGBA values and the current pixel value.

Definition at line 45 of file 32bpp_base.hpp.

References Colour::b.

Referenced by ComposeColourPANoCheck(), ComposeColourRGBA(), Blitter_32bppOptimized::Draw(), and Blitter_40bppAnim::Draw().

◆ CopyFromBuffer()

void Blitter_32bppBase::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.

Reimplemented in Blitter_40bppAnim.

Definition at line 48 of file 32bpp_base.cpp.

◆ CopyImageToBuffer()

void Blitter_32bppBase::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.

Reimplemented in Blitter_40bppAnim.

Definition at line 72 of file 32bpp_base.cpp.

Referenced by Blitter_40bppAnim::CopyImageToBuffer().

◆ CopyToBuffer()

void Blitter_32bppBase::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.

Reimplemented in Blitter_40bppAnim.

Definition at line 60 of file 32bpp_base.cpp.

◆ DrawLine()

void Blitter_32bppBase::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

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.

Reimplemented in Blitter_40bppAnim.

Definition at line 26 of file 32bpp_base.cpp.

References LookupColourInPalette().

Referenced by Blitter_40bppAnim::DrawLine().

◆ DrawRect()

void Blitter_32bppBase::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

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.

Reimplemented in Blitter_40bppAnim.

Definition at line 34 of file 32bpp_base.cpp.

References LookupColourInPalette().

Referenced by Blitter_32bppAnim::DrawRect(), and Blitter_40bppAnim::DrawRect().

◆ GetColourBrightness()

static uint8_t Blitter_32bppBase::GetColourBrightness ( Colour colour )

inlinestatic

Definition at line 169 of file 32bpp_base.hpp.

◆ GetScreenDepth()

uint8_t Blitter_32bppBase::GetScreenDepth ( )

inlineoverridevirtual

Get the screen depth this blitter works for.

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

Implements Blitter.

Definition at line 21 of file 32bpp_base.hpp.

◆ LookupColourInPalette()

static Colour Blitter_32bppBase::LookupColourInPalette ( uint index )

inlinestatic

Look up the colour in the current palette.

Definition at line 37 of file 32bpp_base.hpp.

References _cur_palette, and Palette::palette.

Referenced by Blitter_32bppSimple::Draw(), Blitter_32bppOptimized::Draw(), Blitter_40bppAnim::Draw(), DrawLine(), DrawRect(), Blitter_32bppSimple::Encode(), and SetPixel().

◆ MakeDark() [1/2]

static Colour Blitter_32bppBase::MakeDark ( Colour colour )

inlinestatic

Make a colour dark grey, for specialized 32bpp remapping.

Parameters

colour the colour to make dark.

Returns: the new colour, now darker.

Definition at line 131 of file 32bpp_base.hpp.

References Colour::b, and MakeDark().

◆ MakeDark() [2/2]

static uint8_t Blitter_32bppBase::MakeDark	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b
	)

inlinestatic

Make a colour dark grey, for specialized 32bpp remapping.

Parameters

r	red component
g	green component
b	blue component

Returns: the brightness value of the new colour, now dark grey.

Definition at line 120 of file 32bpp_base.hpp.

Referenced by Blitter_32bppSimple::Draw(), Blitter_32bppOptimized::Draw(), Blitter_40bppAnim::Draw(), and MakeDark().

◆ MakeGrey()

static Colour Blitter_32bppBase::MakeGrey ( Colour colour )

inlinestatic

Make a colour grey - based.

Parameters

colour the colour to make grey.

Returns: the new colour, now grey.

Definition at line 143 of file 32bpp_base.hpp.

References Colour::b.

Referenced by Blitter_32bppAnim::DrawColourMappingRect(), Blitter_32bppSimple::DrawColourMappingRect(), and Blitter_40bppAnim::DrawColourMappingRect().

◆ MakeTransparent()

static Colour Blitter_32bppBase::MakeTransparent	(	Colour	colour,
		uint	nom,
		uint	denom = `256`
	)

inlinestatic

Make a pixel looks like it is transparent.

Parameters

colour	the colour already on the screen.
nom	the amount of transparency, nominator, makes colour lighter.
denom	denominator, makes colour darker.

Returns: the new colour for the screen.

Definition at line 104 of file 32bpp_base.hpp.

References Colour::b.

Referenced by Blitter_32bppSimple::Draw(), Blitter_32bppOptimized::Draw(), Blitter_40bppAnim::Draw(), Blitter_32bppAnim::DrawColourMappingRect(), Blitter_32bppSimple::DrawColourMappingRect(), and Blitter_40bppAnim::DrawColourMappingRect().

◆ MoveTo()

void * Blitter_32bppBase::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 16 of file 32bpp_base.cpp.

◆ PaletteAnimate()

void Blitter_32bppBase::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 148 of file 32bpp_base.cpp.

◆ ReallyAdjustBrightness()

Colour Blitter_32bppBase::ReallyAdjustBrightness	(	Colour	colour,
		uint8_t	brightness
	)

static

Definition at line 153 of file 32bpp_base.cpp.

◆ ScrollBuffer()

void Blitter_32bppBase::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.

Reimplemented in Blitter_40bppAnim.

Definition at line 84 of file 32bpp_base.cpp.

Referenced by Blitter_32bppAnim::ScrollBuffer(), and Blitter_40bppAnim::ScrollBuffer().

◆ SetPixel()

void Blitter_32bppBase::SetPixel	(	void *	video,
		int	x,
		int	y,
		uint8_t	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 8bpp mapping colour.

Implements Blitter.

Reimplemented in Blitter_40bppAnim.

Definition at line 21 of file 32bpp_base.cpp.

References LookupColourInPalette().

Referenced by Blitter_40bppAnim::SetPixel().

◆ UsePaletteAnimation()

Blitter::PaletteAnimation Blitter_32bppBase::UsePaletteAnimation ( )

overridevirtual

Check if the blitter uses palette animation at all.

Returns: True if it uses palette animation.

Implements Blitter.

Reimplemented in Blitter_40bppAnim.

Definition at line 183 of file 32bpp_base.cpp.

References Blitter::PALETTE_ANIMATION_NONE.

Field Documentation

◆ DEFAULT_BRIGHTNESS

const int Blitter_32bppBase::DEFAULT_BRIGHTNESS = 128

static

Definition at line 157 of file 32bpp_base.hpp.

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

src/blitter/32bpp_base.hpp
src/blitter/32bpp_base.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AdjustBrightness()

◆ BufferSize()

◆ ComposeColourPA()

◆ ComposeColourPANoCheck()

◆ ComposeColourRGBA()

◆ ComposeColourRGBANoCheck()

◆ CopyFromBuffer()

◆ CopyImageToBuffer()

◆ CopyToBuffer()

◆ DrawLine()

◆ DrawRect()

◆ GetColourBrightness()

◆ GetScreenDepth()

◆ LookupColourInPalette()

◆ MakeDark() [1/2]

◆ MakeDark() [2/2]

◆ MakeGrey()

◆ MakeTransparent()

◆ MoveTo()

◆ PaletteAnimate()

◆ ReallyAdjustBrightness()

◆ ScrollBuffer()

◆ SetPixel()

◆ UsePaletteAnimation()

Field Documentation

◆ DEFAULT_BRIGHTNESS