Class representing a QNX stream. More...

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

Inheritance diagram for kanzi::qnx::QnxStream:

Public Types
using	NativeHandleType
	Alias for underlying native handle type.

Public Member Functions
QnxBuffer< QnxBufferCleanupStrategy::AcquireRelease >	acquireBuffer () const noexcept
	Acquires a buffer from the stream.

template<QnxBufferCleanupStrategy cleanupStrategy>
bool	attachBuffer (const QnxBuffer< cleanupStrategy > &buffer) const noexcept
	Attaches a single buffer to the stream.

template<QnxBufferCleanupStrategy cleanupStrategy>
bool	attachBuffers (span< QnxBuffer< cleanupStrategy > > buffers) const noexcept
	Attaches buffers to the stream.

bool	consumeStream (const QnxStream &producer) const noexcept
	Consumes stream.

bool	createBuffers (size_t bufferCount) const noexcept
	Creates buffers for this stream.

bool	destroyBuffers () const noexcept
	Destroys buffers allocated for this stream.

KZ_NO_DISCARD NativeHandleType	getNativeHandle () const noexcept
	Gets underlying native handle.

QnxStream &	operator= (const QnxStream &other)=delete
	Copy assignment operator.

QnxStream &	operator= (QnxStream &&other) noexcept
	Move assignment operator.

template<QnxBufferCleanupStrategy cleanupStrategy>
bool	postBuffer (const QnxBuffer< cleanupStrategy > &buffer) const noexcept
	Submits screen buffer to the stream.

	QnxStream () noexcept
	Constructor.

	QnxStream (const NativeHandleType nativeHandle) noexcept
	Constructor.

	QnxStream (const QnxStream &other)=delete
	Copy constructor.

	QnxStream (QnxStream &&other) noexcept
	Move constructor.

void	swap (QnxStream &other) noexcept
	Swap function.

KZ_NO_DISCARD QnxBuffer< QnxBufferCleanupStrategy::None >	tryRetrieveFrontBuffer () const noexcept
	Retrieves QNX buffer used by this stream.

	~QnxStream ()
	Destructor.

Public Member Functions inherited from kanzi::qnx::QnxPropertyHost< QnxStream >
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< NativeHandleType >	getQnxPropertyFunctions () noexcept
	Creates QNX property functions for this resource.

static KZ_NO_DISCARD QnxStream	tryCreate (const NativeHandleType handle) noexcept
	Tries to create an object from a native handle.

static KZ_NO_DISCARD QnxStream	tryCreate (const QnxContext &qnxContext) noexcept
	Tries to create a QNX stream.

Detailed Description

Class representing a QNX stream.

Since: Kanzi 3.9.10

Member Typedef Documentation

◆ NativeHandleType

using kanzi::qnx::QnxStream::NativeHandleType

Alias for underlying native handle type.

Constructor & Destructor Documentation

◆ QnxStream() [1/4]

kanzi::qnx::QnxStream::QnxStream ( )

explicitnoexcept

Constructor.

◆ QnxStream() [2/4]

kanzi::qnx::QnxStream::QnxStream ( const NativeHandleType nativeHandle )

explicitnoexcept

Constructor.

Parameters

nativeHandle Native handle.

◆ ~QnxStream()

kanzi::qnx::QnxStream::~QnxStream ( )

Destructor.

◆ QnxStream() [3/4]

kanzi::qnx::QnxStream::QnxStream ( const QnxStream & other )

delete

Copy constructor.

◆ QnxStream() [4/4]

kanzi::qnx::QnxStream::QnxStream ( QnxStream && other )

noexcept

Move constructor.

Member Function Documentation

◆ tryCreate() [1/2]

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

staticnoexcept

Tries to create a QNX stream.

Parameters

qnxContext QNX context.

Returns: The created object. If error occurred, empty.

◆ tryCreate() [2/2]

static KZ_NO_DISCARD QnxStream kanzi::qnx::QnxStream::tryCreate ( const NativeHandleType handle )

staticnoexcept

Tries to create an object from a native handle.

Parameters

handle Native handle.

Returns: Optional-like object. If an error occurred, empty.

◆ operator=() [1/2]

QnxStream & kanzi::qnx::QnxStream::operator= ( const QnxStream & other )

