Abstraction of basic graphics printing functions. More...

#include <graphics/printer.h>

Inheritance diagram for AbstractGraphicsPrinter:

Public Member Functions
virtual void	init (unsigned width, unsigned height, unsigned pitch)=0
	Initialize printer with actual screen dimensions. More...

virtual void	buffer (void *lfb)=0
	Set the video memory address. More...

virtual void	clear ()=0
	Clear all pixel of the current back buffer (set full screen to black)

virtual bool	valid (const Point &p) const =0
	Check if a Point can be displayed at the current resolution. More...

virtual unsigned	height () const =0
	Number of vertical pixels in current resolution. More...

virtual unsigned	width () const =0
	Number of horizontal pixels in current resolution. More...

virtual void	pixel (const Point &p, const Color &color)=0
	Draw a pixel. More...

virtual void	pixel (const Point &p, const ColorAlpha &color)=0
	Draw a pixel. More...

virtual void	line (const Point &start, const Point &end, const Color &color)=0
	Draw a line. More...

virtual void	line (const Point &start, const Point &end, const ColorAlpha &color)=0
	Draw a line. More...

virtual void	rectangle (const Point &start, const Point &end, const Color &color, bool filled=true)=0
	Draw a rectangle on the current back buffer. More...

virtual void	rectangle (const Point &start, const Point &end, const ColorAlpha &color, bool filled=true)=0
	Draw a rectangle on the current back buffer. More...

virtual void	font (const Font &new_font)=0
	Change the current font for text output in video mode. More...

virtual void	text (const Point &p, const char string, unsigned len, const Color &color, const Font font=nullptr)=0
	Print text (without automatic word wrap). More...

virtual void	text (const Point &p, const char string, unsigned len, const ColorAlpha &color, const Font font=nullptr)=0
	Print text (without automatic word wrap). More...

virtual void	image (const Point &p, PNG &image, unsigned width=0, unsigned height=0, unsigned offset_x=0, unsigned offset_y=0)=0
	Draw a PNG image (or detail) More...

virtual void	image (const Point &p, const GIMP &image, unsigned width=0, unsigned height=0, unsigned offset_x=0, unsigned offset_y=0)=0
	Draw a GIMP image (or detail) More...

virtual void	image (const Point &p, const Color *image, unsigned width, unsigned height, unsigned offset_x=0, unsigned offset_y=0)=0
	Draw a sprite. More...

virtual void	image (const Point &p, const ColorAlpha *image, unsigned width, unsigned height, unsigned offset_x=0, unsigned offset_y=0)=0
	Draw a sprite with alpha blending (transparency). More...

Static Public Member Functions
static AbstractGraphicsPrinter *	getMode (uint8_t colordepth, uint8_t offset_red, uint8_t offset_green, uint8_t offset_blue, uint8_t bits_red, uint8_t bits_green, uint8_t bits_blue)

Protected Member Functions
virtual bool	checkMode (uint8_t colordepth, uint8_t offset_red, uint8_t offset_green, uint8_t offset_blue, uint8_t bits_red, uint8_t bits_green, uint8_t bits_blue)=0
	Check if a printer is available for a video mode. More...

Detailed Description

Abstraction of basic graphics printing functions.

The actual implementation is placed in the inherited template class GraphicsPrinter for performance reasons.

Member Function Documentation

◆ checkMode()

virtual bool AbstractGraphicsPrinter::checkMode	(	uint8_t	colordepth,
		uint8_t	offset_red,
		uint8_t	offset_green,
		uint8_t	offset_blue,
		uint8_t	bits_red,
		uint8_t	bits_green,
		uint8_t	bits_blue
	)

protectedpure virtual

Check if a printer is available for a video mode.

This is required since printers are defined during compile time for performance reasons.

Template Parameters

colordepth	color depth of video mode
offset_red	Bit position of red color mask in video mode
offset_green	Bit position of green color mask in video mode
offset_blue	Bit position of blue color mask in video mode
bits_red	Size of red color mask in video mode
bits_green	Size of green color mask in video mode
bits_blue	Size of blue color mask in video mode

