Kanzi  3.9.5
Kanzi Engine API
kanzi::qnx::QnxEGLWindow Class Reference

Class representing a Qnx EGL window. More...

#include <kanzi/core.ui/platform/windowing_ng/qnx_egl/qnx_egl_window.hpp>

Public Member Functions

bool createBuffers (int bufferCount) noexcept
 Creates buffers for this window. More...
 
bool makeCurrent (const EGLDisplay &eglDisplay, const EGLContext &eglContext) noexcept
 Binds a window surface to a context and the current thread. More...
 
 QnxEGLWindow (const QnxContext &qnxContext, int bufferCount, int usageFlags)
 Constructor. More...
 
 QnxEGLWindow (const QnxContext &qnxContext, const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, int bufferCount, int usageFlags)
 Constructor. More...
 
bool setPosition (windowing::Position windowPosition) noexcept
 Sets position for this window. More...
 
bool setPropertyDisplay (const QnxDisplay &qnxDisplay) noexcept
 Sets the display for this window. More...
 
bool setSize (windowing::Size windowSize) noexcept
 Sets size for this window. More...
 
bool setTitle (string_view windowTitle) noexcept
 Sets a window title. More...
 
bool setUsageFlags (int usageFlags) noexcept
 Sets usage flags for this window. More...
 
bool setZOrder (int zorder) noexcept
 Sets z-order for this window. More...
 
bool show () noexcept
 Shows this window. More...
 
bool swapBuffers (const EGLDisplay &eglDisplay) const
 Posts rendering results. More...
 
KZ_NO_DISCARD optional< windowing::SizetryGetSize () const noexcept
 Tries to get the size for this window. More...
 

Detailed Description

Class representing a Qnx EGL window.

Constructor & Destructor Documentation

◆ QnxEGLWindow() [1/2]

kanzi::qnx::QnxEGLWindow::QnxEGLWindow ( const QnxContext qnxContext,
int  bufferCount,
int  usageFlags 
)
explicit

Constructor.

Parameters
qnxContextQnx context.
bufferCountAmount of buffers to create for a window.
usageFlagsUsage flag bit mask to use for a window.

◆ QnxEGLWindow() [2/2]

kanzi::qnx::QnxEGLWindow::QnxEGLWindow ( const QnxContext qnxContext,
const EGLDisplay eglDisplay,
const EGLConfig eglConfig,
int  bufferCount,
int  usageFlags 
)
explicit

Constructor.

Parameters
qnxContextQnx context.
eglDisplayEGL display.
eglConfigEGL config.
bufferCountAmount of buffers to create for a window.
usageFlagsUsage flag bit mask to use for a window.

Member Function Documentation

◆ makeCurrent()

bool kanzi::qnx::QnxEGLWindow::makeCurrent ( const EGLDisplay eglDisplay,
const EGLContext eglContext 
)
inlinenoexcept

Binds a window surface to a context and the current thread.

Parameters
eglDisplayEGL display connection of the EGL context.
eglContextEGL context to bind to.
Returns
True on success, false on failure.

◆ swapBuffers()

bool kanzi::qnx::QnxEGLWindow::swapBuffers ( const EGLDisplay eglDisplay) const
inline

Posts rendering results.

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

Parameters
eglDisplayEGL display connection.
See also
swapInterval().
Returns
True on success, false on failure.
Postcondition
egl::getError() returns EGL_SUCCESS.

◆ show()

bool kanzi::qnx::QnxEGLWindow::show ( )
inlinenoexcept

Shows this window.

Returns
True on success, false on failure.

◆ tryGetSize()

KZ_NO_DISCARD optional<windowing::Size> kanzi::qnx::QnxEGLWindow::tryGetSize ( ) const
inlinenoexcept

Tries to get the size for this window.

Return values
nulloptGetting the size failed.
Returns
Window size in pixels.

◆ setSize()

bool kanzi::qnx::QnxEGLWindow::setSize ( windowing::Size  windowSize)
inlinenoexcept

Sets size for this window.

Parameters
windowSizeWindow size to set in pixels.
Returns
True on success, false on failure.

◆ setPosition()

bool kanzi::qnx::QnxEGLWindow::setPosition ( windowing::Position  windowPosition)
inlinenoexcept

Sets position for this window.

Child window and embedded window positions are relative to their parent window positions.

Parameters
windowPositionWindow position to set in pixels.
Returns
True on success, false on failure.

◆ setUsageFlags()

bool kanzi::qnx::QnxEGLWindow::setUsageFlags ( int  usageFlags)
inlinenoexcept

Sets usage flags for this window.

Parameters
usageFlagsUsage flag bit mask to use.
Returns
True on success, false on failure.

◆ setZOrder()

bool kanzi::qnx::QnxEGLWindow::setZOrder ( int  zorder)
inlinenoexcept

Sets z-order for this window.

Parameters
zorderZ order to set.
Returns
True on success, false on failure.

◆ setTitle()

bool kanzi::qnx::QnxEGLWindow::setTitle ( string_view  windowTitle)
inlinenoexcept

Sets a window title.

Parameters
windowTitleWindow title to set.
Returns
True on success, false on failure.

◆ createBuffers()

bool kanzi::qnx::QnxEGLWindow::createBuffers ( int  bufferCount)
inlinenoexcept

Creates buffers for this window.

Parameters
bufferCountAmount of buffers to create.
Returns
True on success, false on failure.

◆ setPropertyDisplay()

bool kanzi::qnx::QnxEGLWindow::setPropertyDisplay ( const QnxDisplay qnxDisplay)
inlinenoexcept

Sets the display for this window.

Parameters
qnxDisplayDisplay to set.
Returns
True on success, false on failure.

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