delete

Copy assignment operator.

◆ operator=() [2/2]

QnxStream & kanzi::qnx::QnxStream::operator= ( QnxStream && other )

noexcept

Move assignment operator.

◆ swap()

void kanzi::qnx::QnxStream::swap ( QnxStream & other )

noexcept

Swap function.

Parameters

other The object with which to swap.

◆ getNativeHandle()

KZ_NO_DISCARD NativeHandleType kanzi::qnx::QnxStream::getNativeHandle ( ) const

noexcept

Gets underlying native handle.

Returns: Native handle.

◆ tryRetrieveFrontBuffer()

KZ_NO_DISCARD QnxBuffer< QnxBufferCleanupStrategy::None > kanzi::qnx::QnxStream::tryRetrieveFrontBuffer ( ) const

noexcept

Retrieves QNX buffer used by this stream.

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

◆ createBuffers()

bool kanzi::qnx::QnxStream::createBuffers ( size_t bufferCount ) const

noexcept

Creates buffers for this stream.

Parameters

bufferCount Amount of buffers to create.

Returns: True on success, false on failure.

◆ destroyBuffers()

bool kanzi::qnx::QnxStream::destroyBuffers ( ) const

noexcept

Destroys buffers allocated for this stream.

Returns: True on success, false on failure.

◆ postBuffer()

template<QnxBufferCleanupStrategy cleanupStrategy>

bool kanzi::qnx::QnxStream::postBuffer ( const QnxBuffer< cleanupStrategy > & buffer ) const

noexcept

Submits screen buffer to the stream.

Template Parameters

cleanupStrategy Cleanup strategy to use.

See also: QnxBufferCleanupStrategy for more details.

Parameters

buffer Buffer to submit.

Returns: True on success, false on failure.

◆ consumeStream()

bool kanzi::qnx::QnxStream::consumeStream ( const QnxStream & producer ) const

noexcept

Consumes stream.

Parameters

producer Producer stream to be consumed.

Returns: True on success, false on failure.

◆ attachBuffers()

template<QnxBufferCleanupStrategy cleanupStrategy>

bool kanzi::qnx::QnxStream::attachBuffers ( span< QnxBuffer< cleanupStrategy > > buffers ) const

noexcept

Attaches buffers to the stream.

Template Parameters

cleanupStrategy Cleanup strategy to use.

See also: QnxBufferCleanupStrategy for more details.

Parameters

buffers Buffers to attach. Must include at least one buffer.

Returns: True on success, false on failure.

◆ attachBuffer()

template<QnxBufferCleanupStrategy cleanupStrategy>

bool kanzi::qnx::QnxStream::attachBuffer ( const QnxBuffer< cleanupStrategy > & buffer ) const

noexcept

Attaches a single buffer to the stream.

See also: attachBuffers()

Template Parameters

cleanupStrategy Cleanup strategy to use.

See also: QnxBufferCleanupStrategy for more details.

Parameters

buffer Buffer to attach.

Returns: True on success, false on failure.

◆ acquireBuffer()

QnxBuffer< QnxBufferCleanupStrategy::AcquireRelease > kanzi::qnx::QnxStream::acquireBuffer ( ) const

noexcept

Acquires a buffer from the stream.

Returns: Created object for the acquired buffer. If an error occurred, empty.

◆ getQnxPropertyFunctions()

static KZ_NO_DISCARD constexpr QnxPropertyFunctions< NativeHandleType > kanzi::qnx::QnxStream::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:

kanzi/core.ui/platform/windowing_ng/qnx_screen/qnx_screen_stream.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ NativeHandleType

Constructor & Destructor Documentation

◆ QnxStream() [1/4]

◆ QnxStream() [2/4]

◆ ~QnxStream()

◆ QnxStream() [3/4]

◆ QnxStream() [4/4]

Member Function Documentation

◆ tryCreate() [1/2]

◆ tryCreate() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ swap()

◆ getNativeHandle()

◆ tryRetrieveFrontBuffer()

◆ createBuffers()

◆ destroyBuffers()

◆ postBuffer()

◆ consumeStream()

◆ attachBuffers()

◆ attachBuffer()

◆ acquireBuffer()

◆ getQnxPropertyFunctions()