Classes
class	DefaultQnxEGLGraphicsOutput
	Class representing a default QNX EGL graphics output. More...

struct	DefaultQnxEGLGraphicsOutputProperties
	The structure that represents the default QNX EGL graphics output properties. More...

struct	DefaultQnxInputEventContext
	Structure representing the default context for an async input event. More...

class	DefaultQnxPulseHandler

class	QnxBuffer
	Class representing a QNX buffer. More...

class	QnxChannelID
	Class representing QNX communication channel ID. More...

class	QnxConnectionID
	Class representing QNX connection ID. More...

class	QnxContext
	Class representing a QNX context. More...

class	QnxDisplay
	Class representing a QNX display. More...

class	QnxEGLPBufferGraphicsOutput
	Class representing a QNX EGL pixel buffer graphics output. More...

struct	QnxEGLPBufferGraphicsOutputProperties
	Properties required to construct a QnxEGLPBufferGraphicsOutput. More...

class	QnxEGLWindow
	Class representing a QNX EGL window. More...

class	QnxEvent
	Class representing a QNX event. More...

class	QnxPixmap
	Class representing a QNX pixmap. More...

struct	QnxPropertyFunctions
	Contains functions to access QNX properties for a particular QNX handle type. More...

class	QnxPropertyHost
	An interface to access and set QNX properties. More...

class	QnxSigEvent
	Class representing QNX sig event. More...

class	QnxStream
	Class representing a QNX stream. More...

class	QnxStreamEGLGraphicsOutput
	Class representing a EGL graphics output that renders into a QNX stream. More...

struct	QnxStreamEGLGraphicsOutputProperties
	The structure that represents the QNX Stream EGL graphics output properties. More...

class	QnxWindow
	Class representing a QNX window. More...

Enumerations
enum class	QnxBufferCleanupStrategy { CreateDestroy , AcquireRelease , None }
	Enumerator that represents QNX buffer resource management strategy. More...

enum class	QnxPulseCode : int { Disconnect , Input }
	QNX pulse codes. More...

Functions
bool	bringToFront (QnxWindow &window) noexcept
	Brings the window to forefront.

template<typename T , typename... Args>
auto	haltIfEmpty (T &&resource, Args &&... args) noexcept
	Forwards a supplied QNX resource.

template<typename T >
bool	isEmpty (const T &resource) noexcept
	Checks whether QNX resource contains an invalid handle.

bool	isKeyReleased (int keyFlags) noexcept
	Tests if key is released for a keyboard event.

KZ_NO_DISCARD kanzi::KeyModifier	qnxKeyModifiersToLogicalKeyModifiers (unsigned int qnxKeyModifiers) noexcept
	Maps native QNX key modifiers to Kanzi logical key modifiers.

KZ_NO_DISCARD kanzi::LogicalKey	qnxKeyToLogicalKey (unsigned int qnxKey) noexcept
	Maps native QNX key to Kanzi logical key.

bool	setWindowPipelineID (QnxWindow &window, int id) noexcept
	Sets pipeline ID for given window.

bool	setWindowTitle (QnxWindow &window, string_view windowTitle) noexcept
	Sets a window title.

KZ_NO_DISCARD PointerButton	translateQnxPointerButtonsToKanzi (int qnxPointerButtons) noexcept
	Translates QNX pointer buttons to Kanzi pointer buttons.

KZ_NO_DISCARD optional< int >	tryGetButtonsProperty (const QnxEvent &qnxEvent) noexcept
	Tries to get the buttons property (SCREEN_PROPERTY_BUTTONS) of the QNX event.

KZ_NO_DISCARD optional< int >	tryGetEventType (const QnxEvent &qnxEvent) noexcept
	Tries to get the type (SCREEN_PROPERTY_TYPE) of the QNX event.

KZ_NO_DISCARD optional< int >	tryGetFlagsProperty (const QnxEvent &qnxEvent) noexcept
	Tries to get the key flags property (SCREEN_PROPERTY_FLAGS for QNX version 700 and above or SCREEN_PROPERTY_KEY_FLAGS for below) of the QNX event.

KZ_NO_DISCARD optional< int >	tryGetKeySymProperty (const QnxEvent &qnxEvent) noexcept
	Tries to get the key sym property (SCREEN_PROPERTY_SYM for QNX version 700 and above or SCREEN_PROPERTY_KEY_SYM for below) of the QNX event.

KZ_NO_DISCARD optional< int >	tryGetModifiersProperty (const QnxEvent &qnxEvent) noexcept
	Tries to get the modifiers property (SCREEN_PROPERTY_MODIFIERS for QNX version 700 and above or SCREEN_PROPERTY_KEY_MODIFIERS for below) of the QNX event.

