kanzi::qnx Namespace Reference

Classes
class	DefaultQnxEGLGraphicsOutput
	Class representing a default QNX EGL graphics output. More...
struct	DefaultQnxEGLGraphicsOutputProperties
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
class	QnxEGLWindow
	Class representing a Qnx EGL window. More...
class	QnxEvent
	Class representing a Qnx event. More...
class	QnxWindow
	Class representing a Qnx window. More...

Typedefs
typedef screen_context_t	QnxScreenContextHandleType
	Alias for the Qnx context handle type. More...
typedef screen_display_t	QnxScreenDisplayHandleType
	Alias for the Qnx display handle type. More...
typedef screen_event_t	QnxScreenEventHandleType
	Alias for the Qnx event handle type. More...
typedef screen_window_t	QnxScreenWindowHandleType
	Alias for the Qnx window handle type. More...

Functions
bool	bringToFront (QnxWindow &window) noexcept
	Brings the window to forefront. More...
KZ_NO_DISCARD ::EGLConfig	findBestEGLConfig (const EGLDisplay &eglDisplay, bool requirePbuffer) noexcept
	Finds the best matching EGL config for the given display and EGL config. More...
KZ_NO_DISCARD ::EGLConfig	getEGLConfigForID (const EGLDisplay &eglDisplay, int eglGraphicsFormatID, bool requirePbuffer) noexcept
	Returns an EGL config for the given display and graphics format ID. More...
bool	isKeyReleased (int keyFlags) noexcept
	Tests if key is released for a keyboard event. More...
bool	setWindowPipelineID (QnxWindow &window, int id) noexcept
	Sets pipeline ID for given window. More...
bool	setWindowTitle (QnxWindow &window, string_view windowTitle) noexcept
	Sets a window title. More...
KZ_NO_DISCARD optional< int >	tryGetEventType (const QnxEvent &qnxEvent) noexcept
	Gets Qnx event type. More...
KZ_NO_DISCARD int	tryGetScreenUsageFlags (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig) noexcept
	Queries the screen usage flags for the given display and EGL config. More...
KZ_NO_DISCARD optional< windowing::SizeU >	tryGetWindowSizeU (const QnxWindow &window) noexcept
	Tries to get the size for this window in unsigned format. More...
KZ_NO_DISCARD optional< string >	tryGetWindowTitle (const QnxWindow &window) noexcept
	Tries to get the window title. More...

Typedef Documentation

QnxScreenContextHandleType

typedef screen_context_t kanzi::qnx::QnxScreenContextHandleType

Alias for the Qnx context handle type.

QnxScreenDisplayHandleType

typedef screen_display_t kanzi::qnx::QnxScreenDisplayHandleType

Alias for the Qnx display handle type.

QnxScreenEventHandleType

typedef screen_event_t kanzi::qnx::QnxScreenEventHandleType

Alias for the Qnx event handle type.

QnxScreenWindowHandleType

typedef screen_window_t kanzi::qnx::QnxScreenWindowHandleType

Alias for the Qnx window handle type.

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.

findBestEGLConfig()

KZ_NO_DISCARD ::EGLConfig kanzi::qnx::findBestEGLConfig ( const EGLDisplay &  eglDisplay, bool  requirePbuffer  )

noexcept

Finds the best matching EGL config for the given display and EGL config.

Parameters

eglDisplay	The EGL display to use.
requirePbuffer	Whether pixel buffer support is required.

Returns

The best matching EGL config.

getEGLConfigForID()

KZ_NO_DISCARD ::EGLConfig kanzi::qnx::getEGLConfigForID ( const EGLDisplay &  eglDisplay, int  eglGraphicsFormatID, bool  requirePbuffer  )

noexcept

Returns an EGL config for the given display and graphics format ID.

Halts on failure.

Parameters

eglDisplay	The EGL display to use.
eglGraphicsFormatID	The graphics format ID to use.
requirePbuffer	Whether pixel buffer support is required.

Returns

A compatible EGL config.

tryGetEventType()

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

noexcept

Gets Qnx event type.

Parameters

qnxEvent

Qnx event.

Return values

nullopt

Trying to get event type has failed.

Returns

Event type.

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.