Screen in an in-memory buffer. More...

#include <memoryscreen.h>

Inheritance diagram for MemoryScreen:

Public Member Functions
	MemoryScreen (const Size &size=Size(800, 480))

virtual void	save_to_file (const std::string &filename) const

void	schedule_flip () override
	Schedule a flip to occur later.

Public Member Functions inherited from Screen
	Screen () noexcept

	Screen (const Screen &)=default

	Screen (Screen &&) noexcept=default

virtual	~Screen () noexcept=default

void	async_flip (bool async)
	Set if asynchronous buffer flips are used.

EGT_NODISCARD Rect	box () const
	Bounding box for the screen.

virtual EGT_NODISCARD size_t	brightness () const
	Get the current brightness of the screen.

virtual void	brightness (size_t brightness)
	Set the brightness of the screen.

virtual void	flip (const DamageArray &damage)
	Perform a flip of the buffers.

EGT_NODISCARD PixelFormat	format () const
	Get the format of the screen.

virtual EGT_NODISCARD bool	have_planes () const
	Returns true if the screen supports planes.

virtual void	high_fidelity ()
	Configure high fidelity options.

virtual uint32_t	index ()
	If the screen implementation manages multiple buffers, this will return the index of the current buffer.

virtual EGT_NODISCARD bool	is_composer () const
	Returns true if this is a screen used with the Microchip Graphic Composer.

virtual void	low_fidelity ()
	Configure low fidelity options.

virtual EGT_NODISCARD size_t	max_brightness () const
	Get the max brightness of the screen.

Screen &	operator= (const Screen &)=default

Screen &	operator= (Screen &&) noexcept=default

EGT_NODISCARD Painter &	painter ()
	Get the painter for the screen.

EGT_NODISCARD Size	size () const
	Size of the screen.

Additional Inherited Members
Public Types inherited from Screen
using	DamageArray = std::vector< Rect >
	Type used for damage arrays.

Static Public Member Functions inherited from Screen
static void	damage_algorithm (Screen::DamageArray &damage, Rect rect)
	This function implements the algorithm for adding damage rectangles to a list.

Protected Types inherited from Screen
using	BufferArray = std::vector< ScreenBuffer >
	Type used for an array of ScreenBuffer objects.

Protected Member Functions inherited from Screen
virtual void	copy_to_buffer (ScreenBuffer &buffer)
	Copy the framebuffer to the current composition buffer.

void	copy_to_buffer_software (ScreenBuffer &buffer)
	Copy the framebuffer to the current composition buffer.

void	init (const detail::FrameBufferInfo *info, uint32_t count, const Size &size, PixelFormat format=PixelFormat::argb8888)

void	init (const Size &size, PixelFormat format=PixelFormat::argb8888)

Protected Attributes inherited from Screen
bool	m_async {false}
	Perform flips asynchronously if supported.

BufferArray	m_buffers
	Screen buffer array.

PixelFormat	m_format {}
	Format of the screen.

std::unique_ptr< Painter >	m_painter
	Composition painter.

Size	m_size
	Size of the screen.

Surface	m_surface
	Composition surface.

Detailed Description

Screen in an in-memory buffer.

Constructor & Destructor Documentation

◆ MemoryScreen()

MemoryScreen ( const Size & size = Size(800, 480) )

explicit

Member Function Documentation

◆ save_to_file()

virtual void save_to_file ( const std::string & filename ) const

virtual

◆ schedule_flip()

void schedule_flip ( )

inlineoverridevirtual

Schedule a flip to occur later.

This is needed if a flip should occur sometime in the future to the hardware.

Implements Screen.