KZ_NO_DISCARD optional< windowing::Position >	tryGetPositionProperty (const QnxEvent &qnxEvent) noexcept
	Tries to get the position property (SCREEN_PROPERTY_POSITION) of the QNX event.

KZ_NO_DISCARD int	tryGetScreenUsageFlags (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig) noexcept
	Queries the screen usage flags for the given display and EGL config.

KZ_NO_DISCARD optional< windowing::SizeU >	tryGetWindowSizeU (const QnxWindow &window) noexcept
	Tries to get the size for this window in unsigned format.

KZ_NO_DISCARD optional< string >	tryGetWindowTitle (const QnxWindow &window) noexcept
	Tries to get the window title.

Variables
constexpr int	QnxMouseButtonsBitMask
	Bitmask for QNX mouse button events.

Enumeration Type Documentation

◆ QnxPulseCode

enum class kanzi::qnx::QnxPulseCode : int

strong

QNX pulse codes.

Enumerator
Disconnect
Input

◆ QnxBufferCleanupStrategy

enum class kanzi::qnx::QnxBufferCleanupStrategy

strong

Enumerator that represents QNX buffer resource management strategy.

Since: Kanzi 3.9.10

Enumerator
CreateDestroy	Used for creating and destroying buffers manually.
AcquireRelease	Used for managing buffers provided by QnxStream for stream consumer.
None	Used for buffers that are managed elsewhere.

Function Documentation

◆ tryGetScreenUsageFlags()

KZ_NO_DISCARD int kanzi::qnx::tryGetScreenUsageFlags	(	const EGLDisplay &	eglDisplay,
		const EGLConfig &	eglConfig )

noexcept

Queries the screen usage flags for the given display and EGL config.

Parameters

eglDisplay	The EGL display to use.
eglConfig	The EGL config to use.

Returns: The compatible screen usage flags. Zero for failure.

◆ qnxKeyToLogicalKey()

KZ_NO_DISCARD kanzi::LogicalKey kanzi::qnx::qnxKeyToLogicalKey ( unsigned int qnxKey )

noexcept

Maps native QNX key to Kanzi logical key.

Parameters

qnxKey The QNX key to map.

Returns: Logical key.

◆ qnxKeyModifiersToLogicalKeyModifiers()

KZ_NO_DISCARD kanzi::KeyModifier kanzi::qnx::qnxKeyModifiersToLogicalKeyModifiers ( unsigned int qnxKeyModifiers )

noexcept

Maps native QNX key modifiers to Kanzi logical key modifiers.

Parameters

qnxKeyModifiers The QNX key modifiers to map.

Returns: Logical key modifiers.

◆ translateQnxPointerButtonsToKanzi()

KZ_NO_DISCARD PointerButton kanzi::qnx::translateQnxPointerButtonsToKanzi ( int qnxPointerButtons )

noexcept

Translates QNX pointer buttons to Kanzi pointer buttons.

Parameters

qnxPointerButtons QNX pointer buttons to translate.

Precondition: qnxPointerButtons must not be greater than the QNX pointer button bitmask.

Returns: Translated Kanzi pointer buttons.

◆ isEmpty()

template<typename T >

bool kanzi::qnx::isEmpty ( const T & resource )

noexcept

Checks whether QNX resource contains an invalid handle.

Template Parameters

T	QNX resource type to check.

Parameters

resource Resource to check.

Returns: If resource is empty, true, otherwise false.

Since: Kanzi 3.9.10

◆ haltIfEmpty()

template<typename T , typename... Args>

auto kanzi::qnx::haltIfEmpty	(	T &&	resource,
		Args &&...	args )

noexcept

Forwards a supplied QNX resource.

If the resource is empty, calls kzHaltWithMessage.

Template Parameters

T	Resource type.
Args	Arguments to forward to kzHaltWithMessage.

Parameters

resource	QNX resource type.
args	Arguments to forward to kzHaltWithMessage.

Returns: The supplied QNX resource.

Since: Kanzi 3.9.10

◆ tryGetEventType()

KZ_NO_DISCARD optional< int > kanzi::qnx::tryGetEventType ( const QnxEvent & qnxEvent )

noexcept

Tries to get the type (SCREEN_PROPERTY_TYPE) of the QNX event.

Parameters

qnxEvent QNX event to get the type of.

Return values

nullopt Trying to get the type of the QNX event has failed.

Returns: QNX event type.

◆ tryGetKeySymProperty()

KZ_NO_DISCARD optional< int > kanzi::qnx::tryGetKeySymProperty ( const QnxEvent & qnxEvent )

noexcept

Tries to get the key sym property (SCREEN_PROPERTY_SYM for QNX version 700 and above or SCREEN_PROPERTY_KEY_SYM for below) of the QNX event.

Parameters

qnxEvent QNX event to get the sym property of.

Return values

