Kanzi  3.9.5
Kanzi Engine API
kanzi::qnx Namespace Reference

Classes

class  DefaultQnxEGLGraphicsOutput
 Class representing a default QNX EGL graphics output. More...
 
struct  DefaultQnxEGLGraphicsOutputProperties
 
struct  DefaultQnxInputEventContext
 Structure representing the default context for an async input event. More...
 
class  DefaultQnxPulseHandler
 
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
 
class  QnxEGLWindow
 Class representing a Qnx EGL window. More...
 
class  QnxEvent
 Class representing a Qnx event. More...
 
class  QnxSigEvent
 Class representing Qnx sig 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...
 

Enumerations

enum  QnxPulseCode : int { QnxPulseCode::Disconnect, QnxPulseCode::Input }
 Qnx pulse codes. 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...
 
KZ_NO_DISCARD kanzi::KeyModifier qnxKeyModifiersToLogicalKeyModifiers (unsigned int qnxKeyModifiers) noexcept
 Maps native Qnx key modifiers to Kanzi logical key modifiers. More...
 
KZ_NO_DISCARD kanzi::LogicalKey qnxKeyToLogicalKey (unsigned int qnxKey) noexcept
 Maps native Qnx key to Kanzi logical key. 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 PointerButton translateQnxPointerButtonsToKanzi (int qnxPointerButtons) noexcept
 Translates Qnx pointer buttons to Kanzi pointer buttons. More...
 
KZ_NO_DISCARD optional< int > tryGetButtonsProperty (const QnxEvent &qnxEvent) noexcept
 Tries to get the buttons property (SCREEN_PROPERTY_BUTTONS) of the Qnx event. More...
 
KZ_NO_DISCARD optional< int > tryGetEventType (const QnxEvent &qnxEvent) noexcept
 Tries to get the type (SCREEN_PROPERTY_TYPE) of the Qnx event. More...
 
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. More...
 
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. More...
 
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. More...
 
KZ_NO_DISCARD optional< windowing::PositiontryGetPositionProperty (const QnxEvent &qnxEvent) noexcept
 Tries to get the position property (SCREEN_PROPERTY_POSITION) of the Qnx event. 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::SizeUtryGetWindowSizeU (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...
 

Variables

constexpr int QnxMouseButtonsBitMask
 Bitmask for Qnx mouse button events. 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.

Enumeration Type Documentation

◆ QnxPulseCode

enum kanzi::qnx::QnxPulseCode : int
strong

Qnx pulse codes.

Enumerator
Disconnect 
Input 

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
eglDisplayThe EGL display to use.
eglConfigThe 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
eglDisplayThe EGL display to use.
requirePbufferWhether 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
eglDisplayThe EGL display to use.
eglGraphicsFormatIDThe graphics format ID to use.
requirePbufferWhether pixel buffer support is required.
Returns
A compatible EGL config.

◆ qnxKeyToLogicalKey()

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

Maps native Qnx key to Kanzi logical key.

Parameters
qnxKeyThe 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
qnxKeyModifiersThe 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
qnxPointerButtonsQnx pointer buttons to translate.
Precondition
qnxPointerButtons must not be greater than the Qnx pointer button bitmask.
Returns
Translated Kanzi pointer buttons.

◆ 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
qnxEventQnx event to get the type of.
Return values
nulloptTrying 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
qnxEventQnx event to get the sym property of.
Return values
nulloptTrying 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
qnxEventQnx event to get the modifiers property of.
Return values
nulloptTrying 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
qnxEventQnx event to get the flags property of.
Return values
nulloptTrying 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
qnxEventQnx event to get the buttons property of.
Return values
nulloptTrying 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
qnxEventQnx event to get the position property of.
Return values
nulloptTrying 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
keyFlagsScreen 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
windowWindow to get the size for.
Return values
nulloptGetting the size failed.
Returns
Window size in pixels.

◆ setWindowTitle()

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

Sets a window title.

Parameters
windowWindow to set the title for.
windowTitleWindow 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
windowWindow to get the title from.
Return values
nulloptGetting the title failed.
Returns
True on success, false on failure.

◆ bringToFront()

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

Brings the window to forefront.

Parameters
windowWindow 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
windowReference to the window object.
idValue for pipeline ID.
Returns
True on success, false on failure.

Variable Documentation

◆ QnxMouseButtonsBitMask

constexpr int kanzi::qnx::QnxMouseButtonsBitMask

Bitmask for Qnx mouse button events.