Default X11 EGL graphics output. More...

#include <kanzi/core.ui/platform/graphics_output/x11_egl/default_x11_egl_graphics_output.hpp>

Inheritance diagram for kanzi::x11::DefaultX11EGLGraphicsOutput:

Public Member Functions
bool	bringToFront () noexcept override
	WindowedGraphicsOutput::bringToFront() implementation.

KZ_NO_DISCARD optional< void * >	createImage (int target, void data, int attributes) noexcept override
	GLGraphicsOutput::createImage() implementation.

	DefaultX11EGLGraphicsOutput (const DefaultX11EGLGraphicsOutputProperties &properties)
	Constructor.

bool	destroyImage (void *image) noexcept override
	GLGraphicsOutput::destroyImage() implementation.

void	gatherEvents (EventQueue &queue) override
	EventSource::gatherEvents() implementation.

KZ_NO_DISCARD optional< SurfaceColorSpace >	getColorSpace () const noexcept override
	GLGraphicsOutput::getColorSpace() implementation.

KZ_NO_DISCARD optional< GraphicsContextAPI >	getGraphicsContextAPI () const noexcept override
	GLGraphicsOutput::getGraphicsContextAPI() implementation.

KZ_NO_DISCARD optional< void * >	getNativeContextHandle () const noexcept override
	GLGraphicsOutput::getNativeContextHandle() implementation.

KZ_NO_DISCARD optional< void * >	getNativeDisplayHandle () const noexcept override
	GLGraphicsOutput::getNativeDisplayHandle() implementation.

optional< NativeEventHandle >	getNativeEventHandle () const noexcept override
	EventSource::getNativeEventHandle() implementation.

KZ_NO_DISCARD optional< void * >	getNativeSurfaceHandle () const noexcept override
	GLGraphicsOutput::getNativeSurfaceHandle() implementation.

KZ_NO_DISCARD optional< NativeWindowHandle >	getNativeWindowHandle () const noexcept override
	WindowedGraphicsOutput::getNativeWindowHandle() implementation.

KZ_NO_DISCARD GLProcPointer	getProcAddress (string_view functionName) override
	GLGraphicsOutput::getProcAddress() implementation.

KZ_NO_DISCARD optional< SurfaceClientAPI >	getSurfaceClientAPI () const noexcept override
	GLGraphicsOutput::getSurfaceClientAPI() implementation.

KZ_NO_DISCARD Matrix4x4	getTargetTransformation () const noexcept override
	GLGraphicsOutput::getTargetTransformation() implementation.

KZ_NO_DISCARD optional< unsigned int >	getWindowHeight () const noexcept override
	WindowedGraphicsOutput::getWindowHeight() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionX () const noexcept override
	WindowedGraphicsOutput::getWindowPositionX() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionY () const noexcept override
	WindowedGraphicsOutput::getWindowPositionY() implementation.

KZ_NO_DISCARD optional< string >	getWindowTitle () const noexcept override
	WindowedGraphicsOutput::getWindowTitle() implementation.

KZ_NO_DISCARD optional< unsigned int >	getWindowWidth () const noexcept override
	WindowedGraphicsOutput::getWindowWidth() implementation.

bool	hideWindow () noexcept override
	WindowedGraphicsOutput::hideWindow() implementation.

void	logWindowPosition () noexcept
	Prints the active window position to the log.

void	logWindowSize () noexcept
	Prints the active window size to the log.

bool	makeCurrent () override
	GLGraphicsOutput::makeCurrent() implementation.

bool	makeFullscreen () noexcept override
	WindowedGraphicsOutput::makeFullscreen() implementation.

bool	makeMaximized () noexcept override
	WindowedGraphicsOutput::makeMaximized() implementation.

bool	makeMinimized () noexcept override
	WindowedGraphicsOutput::makeMinimized() implementation.

