Kanzi 3.9.10
kanzi::qnx::QnxBuffer< cleanupStrategy > Class Template Reference

Class representing a QNX buffer. More...

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

Inheritance diagram for kanzi::qnx::QnxBuffer< cleanupStrategy >:
[legend]

Public Types

using NativeHandleType
 Alias for underlying native handle type.
 

Public Member Functions

KZ_NO_DISCARD NativeHandleType getNativeHandle () const noexcept
 Gets underlying native handle.
 
QnxBufferoperator= (const QnxBuffer &other)=delete
 Copy assignment operator.
 
QnxBufferoperator= (QnxBuffer &&other) noexcept
 Move assignment operator.
 
 QnxBuffer () noexcept
 Constructor.
 
 QnxBuffer (const NativeHandleType nativeHandle) noexcept
 Constructor.
 
 QnxBuffer (const QnxBuffer &other)=delete
 Copy constructor.
 
 QnxBuffer (QnxBuffer &&other) noexcept
 Move constructor.
 
void swap (QnxBuffer &other) noexcept
 Swap function.
 
 ~QnxBuffer ()
 Destructor.
 
- Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxBuffer< cleanupStrategy > >
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< typename QnxBuffer< cleanupStrategy >::NativeHandleTypegetQnxPropertyFunctions () noexcept
 Creates QNX property functions for this resource.
 
template<QnxBufferCleanupStrategy c = cleanupStrategy, enable_if_t< c==QnxBufferCleanupStrategy::CreateDestroy, bool > = false>
static KZ_NO_DISCARD QnxBuffer tryCreate () noexcept
 Tries to create a QNX buffer.
 
template<QnxBufferCleanupStrategy c = cleanupStrategy, enable_if_t< c==QnxBufferCleanupStrategy::AcquireRelease, bool > = false>
static KZ_NO_DISCARD QnxBuffer tryCreate (const QnxStream &qnxStream) noexcept
 Tries to create a QNX buffer.
 

Detailed Description

template<QnxBufferCleanupStrategy cleanupStrategy>
class kanzi::qnx::QnxBuffer< cleanupStrategy >

Class representing a QNX buffer.

Template Parameters
cleanupStrategyCleanup strategy to use.
See also
QnxBufferCleanupStrategy for more details.
Since
Kanzi 3.9.10

Member Typedef Documentation

◆ NativeHandleType

template<QnxBufferCleanupStrategy cleanupStrategy>
using kanzi::qnx::QnxBuffer< cleanupStrategy >::NativeHandleType

Alias for underlying native handle type.

Constructor & Destructor Documentation

◆ QnxBuffer() [1/4]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBuffer< cleanupStrategy >::QnxBuffer ( )
inlineexplicitnoexcept

Constructor.

◆ QnxBuffer() [2/4]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBuffer< cleanupStrategy >::QnxBuffer ( const NativeHandleType nativeHandle)
inlineexplicitnoexcept

Constructor.

Parameters
nativeHandleNative handle.

◆ ~QnxBuffer()

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBuffer< cleanupStrategy >::~QnxBuffer ( )
inline

Destructor.

◆ QnxBuffer() [3/4]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBuffer< cleanupStrategy >::QnxBuffer ( const QnxBuffer< cleanupStrategy > & other)
delete

Copy constructor.

◆ QnxBuffer() [4/4]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBuffer< cleanupStrategy >::QnxBuffer ( QnxBuffer< cleanupStrategy > && other)
inlinenoexcept

Move constructor.

Member Function Documentation

◆ tryCreate() [1/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
static KZ_NO_DISCARD QnxBuffer kanzi::qnx::QnxBuffer< cleanupStrategy >::tryCreate ( )
inlinestaticnoexcept

Tries to create a QNX buffer.

Returns
The created object. If error occurred, empty.

◆ tryCreate() [2/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
static KZ_NO_DISCARD QnxBuffer kanzi::qnx::QnxBuffer< cleanupStrategy >::tryCreate ( const QnxStream & qnxStream)
inlinestaticnoexcept

Tries to create a QNX buffer.

Parameters
qnxStreamQNX stream that is used to request buffer.
Returns
The created object. If error occurred, empty.

◆ operator=() [1/2]

Copy assignment operator.

◆ operator=() [2/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
QnxBuffer & kanzi::qnx::QnxBuffer< cleanupStrategy >::operator= ( QnxBuffer< cleanupStrategy > && other)
inlinenoexcept

Move assignment operator.

◆ swap()

template<QnxBufferCleanupStrategy cleanupStrategy>
void kanzi::qnx::QnxBuffer< cleanupStrategy >::swap ( QnxBuffer< cleanupStrategy > & other)
inlinenoexcept

Swap function.

Parameters
otherThe object with which to swap.

◆ getNativeHandle()

template<QnxBufferCleanupStrategy cleanupStrategy>
KZ_NO_DISCARD NativeHandleType kanzi::qnx::QnxBuffer< cleanupStrategy >::getNativeHandle ( ) const
inlinenoexcept

Gets underlying native handle.

Returns
Native handle.

◆ getQnxPropertyFunctions()

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: