Screen in a KMS dumb buffer inside of an overlay plane. More...

#include <kmsoverlay.h>

Inheritance diagram for KMSOverlay:

Public Member Functions
	KMSOverlay ()=delete

	KMSOverlay (const Size &size, PixelFormat format, WindowHint hint)

virtual void	apply ()
	Apply any pending changes to the hardware.

virtual int	gem ()
	Get the associated GEM handle for the overlay plane.

virtual uint32_t	get_plane_format ()
	Get internal DRM plane format.

virtual void	hide ()
	Hide the plane from the display.

virtual float	hscale () const
	Get the horizontal scale value.

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

virtual void	pan_pos (const Point &point)
	Set the hardware pan position in the plane buffer.

virtual void	pan_size (const Size &size)
	Set the hardware pan size.

virtual void	position (const DisplayPoint &point)
	Move the hardware plane to the specified position.

void *	raw ()
	Get a raw pointer to the current framebuffer.

virtual void	resize (const Size &size)
	Resize the hardware plane.

virtual void	rotate (uint32_t degrees)
	Rotate the hardware plane.

plane_data *	s () const
	Get a pointer to the internal plane structure.

virtual void	scale (float hscale, float vscale)
	Change the hardware scale of the overlay plane.

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

virtual void	show ()
	Show the plane on the display.

virtual float	vscale () const
	Get the vertical scale value.

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

Protected Attributes
uint32_t	m_index {0}
	Current flip index.

unique_plane_t	m_plane
	Plane instance pointer.

std::unique_ptr< FlipThread >	m_pool
	Internal thread pool for flipping.

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.

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)

Detailed Description

Screen in a KMS dumb buffer inside of an overlay plane.

This uses libplanes to modeset and configure planes.

Constructor & Destructor Documentation

◆ KMSOverlay() [1/2]

KMSOverlay ( )

delete

◆ KMSOverlay() [2/2]

KMSOverlay	(	const Size &	size,
		PixelFormat	format,
		WindowHint	hint
	)

Parameters

size	Size of the scree.
format	Requested format for the screen.
hint	Hint for the type of plane to create.

Member Function Documentation

◆ apply()

virtual void apply ( )

virtual

Apply any pending changes to the hardware.

◆ gem()

virtual int gem ( )

virtual

Get the associated GEM handle for the overlay plane.

◆ get_plane_format()

virtual uint32_t get_plane_format ( )

virtual

Get internal DRM plane format.

◆ hide()

virtual void hide ( )

virtual

Hide the plane from the display.

◆ hscale()

virtual float hscale ( ) const

virtual

Get the horizontal scale value.

◆ index()

uint32_t index ( )

overridevirtual

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

Reimplemented from Screen.

◆ pan_pos()

virtual void pan_pos ( const Point & point )

virtual

Set the hardware pan position in the plane buffer.

◆ pan_size()

virtual void pan_size ( const Size & size )

virtual

Set the hardware pan size.

◆ position()

virtual void position ( const DisplayPoint & point )

virtual

Move the hardware plane to the specified position.

◆ raw()

void * raw ( )

Get a raw pointer to the current framebuffer.

◆ resize()

virtual void resize ( const Size & size )

virtual

Resize the hardware plane.

Warning: This is an expensive operation. This will cause a re-allocation of the plane and all buffers, destroying any existing buffers.

◆ rotate()

virtual void rotate ( uint32_t degrees )

virtual

Rotate the hardware plane.

◆ s()

plane_data * s ( ) const

inline

Get a pointer to the internal plane structure.

◆ scale()

virtual void scale	(	float	hscale,
		float	vscale
	)

virtual

Change the hardware scale of the overlay plane.

Parameters

[in]	hscale	Horizontal scale, with 1.0 being 100%.
[in]	vscale	Vertical scale, with 1.0 being 100%.

◆ schedule_flip()

void schedule_flip ( )

overridevirtual

Schedule a flip to occur later.

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

Implements Screen.

◆ show()

virtual void show ( )

virtual

Show the plane on the display.

◆ vscale()

virtual float vscale ( ) const

virtual

Get the vertical scale value.

Member Data Documentation

◆ m_index

uint32_t m_index {0}

protected

Current flip index.

◆ m_plane

unique_plane_t m_plane

protected

Plane instance pointer.

◆ m_pool

std::unique_ptr<FlipThread> m_pool

protected

Internal thread pool for flipping.

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KMSOverlay() [1/2]

◆ KMSOverlay() [2/2]

Member Function Documentation

◆ apply()

◆ gem()

◆ get_plane_format()

◆ hide()

◆ hscale()

◆ index()

◆ pan_pos()

◆ pan_size()

◆ position()

◆ raw()

◆ resize()

◆ rotate()

◆ s()

◆ scale()

◆ schedule_flip()

◆ show()

◆ vscale()

Member Data Documentation

◆ m_index

◆ m_plane

◆ m_pool