Kanzi 3.9.10
kanzi::qnx::QnxPixmap Class Reference

Class representing a QNX pixmap. More...

#include <kanzi/core.ui/platform/windowing_ng/qnx_screen/qnx_screen_pixmap.hpp>

Inheritance diagram for kanzi::qnx::QnxPixmap:
[legend]

Public Types

using NativeHandleType
 Alias for underlying native handle type.
 

Public Member Functions

bool createBuffer () noexcept
 Creates a buffer for this pixmap.
 
bool destroyBuffer () noexcept
 Destroys a buffer allocated for this pixmap.
 
KZ_NO_DISCARD NativeHandleType getNativeHandle () const noexcept
 Gets underlying native handle.
 
QnxPixmapoperator= (const QnxPixmap &other)=delete
 Copy assignment operator.
 
QnxPixmapoperator= (QnxPixmap &&other) noexcept
 Move assignment operator.
 
 QnxPixmap () noexcept
 Constructor.
 
 QnxPixmap (const NativeHandleType nativeHandle) noexcept
 Constructor.
 
 QnxPixmap (const QnxPixmap &other)=delete
 Copy constructor.
 
 QnxPixmap (QnxPixmap &&other) noexcept
 Move constructor.
 
KZ_NO_DISCARD QnxBuffer< QnxBufferCleanupStrategy::NoneretrieveBuffer () const noexcept
 Retrieves QNX buffer used by this pixmap.
 
void swap (QnxPixmap &other) noexcept
 Swap function.
 
 ~QnxPixmap ()
 Destructor.
 
- Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxPixmap >
KZ_NO_DISCARD optional< string > tryGetPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
 Gets QNX property consisting of a string.
 
KZ_NO_DISCARD optional< vector< int > > tryGetPropertyIv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of ints.
 
KZ_NO_DISCARD optional< int > tryGetPropertyIvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single int.
 
KZ_NO_DISCARD optional< vector< long long > > tryGetPropertyLlv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of long longs.
 
KZ_NO_DISCARD optional< long long > tryGetPropertyLlvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single long long.
 
KZ_NO_DISCARD optional< vector< T > > tryGetPropertyPv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of pointers.
 
KZ_NO_DISCARD optional< T > tryGetPropertyPvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single pointer.
 
bool trySetPropertyCv (int propertyName, string_view propertyValue) noexcept
 Sets QNX property consisting of a string.
 
bool trySetPropertyIv (int propertyName, int propertyValue) noexcept
 Sets QNX property consisting of a single int.
 
bool trySetPropertyIv (int propertyName, span< int > propertyValue) noexcept
 Sets QNX property consisting of ints.
 
bool trySetPropertyLlv (int propertyName, long long propertyValue) noexcept
 Sets QNX property consisting of a single long long.
 
bool trySetPropertyLlv (int propertyName, span< long long > propertyValue) noexcept
 Sets QNX property consisting of long longs.
 
bool trySetPropertyPv (int propertyName, span< void * > propertyValue) noexcept
 Sets QNX property consisting of pointers.
 
bool trySetPropertyPv (int propertyName, void *propertyValue) noexcept
 Sets QNX property consisting of a single pointer.
 

Static Public Member Functions

static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleTypegetQnxPropertyFunctions () noexcept
 Creates QNX property functions for this resource.
 
static KZ_NO_DISCARD QnxPixmap tryCreate (const QnxContext &qnxContext) noexcept
 Tries to create a QNX pixmap.
 

Detailed Description

Class representing a QNX pixmap.

Since
Kanzi 3.9.10

Member Typedef Documentation

◆ NativeHandleType

Alias for underlying native handle type.

Constructor & Destructor Documentation

◆ QnxPixmap() [1/4]

kanzi::qnx::QnxPixmap::QnxPixmap ( )
explicitnoexcept

Constructor.

◆ QnxPixmap() [2/4]

kanzi::qnx::QnxPixmap::QnxPixmap ( const NativeHandleType nativeHandle)
explicitnoexcept

Constructor.

Parameters
nativeHandleNative handle.

◆ ~QnxPixmap()

kanzi::qnx::QnxPixmap::~QnxPixmap ( )

Destructor.

◆ QnxPixmap() [3/4]

kanzi::qnx::QnxPixmap::QnxPixmap ( const QnxPixmap & other)
delete

Copy constructor.

◆ QnxPixmap() [4/4]

kanzi::qnx::QnxPixmap::QnxPixmap ( QnxPixmap && other)
noexcept

Move constructor.

Member Function Documentation

◆ tryCreate()

static KZ_NO_DISCARD QnxPixmap kanzi::qnx::QnxPixmap::tryCreate ( const QnxContext & qnxContext)
staticnoexcept

Tries to create a QNX pixmap.

Parameters
qnxContextQNX context.
Returns
The created object. If error occurred, empty.

◆ operator=() [1/2]

QnxPixmap & kanzi::qnx::QnxPixmap::operator= ( const QnxPixmap & other)
delete

Copy assignment operator.

◆ operator=() [2/2]

QnxPixmap & kanzi::qnx::QnxPixmap::operator= ( QnxPixmap && other)
noexcept

Move assignment operator.

◆ swap()

void kanzi::qnx::QnxPixmap::swap ( QnxPixmap & other)
noexcept

Swap function.

Parameters
otherThe object with which to swap.

◆ getNativeHandle()

KZ_NO_DISCARD NativeHandleType kanzi::qnx::QnxPixmap::getNativeHandle ( ) const
noexcept

Gets underlying native handle.

Returns
Native handle.

◆ retrieveBuffer()

KZ_NO_DISCARD QnxBuffer< QnxBufferCleanupStrategy::None > kanzi::qnx::QnxPixmap::retrieveBuffer ( ) const
noexcept

Retrieves QNX buffer used by this pixmap.

Returns
QNX buffer used by this pixmap. If an error occurred, empty.

◆ createBuffer()

bool kanzi::qnx::QnxPixmap::createBuffer ( )
noexcept

Creates a buffer for this pixmap.

Returns
True on success, false on failure.

◆ destroyBuffer()

bool kanzi::qnx::QnxPixmap::destroyBuffer ( )
noexcept

Destroys a buffer allocated for this pixmap.

Returns
True on success, false on failure.

◆ getQnxPropertyFunctions()

static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleType > kanzi::qnx::QnxPixmap::getQnxPropertyFunctions ( )
inlinestaticconstexprnoexcept

Creates QNX property functions for this resource.

Returns
The QnxPropertyFunctions struct for this resource.

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