Class representing a default Android window surface EGL graphics output. More...

#include <kanzi/core.ui/platform/graphics_output/android_ws_egl/default_android_ws_egl_graphics_output.hpp>

Inheritance diagram for kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput:

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

KZ_NO_DISCARD optional< void * >	createImage (int target, void data, int attributes) noexcept override
	Creates a native image object, which can be shared between client APIs.

	DefaultAndroidWSEGLGraphicsOutput (const DefaultAndroidWSEGLGraphicsOutputProperties &properties)
	Constructor.

bool	destroyImage (void *image) noexcept override
	Destroys an EGL image.

void	gatherEvents (EventQueue &queue) override
	Amends the given event queue with the events received so far.

optional< SurfaceColorSpace >	getColorSpace () const noexcept override
	Gets the color space used by the associated graphics context.

optional< GraphicsContextAPI >	getGraphicsContextAPI () const noexcept override
	Gets the API used by the associated graphics context.

KZ_NO_DISCARD optional< void * >	getNativeContextHandle () const noexcept override
	Gets the associated native GL context handle.

KZ_NO_DISCARD optional< void * >	getNativeDisplayHandle () const noexcept override
	Gets the associated native GL display handle.

optional< NativeEventHandle >	getNativeEventHandle () const noexcept override
	Returns a waitable event handle for this event source, if available.

KZ_NO_DISCARD optional< void * >	getNativeSurfaceHandle () const noexcept override
	Gets the associated native GL surface handle.

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

KZ_NO_DISCARD GLProcPointer	getProcAddress (string_view functionName) override
	Retrieves pointer to GL function.

optional< SurfaceClientAPI >	getSurfaceClientAPI () const noexcept override
	Gets the type of the associated graphics surface.

Matrix4x4	getTargetTransformation () const noexcept override
	Returns the target transformation matrix.

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	listCurrentEGLConfig () const noexcept
	Lists the current valid EGL configuration.

void	listEGLConfigs () const noexcept
	Lists all valid EGL configurations. If EGL display is no display, lists nothing.

bool	makeCurrent () noexcept override
	Activates the current EGL thread.

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 () noexcept override
	Deactivates the current EGL thread.

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	setWindowZOrder (int windowZOrder)
	Sets the Z order of a window.

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

bool	swapBuffers () override
	Posts rendering results.

bool	swapInterval (int interval) override
	Sets the minimum number of displayed video frames before a buffer swap.

	~DefaultAndroidWSEGLGraphicsOutput ()
	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 matrix.

void	updateCachedValues (unsigned int width, unsigned int height) noexcept
	Updates all cached values from the 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

Class representing a default Android window surface EGL graphics output.

Since: Kanzi 3.9.8

Constructor & Destructor Documentation

◆ DefaultAndroidWSEGLGraphicsOutput()

kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::DefaultAndroidWSEGLGraphicsOutput ( const DefaultAndroidWSEGLGraphicsOutputProperties & properties )

explicit

Constructor.

Parameters

properties Properties to request for the graphics output.

◆ ~DefaultAndroidWSEGLGraphicsOutput()

kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::~DefaultAndroidWSEGLGraphicsOutput ( )

Destructor.

Member Function Documentation

◆ gatherEvents()

void kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::gatherEvents ( EventQueue & queue )

overridevirtual

Amends the given event queue with the events received so far.

Parameters

queue Event queue to amend. Do not clear nor assume to be empty.

Implements kanzi::EventSource.

◆ getNativeEventHandle()

optional< NativeEventHandle > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getNativeEventHandle ( ) const

overridevirtualnoexcept

Returns a waitable event handle for this event source, if available.

Return values

nullopt Getting the event handle failed.

Returns: The native event handle.

Implements kanzi::EventSource.

◆ getProcAddress()

KZ_NO_DISCARD GLProcPointer kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getProcAddress ( string_view functionName )

overridevirtual

Retrieves pointer to GL function.

Parameters

functionName Name of the function.

Returns: Pointer to the function, null if not found.

Implements kanzi::GLGraphicsOutput.

◆ makeCurrent()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::makeCurrent ( )

overridevirtualnoexcept

Activates the current EGL thread.

Returns: On success, true, otherwise false.

Implements kanzi::GLGraphicsOutput.

◆ releaseCurrent()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::releaseCurrent ( )

