Kanzi 4.0.0-beta2
kanzi::qnx::QnxBufferMethods< cleanupStrategy > Class Template Reference

Class representing QNX buffer methods. More...

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

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

Public Types

using HandleType
 
using NativeHandleType
 

Protected Member Functions

 QnxBufferMethods () noexcept=default
 Constructor.
 
 QnxBufferMethods (const NativeHandleType &handle) noexcept
 Constructor.
 
- Protected Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxBufferMethods< cleanupStrategy >, KANZI_GENERATE_QNX_PROPERTY_HOST_SIGNATURE(buffer)>
KZ_NO_DISCARD optional< string > getPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
 Gets QNX property consisting of a string.
 
KZ_NO_DISCARD optional< vector< int > > getPropertyIv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of ints.
 
KZ_NO_DISCARD optional< int > getPropertyIvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single int.
 
KZ_NO_DISCARD optional< vector< long long > > getPropertyLlv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of long longs.
 
KZ_NO_DISCARD optional< long long > getPropertyLlvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single long long.
 
KZ_NO_DISCARD optional< vector< T > > getPropertyPv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of pointers.
 
KZ_NO_DISCARD optional< T > getPropertyPvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single pointer.
 
bool setPropertyCv (int propertyName, string_view propertyValue) const noexcept
 Sets QNX property consisting of a string.
 
bool setPropertyIv (int propertyName, int propertyValue) const noexcept
 Sets QNX property consisting of a single int.
 
bool setPropertyIv (int propertyName, span< int > propertyValue) const noexcept
 Sets QNX property consisting of ints.
 
bool setPropertyLlv (int propertyName, long long propertyValue) const noexcept
 Sets QNX property consisting of a single long long.
 
bool setPropertyLlv (int propertyName, span< long long > propertyValue) const noexcept
 Sets QNX property consisting of long longs.
 
bool setPropertyPv (int propertyName, span< void * > propertyValue) const noexcept
 Sets QNX property consisting of pointers.
 
bool setPropertyPv (int propertyName, void *propertyValue) const noexcept
 Sets QNX property consisting of a single pointer.
 

Static Protected Member Functions

template<QnxBufferCleanupStrategy c = cleanupStrategy, typename = enable_if_t<c == QnxBufferCleanupStrategy::CreateDestroy>>
static KZ_NO_DISCARD QnxBufferMethods create () noexcept
 Tries to create a QNX buffer.
 
template<QnxBufferCleanupStrategy c = cleanupStrategy, typename = enable_if_t<c == QnxBufferCleanupStrategy::AcquireRelease>>
static KZ_NO_DISCARD QnxBufferMethods create (const QnxStream::NativeHandleType &qnxStream) noexcept
 Tries to create a QNX buffer.
 

Additional Inherited Members

- Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxBufferMethods< cleanupStrategy >, KANZI_GENERATE_QNX_PROPERTY_HOST_SIGNATURE(buffer)>
KZ_NO_DISCARD optional< string > getPropertyCv (size_t stringBufferSize, int propertyName) const noexcept
 Gets QNX property consisting of a string.
 
KZ_NO_DISCARD optional< vector< int > > getPropertyIv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of ints.
 
KZ_NO_DISCARD optional< int > getPropertyIvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single int.
 
KZ_NO_DISCARD optional< vector< long long > > getPropertyLlv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of long longs.
 
KZ_NO_DISCARD optional< long long > getPropertyLlvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single long long.
 
KZ_NO_DISCARD optional< vector< T > > getPropertyPv (size_t returnValueCount, int propertyName) const noexcept
 Gets QNX property consisting of pointers.
 
KZ_NO_DISCARD optional< T > getPropertyPvSingle (int propertyName) const noexcept
 Gets a QNX property consisting of a single pointer.
 
bool setPropertyCv (int propertyName, string_view propertyValue) const noexcept
 Sets QNX property consisting of a string.
 
bool setPropertyIv (int propertyName, int propertyValue) const noexcept
 Sets QNX property consisting of a single int.
 
bool setPropertyIv (int propertyName, span< int > propertyValue) const noexcept
 Sets QNX property consisting of ints.
 
bool setPropertyLlv (int propertyName, long long propertyValue) const noexcept
 Sets QNX property consisting of a single long long.
 
bool setPropertyLlv (int propertyName, span< long long > propertyValue) const noexcept
 Sets QNX property consisting of long longs.
 
bool setPropertyPv (int propertyName, span< void * > propertyValue) const noexcept
 Sets QNX property consisting of pointers.
 
bool setPropertyPv (int propertyName, void *propertyValue) const noexcept
 Sets QNX property consisting of a single pointer.
 

Detailed Description

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

Class representing QNX buffer methods.

Note
Do not use this class directly. Use QnxBuffer instead.
See also
QnxBuffer
Template Parameters
cleanupStrategyCleanup strategy to use.
See also
QnxBufferCleanupStrategy for more details.
Since
Kanzi 4.0.0
Kanzi 4.0.0 QnxBuffer is now a safe wrapper around QnxBufferMethods.

Member Typedef Documentation

◆ HandleType

◆ NativeHandleType

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

Constructor & Destructor Documentation

◆ QnxBufferMethods() [1/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBufferMethods< cleanupStrategy >::QnxBufferMethods ( )
explicitprotecteddefaultnoexcept

Constructor.

◆ QnxBufferMethods() [2/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
kanzi::qnx::QnxBufferMethods< cleanupStrategy >::QnxBufferMethods ( const NativeHandleType & handle)
inlineexplicitprotectednoexcept

Constructor.

Parameters
handleNative handle.

Member Function Documentation

◆ create() [1/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
template<QnxBufferCleanupStrategy c = cleanupStrategy, typename = enable_if_t<c == QnxBufferCleanupStrategy::CreateDestroy>>
static KZ_NO_DISCARD QnxBufferMethods kanzi::qnx::QnxBufferMethods< cleanupStrategy >::create ( )
inlinestaticprotectednoexcept

Tries to create a QNX buffer.

Returns
The created object. If error occurred, empty.

◆ create() [2/2]

template<QnxBufferCleanupStrategy cleanupStrategy>
template<QnxBufferCleanupStrategy c = cleanupStrategy, typename = enable_if_t<c == QnxBufferCleanupStrategy::AcquireRelease>>
static KZ_NO_DISCARD QnxBufferMethods kanzi::qnx::QnxBufferMethods< cleanupStrategy >::create ( const QnxStream::NativeHandleType & qnxStream)
inlinestaticprotectednoexcept

Tries to create a QNX buffer.

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

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