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. More...
virtual const void *	buffer () const noexcept=0
	Return the underlying data buffer. More...
virtual size_t	elementCount () const noexcept=0
	Returns element count, total byte size = elementSize() * elementCount() More...
virtual size_t	elementSize () const noexcept=0
	Returns element size in bytes. More...
SyncBuffer &	sync () noexcept
	Synchronizes the underlying data before usage. More...

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 62 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:

buffer()

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

pure virtualnoexcept

Return the underlying data buffer.

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

elementSize()

virtual size_t jau::math::util::SyncBuffer::elementSize ( ) const

pure virtualnoexcept

Returns element size in bytes.

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

elementCount()

virtual size_t jau::math::util::SyncBuffer::elementCount ( ) const

pure virtualnoexcept

Returns element count, total byte size = elementSize() * elementCount()

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

sync()

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

inlinenoexcept

Synchronizes the underlying data before usage.

Convenient shortcut for action()() plus chaining.

Definition at line 84 of file syncbuffer.hpp.

---

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

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