overridevirtualnoexcept

Deactivates the current EGL thread.

Returns: On success, true, otherwise false.

Implements kanzi::GLGraphicsOutput.

◆ swapBuffers()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::swapBuffers ( )

overridevirtual

Posts rendering results.

Implicitly flushes the rendering pipeline and executes all received rendering commands before posting.

Returns: On success, true, otherwise false.

Implements kanzi::GLGraphicsOutput.

◆ swapInterval()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::swapInterval ( int interval )

overridevirtual

Sets the minimum number of displayed video frames before a buffer swap.

Parameters

interval Minimum number of video frames to wait before buffer swap.

Returns: On success, true, otherwise false.

Implements kanzi::GLGraphicsOutput.

◆ getTargetTransformation()

Matrix4x4 kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getTargetTransformation ( ) const

overridevirtualnoexcept

Returns the target transformation matrix.

Returns: Target transformation matrix.

Implements kanzi::GLGraphicsOutput.

◆ getGraphicsContextAPI()

optional< GraphicsContextAPI > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getGraphicsContextAPI ( ) const

overridevirtualnoexcept

Gets the API used by the associated graphics context.

Return values

nullopt Getting the graphics context failed.

Returns: Graphics context API.

Implements kanzi::GLGraphicsOutput.

◆ getSurfaceClientAPI()

optional< SurfaceClientAPI > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getSurfaceClientAPI ( ) const

overridevirtualnoexcept

Gets the type of the associated graphics surface.

Return values

nullopt Getting the graphics surface failed.

Returns: Graphics surface type.

Implements kanzi::GLGraphicsOutput.

◆ getColorSpace()

optional< SurfaceColorSpace > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getColorSpace ( ) const

overridevirtualnoexcept

Gets the color space used by the associated graphics context.

Return values

nullopt Getting the color space failed.

Returns: Color space used by the associated graphics context.

Implements kanzi::GLGraphicsOutput.

◆ getNativeDisplayHandle()

KZ_NO_DISCARD optional< void * > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getNativeDisplayHandle ( ) const

overridevirtualnoexcept

Gets the associated native GL display handle.

Return values

nullopt Getting GL display failed.

Returns: The handle of the associated display object.

Implements kanzi::GLGraphicsOutput.

◆ getNativeContextHandle()

KZ_NO_DISCARD optional< void * > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getNativeContextHandle ( ) const

overridevirtualnoexcept

Gets the associated native GL context handle.

Return values

nullopt Getting GL context failed.

Returns: The handle of the associated graphics context object.

Implements kanzi::GLGraphicsOutput.

◆ getNativeSurfaceHandle()

KZ_NO_DISCARD optional< void * > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getNativeSurfaceHandle ( ) const

overridevirtualnoexcept

Gets the associated native GL surface handle.

Return values

nullopt Getting GL surface failed.

Returns: The handle of the associated surface object.

Implements kanzi::GLGraphicsOutput.

◆ createImage()

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

overridevirtualnoexcept

Creates a native image object, which can be shared between client APIs.

To destroy the returned image, use destroyImage().

Parameters

target	Context-specific target specifier.
data	Data to use for the image content.
attributes	Context-specific attributes list.

Returns: Created image, on error, null.

See also: destroyImage().

Implements kanzi::GLGraphicsOutput.

◆ destroyImage()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::destroyImage ( void * image )

overridevirtualnoexcept

Destroys an EGL image.

Parameters

image EGL image to destroy.

Returns: On success, true, otherwise false.

Implements kanzi::GLGraphicsOutput.

◆ listEGLConfigs()

void kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::listEGLConfigs ( ) const

noexcept

Lists all valid EGL configurations. If EGL display is no display, lists nothing.

◆ listCurrentEGLConfig()

void kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::listCurrentEGLConfig ( ) const

noexcept

Lists the current valid EGL configuration.

If EGL display is no display or EGL configuration is no configuration, lists nothing.

◆ setWindowZOrder()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::setWindowZOrder ( int windowZOrder )

Sets the Z order of a window.

Parameters

windowZOrder Z order value to set.

Returns: On success, true, otherwise false.

◆ resize()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::resize	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resize() implementation.

Parameters

width	window width to set.
height	window height to set.

Returns: On success, true, otherwise false.

Implements kanzi::WindowedGraphicsOutput.

