X11Screen Class Reference

Screen in an X11 window. More...

#include <x11screen.h>

Inheritance diagram for X11Screen:

Public Member Functions
	X11Screen ()=delete
	X11Screen (Application &app, const Size &size=Size(800, 480), const std::string &name={}, bool borderless=false)
	X11Screen (const X11Screen &)=delete
	X11Screen (X11Screen &&)=delete
	~X11Screen () noexcept override
void	disable_window_decorations ()
	Disable window decorations.
void	flip (const DamageArray &damage) override
	Perform a flip of the buffers.
X11Screen &	operator= (const X11Screen &)=delete
X11Screen &	operator= (X11Screen &&)=delete
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.
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.

Protected Member Functions
void	copy_to_buffer (ScreenBuffer &buffer) override
	Copy the framebuffer to the current composition buffer.
void	handle_read (const asio::error_code &error)
	Callback for X11 server data.
Protected Member Functions inherited from Screen
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
Application &	m_app
	Application reference.
X11Input	m_in
	Custom input for dispatching events.
asio::posix::stream_descriptor	m_input
	Input stream for handling X11 server events.
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.

Detailed Description

Screen in an X11 window.

Constructor & Destructor Documentation

X11Screen() [1/4]

X11Screen ( )

delete

X11Screen() [2/4]

X11Screen ( Application &  app, const Size &  size = Size(800, 480), const std::string &  name = {}, bool  borderless = false  )

explicit

Parameters

app	Application instance this screen is associated with.
size	Size of the screen.
borderless	Create the X11 window without a border.

X11Screen() [3/4]

X11Screen ( const X11Screen &  )

delete

X11Screen() [4/4]

X11Screen ( X11Screen &&  )

delete

~X11Screen()

~X11Screen ( )

overridenoexcept

Member Function Documentation

copy_to_buffer()

void copy_to_buffer ( ScreenBuffer &  buffer )

overrideprotectedvirtual

Copy the framebuffer to the current composition buffer.

Reimplemented from Screen.

disable_window_decorations()

void disable_window_decorations

(

)

Disable window decorations.

flip()

void flip ( const DamageArray &  damage )

overridevirtual

Perform a flip of the buffers.

This iterates the buffers and puts the composition buffer into the screen buffers.

Note

This will call schedule_flip() automatically.

Reimplemented from Screen.

handle_read()

void handle_read ( const asio::error_code &  error )

protected

Callback for X11 server data.

operator=() [1/2]

X11Screen & operator= ( const X11Screen &  )

delete

operator=() [2/2]

X11Screen & operator= ( X11Screen &&  )

delete

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.

Member Data Documentation

m_app

Application& m_app

protected

Application reference.

m_in

X11Input m_in

protected

Custom input for dispatching events.

m_input

asio::posix::stream_descriptor m_input

protected

Input stream for handling X11 server events.