jau::math::util::SyncBuffer Class Reference

Convenient tuple of a sync_action_t and data buffer. More...

#include <syncbuffer.hpp>

Inheritance diagram for jau::math::util::SyncBuffer:

Collaboration diagram for jau::math::util::SyncBuffer:

Public Member Functions
virtual	~SyncBuffer () noexcept=default
virtual sync_action_t &	action () noexcept=0
	Return the defined sync_action_t.
virtual const jau::type_info &	compSignature () const noexcept=0
	Returns type signature of implementing class's stored component value type.
virtual const void *	data () const noexcept=0
	Return the underlying data buffer as bytes w/o sync action().
SyncBuffer &	sync () noexcept
	The component's size in bytes.
const void *	syncedData () noexcept
	Return the underlying data buffer as bytes after invoking sync action().
virtual std::string	toString () const =0

Detailed Description

Convenient tuple of a sync_action_t and data buffer.

sync_action_t is used to update the data buffer in case it is derived or must be otherwise transported, defined by the data provider.

Definition at line 46 of file syncbuffer.hpp.

Constructor & Destructor Documentation

~SyncBuffer()

virtual jau::math::util::SyncBuffer::~SyncBuffer ( )

virtualdefaultnoexcept

Member Function Documentation

action()

virtual sync_action_t & jau::math::util::SyncBuffer::action ( )

pure virtualnoexcept

Return the defined sync_action_t.

Here is the caller graph for this function:

data()

virtual const void * jau::math::util::SyncBuffer::data ( ) const

pure virtualnoexcept

Return the underlying data buffer as bytes w/o sync action().

Implemented in jau::math::util::SyncMatrices4< Value_type >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrix4< Value_type >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< value_type >, and jau::math::util::SyncMatrix4< value_type >.

Here is the caller graph for this function:

syncedData()

const void * jau::math::util::SyncBuffer::syncedData ( )

inlinenoexcept

Return the underlying data buffer as bytes after invoking sync action().

Definition at line 57 of file syncbuffer.hpp.

Here is the caller graph for this function:

compSignature()

virtual const jau::type_info & jau::math::util::SyncBuffer::compSignature ( ) const

pure virtualnoexcept

Returns type signature of implementing class's stored component value type.

Implemented in jau::math::util::SyncMatrices4< Value_type >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrix4< Value_type >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< value_type >, and jau::math::util::SyncMatrix4< value_type >.

sync()

SyncBuffer & jau::math::util::SyncBuffer::sync ( )

inlinenoexcept

The component's size in bytes.

The number of components per element Returns element count. One element consist compsPerElem() components. Returns the byte size of all elements, i.e. elementCount() * compsPerElem() * bytesPerComp(). Synchronizes the underlying data before usage.

Convenient shortcut for action()() plus chaining.

Definition at line 80 of file syncbuffer.hpp.

Here is the caller graph for this function:

toString()

virtual std::string jau::math::util::SyncBuffer::toString ( ) const

pure virtual

Implemented in jau::math::util::SyncMatrices4< Value_type >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< float >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrices4< value_type >, jau::math::util::SyncMatrix4< Value_type >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< float >, jau::math::util::SyncMatrix4< value_type >, and jau::math::util::SyncMatrix4< value_type >.

---

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

• include/jau/math/util/syncbuffer.hpp