◆ setWindowTitle()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::setWindowTitle ( string_view title )

overridevirtualnoexcept

WindowedGraphicsOutput::setWindowTitle() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowTitle()

KZ_NO_DISCARD optional< string > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getWindowTitle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowTitle() implementation.

Returns: Returns nullopt.

Implements kanzi::WindowedGraphicsOutput.

◆ resizeWindow()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::resizeWindow	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resizeWindow() implementation.

Parameters

width	window width to set.
height	window height to set.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowWidth()

KZ_NO_DISCARD optional< unsigned int > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getWindowWidth ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowWidth() implementation.

Returns nullopt.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowHeight()

KZ_NO_DISCARD optional< unsigned int > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getWindowHeight ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowHeight() implementation.

Returns nullopt.

Implements kanzi::WindowedGraphicsOutput.

◆ moveWindow()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::moveWindow	(	int	positionX,
		int	positionY )

overridevirtualnoexcept

WindowedGraphicsOutput::moveWindow() implementation.

Parameters

positionX	window position X to be set.
positionY	window position Y to be set.

Returns: On success, true, otherwise false.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionX()

KZ_NO_DISCARD optional< int > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getWindowPositionX ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionX() implementation.

Returns nullopt.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionY()

KZ_NO_DISCARD optional< int > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getWindowPositionY ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionY() implementation.

Returns nullopt.

Implements kanzi::WindowedGraphicsOutput.

◆ makeFullscreen()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::makeFullscreen ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeFullscreen() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ makeRegular()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::makeRegular ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeRegular() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMaximized()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::makeMaximized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMaximized() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMinimized()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::makeMinimized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMinimized() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ showWindow()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::showWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::showWindow() implementation.

Returns: Returns true.

Implements kanzi::WindowedGraphicsOutput.

◆ hideWindow()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::hideWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::hideWindow() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ bringToFront()

bool kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::bringToFront ( )

overridevirtualnoexcept

WindowedGraphicsOutput::bringToFront() implementation.

Returns: Returns false.

Implements kanzi::WindowedGraphicsOutput.

◆ getNativeWindowHandle()

KZ_NO_DISCARD optional< NativeWindowHandle > kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::getNativeWindowHandle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getNativeWindowHandle() implementation.

Return values

nullopt Getting the native window handle failed.

Returns: The handle of the associated window object.

Implements kanzi::WindowedGraphicsOutput.

◆ setTargetTransformation()

void kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::setTargetTransformation ( Matrix4x4 targetTransformation )

inlineprotectednoexcept

Sets the target transformation matrix.

Parameters

targetTransformation The target transformation matrix.

◆ updateCachedValues()

void kanzi::android_ws::DefaultAndroidWSEGLGraphicsOutput::updateCachedValues	(	unsigned int	width,
		unsigned int	height )

protectednoexcept

Updates all cached values from the given layout size.

Parameters

width	Layout area width in pixels.
height	Layout area height in pixels.

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

kanzi/core.ui/platform/graphics_output/android_ws_egl/default_android_ws_egl_graphics_output.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultAndroidWSEGLGraphicsOutput()

◆ ~DefaultAndroidWSEGLGraphicsOutput()

Member Function Documentation

◆ gatherEvents()

◆ getNativeEventHandle()

◆ getProcAddress()

◆ makeCurrent()

◆ releaseCurrent()

◆ swapBuffers()

◆ swapInterval()

◆ getTargetTransformation()

◆ getGraphicsContextAPI()

◆ getSurfaceClientAPI()

◆ getColorSpace()

◆ getNativeDisplayHandle()

◆ getNativeContextHandle()

◆ getNativeSurfaceHandle()

◆ createImage()

◆ destroyImage()

◆ listEGLConfigs()

◆ listCurrentEGLConfig()

◆ setWindowZOrder()

◆ resize()

◆ setWindowTitle()

◆ getWindowTitle()

◆ resizeWindow()

◆ getWindowWidth()

◆ getWindowHeight()

◆ moveWindow()

◆ getWindowPositionX()

◆ getWindowPositionY()

◆ makeFullscreen()

◆ makeRegular()

◆ makeMaximized()

◆ makeMinimized()

◆ showWindow()

◆ hideWindow()

◆ bringToFront()

◆ getNativeWindowHandle()

◆ setTargetTransformation()

◆ updateCachedValues()