nullopt Trying to get the key sym property has failed.

Returns: Key sym property.

◆ tryGetModifiersProperty()

KZ_NO_DISCARD optional< int > kanzi::qnx::tryGetModifiersProperty ( const QnxEvent & qnxEvent )

noexcept

Tries to get the modifiers property (SCREEN_PROPERTY_MODIFIERS for QNX version 700 and above or SCREEN_PROPERTY_KEY_MODIFIERS for below) of the QNX event.

Parameters

qnxEvent QNX event to get the modifiers property of.

Return values

nullopt Trying to get the modifiers property has failed.

Returns: Modifiers property.

◆ tryGetFlagsProperty()

KZ_NO_DISCARD optional< int > kanzi::qnx::tryGetFlagsProperty ( const QnxEvent & qnxEvent )

noexcept

Tries to get the key flags property (SCREEN_PROPERTY_FLAGS for QNX version 700 and above or SCREEN_PROPERTY_KEY_FLAGS for below) of the QNX event.

Parameters

qnxEvent QNX event to get the flags property of.

Return values

nullopt Trying to get the key flags property has failed.

Returns: Key flags property.

◆ tryGetButtonsProperty()

KZ_NO_DISCARD optional< int > kanzi::qnx::tryGetButtonsProperty ( const QnxEvent & qnxEvent )

noexcept

Tries to get the buttons property (SCREEN_PROPERTY_BUTTONS) of the QNX event.

Parameters

qnxEvent QNX event to get the buttons property of.

Return values

nullopt Trying to get the buttons property has failed.

Returns: Button property.

◆ tryGetPositionProperty()

KZ_NO_DISCARD optional< windowing::Position > kanzi::qnx::tryGetPositionProperty ( const QnxEvent & qnxEvent )

noexcept

Tries to get the position property (SCREEN_PROPERTY_POSITION) of the QNX event.

Parameters

qnxEvent QNX event to get the position property of.

Return values

nullopt Trying to get the position property has failed.

Returns: Position property.

◆ isKeyReleased()

bool kanzi::qnx::isKeyReleased ( int keyFlags )

noexcept

Tests if key is released for a keyboard event.

Parameters

keyFlags Screen property flags.

Returns: True if released, otherwise false.

◆ tryGetWindowSizeU()

KZ_NO_DISCARD optional< windowing::SizeU > kanzi::qnx::tryGetWindowSizeU ( const QnxWindow & window )

noexcept

Tries to get the size for this window in unsigned format.

Parameters

window Window to get the size for.

Return values

nullopt Getting the size failed.

Returns: Window size in pixels.

◆ setWindowTitle()

bool kanzi::qnx::setWindowTitle	(	QnxWindow &	window,
		string_view	windowTitle )

noexcept

Sets a window title.

Parameters

window	Window to set the title for.
windowTitle	Window title to set.

Returns: True on success, false on failure.

◆ tryGetWindowTitle()

KZ_NO_DISCARD optional< string > kanzi::qnx::tryGetWindowTitle ( const QnxWindow & window )

noexcept

Tries to get the window title.

Parameters

window Window to get the title from.

Return values

nullopt Getting the title failed.

Returns: True on success, false on failure.

◆ bringToFront()

bool kanzi::qnx::bringToFront ( QnxWindow & window )

noexcept

Brings the window to forefront.

Parameters

window Window to bring to front.

Returns: True on success, false on failure.

◆ setWindowPipelineID()

bool kanzi::qnx::setWindowPipelineID	(	QnxWindow &	window,
		int	id )

noexcept

Sets pipeline ID for given window.

Sets also SCREEN_USAGE_OVERLAY usage flag.

Parameters

window	Reference to the window object.
id	Value for pipeline ID.

Returns: True on success, false on failure.

Variable Documentation

◆ QnxMouseButtonsBitMask

constexpr int kanzi::qnx::QnxMouseButtonsBitMask

constexpr

Bitmask for QNX mouse button events.

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ QnxPulseCode

◆ QnxBufferCleanupStrategy

Function Documentation

◆ tryGetScreenUsageFlags()

◆ qnxKeyToLogicalKey()

◆ qnxKeyModifiersToLogicalKeyModifiers()

◆ translateQnxPointerButtonsToKanzi()

◆ isEmpty()

◆ haltIfEmpty()

◆ tryGetEventType()

◆ tryGetKeySymProperty()

◆ tryGetModifiersProperty()

◆ tryGetFlagsProperty()

◆ tryGetButtonsProperty()

◆ tryGetPositionProperty()

◆ isKeyReleased()

◆ tryGetWindowSizeU()

◆ setWindowTitle()

◆ tryGetWindowTitle()

◆ bringToFront()

◆ setWindowPipelineID()

Variable Documentation

◆ QnxMouseButtonsBitMask