Returns: true if a printer for the video mode is available

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ init()

virtual void AbstractGraphicsPrinter::init	(	unsigned	width,
		unsigned	height,
		unsigned	pitch
	)

pure virtual

Initialize printer with actual screen dimensions.

Parameters

width	visible width of graphics screen
height	visible height of graphics screen
pitch	width of graphics screen (including invisible part, has to be at least `width`)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ buffer()

virtual void AbstractGraphicsPrinter::buffer ( void * lfb )

pure virtual

Set the video memory address.

Parameters

lfb	pointer to the linear framebuffer (lfb)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ valid()

virtual bool AbstractGraphicsPrinter::valid ( const Point & p ) const

pure virtual

Check if a Point can be displayed at the current resolution.

Parameters

p	Coordinates to check

Returns: 'true' if can be displayed

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ height()

virtual unsigned AbstractGraphicsPrinter::height ( ) const

pure virtual

Number of vertical pixels in current resolution.

Returns: Height of the screen in current video mode

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ width()

virtual unsigned AbstractGraphicsPrinter::width ( ) const

pure virtual

Number of horizontal pixels in current resolution.

Returns: Width of the screen in current video mode

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ pixel() [1/2]

virtual void AbstractGraphicsPrinter::pixel	(	const Point &	p,
		const Color &	color
	)

pure virtual

Draw a pixel.

Parameters

p	Coordinates of the pixel
color	Color of the pixel

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ pixel() [2/2]

virtual void AbstractGraphicsPrinter::pixel	(	const Point &	p,
		const ColorAlpha &	color
	)

pure virtual

Draw a pixel.

Parameters

p	Coordinates of the pixel
color	Color of the pixel

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ line() [1/2]

virtual void AbstractGraphicsPrinter::line	(	const Point &	start,
		const Point &	end,
		const Color &	color
	)

pure virtual

Draw a line.

Parameters

start	Coordinates of the begin of the line
end	Coordinates of the end of the line
color	Color of the line

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ line() [2/2]

virtual void AbstractGraphicsPrinter::line	(	const Point &	start,
		const Point &	end,
		const ColorAlpha &	color
	)

pure virtual

Draw a line.

Parameters

start	Coordinates of the begin of the line
end	Coordinates of the end of the line
color	Color of the line

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ rectangle() [1/2]

virtual void AbstractGraphicsPrinter::rectangle	(	const Point &	start,
		const Point &	end,
		const Color &	color,
		bool	filled = `true`
	)

pure virtual

Draw a rectangle on the current back buffer.

Parameters

start	Coordinate of the rectangles upper left corner
end	Coordinate of the rectangles lower right corner
color	Color of the rectangle
filled	If set, the rectangle will be filled with the same color. (otherwise only borders will be drawn)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ rectangle() [2/2]

virtual void AbstractGraphicsPrinter::rectangle	(	const Point &	start,
		const Point &	end,
		const ColorAlpha &	color,
		bool	filled = `true`
	)

pure virtual

Draw a rectangle on the current back buffer.

Parameters

start	Coordinate of the rectangles upper left corner
end	Coordinate of the rectangles lower right corner
color	Color of the rectangle
filled	If set, the rectangle will be filled with the same color. (otherwise only borders will be drawn)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ font()

virtual void AbstractGraphicsPrinter::font ( const Font & new_font )

pure virtual

Change the current font for text output in video mode.

Parameters

new_font Font to be used on subsequent calls to AbstractGraphicsPrinter::text() (without explicit font parameter)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ text() [1/2]

virtual void AbstractGraphicsPrinter::text	(	const Point &	p,
		const char *	string,
		unsigned	len,
		const Color &	color,
		const Font *	font = `nullptr`
	)

pure virtual

Print text (without automatic word wrap).

Parameters