bool	makeRegular () noexcept override
	WindowedGraphicsOutput::makeRegular() implementation.

bool	moveWindow (int positionX, int positionY) noexcept override
	WindowedGraphicsOutput::moveWindow() implementation.

bool	releaseCurrent () override
	GLGraphicsOutput::releaseCurrent() implementation.

bool	resize (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resize() implementation.

bool	resizeWindow (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resizeWindow() implementation.

bool	setWindowTitle (string_view title) noexcept override
	WindowedGraphicsOutput::setWindowTitle() implementation.

bool	showWindow () noexcept override
	WindowedGraphicsOutput::showWindow() implementation.

bool	swapBuffers () override
	GLGraphicsOutput::swapBuffers() implementation.

bool	swapInterval (int interval) override
	GLGraphicsOutput::swapInterval() implementation.

void	syncEvents () noexcept
	Flushes and waits until the X server finishes processing all requests.

bool	toggleFullScreen (bool doFullScreen) noexcept
	Toggles the fullscreen window mode.

bool	toggleMaximized (bool doMaximized) noexcept
	Toggles the maximized window mode.

	~DefaultX11EGLGraphicsOutput ()
	Destructor.

Public Member Functions inherited from kanzi::GraphicsOutput
KZ_NO_DISCARD Vector2	getDpi () const noexcept
	Returns the resolution of the target coordinate system in dots per inch.

KZ_NO_DISCARD unsigned int	getHeight () const noexcept
	Returns the height of layout area in the target coordinate system.

KZ_NO_DISCARD unsigned int	getWidth () const noexcept
	Returns the width of layout area in the target coordinate system.

virtual	~GraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::EventSource
virtual	~EventSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::GLGraphicsOutput
virtual	~GLGraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::WindowedGraphicsOutput
virtual	~WindowedGraphicsOutput ()=default
	Destructor.

Protected Member Functions
void	setTargetTransformation (Matrix4x4 targetTransformation) noexcept
	Sets the target transformation.

void	updateCachedValues (unsigned int width, unsigned int height) noexcept
	Updates all cached values from a given layout size.

Protected Member Functions inherited from kanzi::GraphicsOutput
void	updateDpi (Vector2 dpi)
	Updates the target layout area resolution.

void	updateSize (unsigned int width, unsigned int height)
	Updates the target layout area size.

Additional Inherited Members
Public Types inherited from kanzi::GLGraphicsOutput
using	GLProcPointer
	Pointer to GL function.

Detailed Description

Default X11 EGL graphics output.

Since: Kanzi 3.9.8

Constructor & Destructor Documentation

◆ DefaultX11EGLGraphicsOutput()

kanzi::x11::DefaultX11EGLGraphicsOutput::DefaultX11EGLGraphicsOutput ( const DefaultX11EGLGraphicsOutputProperties & properties )

explicit

Constructor.

Parameters

properties Properties to request for the graphics output.

◆ ~DefaultX11EGLGraphicsOutput()

kanzi::x11::DefaultX11EGLGraphicsOutput::~DefaultX11EGLGraphicsOutput ( )

Destructor.

Member Function Documentation

◆ logWindowPosition()

void kanzi::x11::DefaultX11EGLGraphicsOutput::logWindowPosition ( )

noexcept

Prints the active window position to the log.

◆ logWindowSize()

void kanzi::x11::DefaultX11EGLGraphicsOutput::logWindowSize ( )

noexcept

Prints the active window size to the log.

◆ toggleFullScreen()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::toggleFullScreen ( bool doFullScreen )

noexcept

Toggles the fullscreen window mode.

Parameters

doFullScreen To change to fullscreen window, true. To turn off the fullscreen mode, false.

Returns: On success, true, otherwise false.

◆ toggleMaximized()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::toggleMaximized ( bool doMaximized )

noexcept

Toggles the maximized window mode.

Parameters

doMaximized To maximize the window, true. To restore the window to its normal size, false.

Returns: On success, true, otherwise false.

◆ syncEvents()

void kanzi::x11::DefaultX11EGLGraphicsOutput::syncEvents ( )

noexcept

Flushes and waits until the X server finishes processing all requests.

◆ gatherEvents()

void kanzi::x11::DefaultX11EGLGraphicsOutput::gatherEvents ( EventQueue & queue )

overridevirtual

EventSource::gatherEvents() implementation.

Implements kanzi::EventSource.

◆ getNativeEventHandle()

optional< NativeEventHandle > kanzi::x11::DefaultX11EGLGraphicsOutput::getNativeEventHandle ( ) const

overridevirtualnoexcept

EventSource::getNativeEventHandle() implementation.

Implements kanzi::EventSource.

◆ getProcAddress()

KZ_NO_DISCARD GLProcPointer kanzi::x11::DefaultX11EGLGraphicsOutput::getProcAddress ( string_view functionName )

overridevirtual

GLGraphicsOutput::getProcAddress() implementation.

Implements kanzi::GLGraphicsOutput.

◆ makeCurrent()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::makeCurrent ( )

overridevirtual

GLGraphicsOutput::makeCurrent() implementation.

Implements kanzi::GLGraphicsOutput.

◆ releaseCurrent()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::releaseCurrent ( )

overridevirtual

GLGraphicsOutput::releaseCurrent() implementation.

Implements kanzi::GLGraphicsOutput.

◆ swapBuffers()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::swapBuffers ( )

overridevirtual

GLGraphicsOutput::swapBuffers() implementation.

Implements kanzi::GLGraphicsOutput.

◆ swapInterval()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::swapInterval ( int interval )

overridevirtual

GLGraphicsOutput::swapInterval() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getNativeDisplayHandle()

KZ_NO_DISCARD optional< void * > kanzi::x11::DefaultX11EGLGraphicsOutput::getNativeDisplayHandle ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getNativeDisplayHandle() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getNativeContextHandle()

KZ_NO_DISCARD optional< void * > kanzi::x11::DefaultX11EGLGraphicsOutput::getNativeContextHandle ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getNativeContextHandle() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getNativeSurfaceHandle()

KZ_NO_DISCARD optional< void * > kanzi::x11::DefaultX11EGLGraphicsOutput::getNativeSurfaceHandle ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getNativeSurfaceHandle() implementation.

Implements kanzi::GLGraphicsOutput.

◆ createImage()

KZ_NO_DISCARD optional< void * > kanzi::x11::DefaultX11EGLGraphicsOutput::createImage	(	int	target,
		void *	data,
		int *	attributes )

overridevirtualnoexcept

GLGraphicsOutput::createImage() implementation.

Implements kanzi::GLGraphicsOutput.

◆ destroyImage()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::destroyImage ( void * image )

overridevirtualnoexcept

GLGraphicsOutput::destroyImage() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getGraphicsContextAPI()

KZ_NO_DISCARD optional< GraphicsContextAPI > kanzi::x11::DefaultX11EGLGraphicsOutput::getGraphicsContextAPI ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getGraphicsContextAPI() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getSurfaceClientAPI()

KZ_NO_DISCARD optional< SurfaceClientAPI > kanzi::x11::DefaultX11EGLGraphicsOutput::getSurfaceClientAPI ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getSurfaceClientAPI() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getColorSpace()

KZ_NO_DISCARD optional< SurfaceColorSpace > kanzi::x11::DefaultX11EGLGraphicsOutput::getColorSpace ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getColorSpace() implementation.

Implements kanzi::GLGraphicsOutput.

◆ getTargetTransformation()

KZ_NO_DISCARD Matrix4x4 kanzi::x11::DefaultX11EGLGraphicsOutput::getTargetTransformation ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getTargetTransformation() implementation.

Implements kanzi::GLGraphicsOutput.

◆ resize()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::resize	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resize() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ setWindowTitle()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::setWindowTitle ( string_view title )

overridevirtualnoexcept

WindowedGraphicsOutput::setWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowTitle()

KZ_NO_DISCARD optional< string > kanzi::x11::DefaultX11EGLGraphicsOutput::getWindowTitle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ resizeWindow()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::resizeWindow	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resizeWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowWidth()

KZ_NO_DISCARD optional< unsigned int > kanzi::x11::DefaultX11EGLGraphicsOutput::getWindowWidth ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowWidth() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowHeight()

KZ_NO_DISCARD optional< unsigned int > kanzi::x11::DefaultX11EGLGraphicsOutput::getWindowHeight ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowHeight() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ moveWindow()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::moveWindow	(	int	positionX,
		int	positionY )

overridevirtualnoexcept

WindowedGraphicsOutput::moveWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionX()

KZ_NO_DISCARD optional< int > kanzi::x11::DefaultX11EGLGraphicsOutput::getWindowPositionX ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionX() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionY()

KZ_NO_DISCARD optional< int > kanzi::x11::DefaultX11EGLGraphicsOutput::getWindowPositionY ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionY() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeFullscreen()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::makeFullscreen ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeFullscreen() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeRegular()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::makeRegular ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeRegular() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMaximized()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::makeMaximized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMaximized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMinimized()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::makeMinimized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMinimized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ showWindow()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::showWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::showWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ hideWindow()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::hideWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::hideWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ bringToFront()

bool kanzi::x11::DefaultX11EGLGraphicsOutput::bringToFront ( )

overridevirtualnoexcept

WindowedGraphicsOutput::bringToFront() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getNativeWindowHandle()

KZ_NO_DISCARD optional< NativeWindowHandle > kanzi::x11::DefaultX11EGLGraphicsOutput::getNativeWindowHandle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getNativeWindowHandle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ setTargetTransformation()

void kanzi::x11::DefaultX11EGLGraphicsOutput::setTargetTransformation ( Matrix4x4 targetTransformation )

inlineprotectednoexcept

Sets the target transformation.

Parameters

targetTransformation The target transformation matrix.

◆ updateCachedValues()

void kanzi::x11::DefaultX11EGLGraphicsOutput::updateCachedValues	(	unsigned int	width,
		unsigned int	height )

protectednoexcept

Updates all cached values from a given layout size.

Parameters

width	The width of the layout area in pixels.
height	The height of the layout area in pixels.

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

kanzi/core.ui/platform/graphics_output/x11_egl/default_x11_egl_graphics_output.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultX11EGLGraphicsOutput()

◆ ~DefaultX11EGLGraphicsOutput()

Member Function Documentation

◆ logWindowPosition()

◆ logWindowSize()

◆ toggleFullScreen()

◆ toggleMaximized()

◆ syncEvents()

◆ gatherEvents()

◆ getNativeEventHandle()

◆ getProcAddress()

◆ makeCurrent()

◆ releaseCurrent()

◆ swapBuffers()

◆ swapInterval()

◆ getNativeDisplayHandle()

◆ getNativeContextHandle()

◆ getNativeSurfaceHandle()

◆ createImage()

◆ destroyImage()

◆ getGraphicsContextAPI()

◆ getSurfaceClientAPI()

◆ getColorSpace()

◆ getTargetTransformation()

◆ resize()

◆ setWindowTitle()

◆ getWindowTitle()

◆ resizeWindow()

◆ getWindowWidth()

◆ getWindowHeight()

◆ moveWindow()

◆ getWindowPositionX()

◆ getWindowPositionY()

◆ makeFullscreen()

◆ makeRegular()

◆ makeMaximized()

◆ makeMinimized()

◆ showWindow()

◆ hideWindow()

◆ bringToFront()

◆ getNativeWindowHandle()

◆ setTargetTransformation()

◆ updateCachedValues()