p	Upper left start position of the text
string	Pointer to char array containing the text to be displayed
len	Number of characters to be displayed
color	Color for the text characters
font	Explicit font – or `nullptr` to use default font (set by font method)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ text() [2/2]

virtual void AbstractGraphicsPrinter::text	(	const Point &	p,
		const char *	string,
		unsigned	len,
		const ColorAlpha &	color,
		const Font *	font = `nullptr`
	)

pure virtual

Print text (without automatic word wrap).

Parameters

p	Upper left start position of the text
string	Pointer to char array containing the text to be displayed
len	Number of characters to be displayed
color	Color for the text characters
font	Explicit font – or `nullptr` to use default font (set by font method)

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ image() [1/4]

virtual void AbstractGraphicsPrinter::image	(	const Point &	p,
		PNG &	image,
		unsigned	width = `0`,
		unsigned	height = `0`,
		unsigned	offset_x = `0`,
		unsigned	offset_y = `0`
	)

pure virtual

Draw a PNG image (or detail)

The image can has to be in a supported PNG format. Alpha blending (transparency) is supported.

Parameters

p	Coordinate of the images upper left corner
image	Source image to display
width	Width of the image detail (full image width of the source image if zero/default value)
height	Height of the image detail (full image height of the source if zero/default value)
offset_x	Right offset of the source image
offset_y	Top offset of the source image

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ image() [2/4]

virtual void AbstractGraphicsPrinter::image	(	const Point &	p,
		const GIMP &	image,
		unsigned	width = `0`,
		unsigned	height = `0`,
		unsigned	offset_x = `0`,
		unsigned	offset_y = `0`
	)

pure virtual

Draw a GIMP image (or detail)

The image has to be exported as C-source (without Glib types!) in GIMP, alpha blending (transparency) is supported.

Parameters

p	Coordinate of the images upper left corner
image	Source image to display
width	Width of the image detail (full image width of the source image if zero/default value)
height	Height of the image detail (full image height of the source if zero/default value)
offset_x	Right offset of the source image
offset_y	Top offset of the source image

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ image() [3/4]

virtual void AbstractGraphicsPrinter::image	(	const Point &	p,
		const Color *	image,
		unsigned	width,
		unsigned	height,
		unsigned	offset_x = `0`,
		unsigned	offset_y = `0`
	)

pure virtual

Draw a sprite.

Each element in the source array will be displayed as a single pixel.

Parameters

p	Coordinate of the sprites upper left corner
image	Source sprite to display
width	Width of the sprite detail
height	Height of the sprite detail
offset_x	Right offset of the source sprite
offset_y	Top offset of the source sprite

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

◆ image() [4/4]

virtual void AbstractGraphicsPrinter::image	(	const Point &	p,
		const ColorAlpha *	image,
		unsigned	width,
		unsigned	height,
		unsigned	offset_x = `0`,
		unsigned	offset_y = `0`
	)

pure virtual

Draw a sprite with alpha blending (transparency).

Each element in the source array will be displayed as a single pixel.

Parameters

p	Coordinate of the sprites upper left corner
image	Source sprite to display
width	Width of the sprite detail
height	Height of the sprite detail
offset_x	Right offset of the source sprite
offset_y	Top offset of the source sprite

Implemented in GraphicsPrinter< COLORDEPTH, OFFSET_RED, OFFSET_GREEN, OFFSET_BLUE, BITS_RED, BITS_GREEN, BITS_BLUE >.

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

graphics/printer.h
graphics/printer.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ checkMode()

◆ init()

◆ buffer()

◆ valid()

◆ height()

◆ width()

◆ pixel() [1/2]

◆ pixel() [2/2]

◆ line() [1/2]

◆ line() [2/2]

◆ rectangle() [1/2]

◆ rectangle() [2/2]

◆ font()

◆ text() [1/2]

◆ text() [2/2]

◆ image() [1/4]

◆ image() [2/4]

◆ image() [3/4]

◆ image() [4/4]