vcl::GenericBuffer< BufferHandleType > Class Template Reference

The GenericBuffer manages the lifetime of a bgfx BufferHandle. More...

#include <vclib/bgfx/buffers/generic_buffer.h>

Public Member Functions
bool	isValid () const
	Check if the Buffer is valid.
void	destroy ()
	Destroy the Buffer.

Protected Member Functions
	GenericBuffer ()=default
	Empty constructor.
	GenericBuffer (const GenericBuffer &other)=delete
	GenericBuffer (GenericBuffer &&other) noexcept
	Move constructor.
	~GenericBuffer ()
	Destructor.
GenericBuffer &	operator= (const GenericBuffer &other)=delete
GenericBuffer &	operator= (GenericBuffer &&other) noexcept
	Move assignment operator.
void	swap (GenericBuffer &other)
	Swap the content of this object with another Buffer object.

Static Protected Member Functions
static uint64_t	flagsForAccess (bgfx::Access::Enum access)
static bgfx::AttribType::Enum	attributeType (PrimitiveType type)
static uint64_t	flagsForType (PrimitiveType type)

Protected Attributes
BufferHandleType	mHandle = BGFX_INVALID_HANDLE

Friends
void	swap (GenericBuffer &a, GenericBuffer &b)

Detailed Description

template<typename BufferHandleType>
class vcl::GenericBuffer< BufferHandleType >

The GenericBuffer manages the lifetime of a bgfx BufferHandle.

Note

A bgfx Buffer can be moved but not copied (a copy would require to create a new Buffer Handle, that can be done only having access to the data). Any class that contains a GenericBuffer (or a derived class) should implement the copy constructor and the copy assignment operator.

Constructor & Destructor Documentation

GenericBuffer() [1/2]

template<typename BufferHandleType >

vcl::GenericBuffer< BufferHandleType >::GenericBuffer ( )

protecteddefault

Empty constructor.

It creates an invalid GenericBuffer object.

GenericBuffer() [2/2]

template<typename BufferHandleType >

vcl::GenericBuffer< BufferHandleType >::GenericBuffer ( GenericBuffer< BufferHandleType > &&  other )

inlineprotectednoexcept

Move constructor.

The other GenericBuffer is left in an invalid state.

Parameters

[in]

other

the other GenericBuffer object.

~GenericBuffer()

template<typename BufferHandleType >

vcl::GenericBuffer< BufferHandleType >::~GenericBuffer ( )

inlineprotected

Destructor.

If the GenericBuffer is valid, the bgfx Buffer Handle is destroyed.

Member Function Documentation

isValid()

template<typename BufferHandleType >

bool vcl::GenericBuffer< BufferHandleType >::isValid ( ) const

inline

Check if the Buffer is valid.

Returns

true if the Buffer is valid, false otherwise.

operator=()

template<typename BufferHandleType >

GenericBuffer & vcl::GenericBuffer< BufferHandleType >::operator= ( GenericBuffer< BufferHandleType > &&  other )

inlineprotectednoexcept

Move assignment operator.

The other GenericBuffer is left in an invalid state.

Parameters

[in]

other

the other GenericBuffer object.

Returns

a reference to this object.

swap()

template<typename BufferHandleType >

void vcl::GenericBuffer< BufferHandleType >::swap ( GenericBuffer< BufferHandleType > &  other )

inlineprotected

Swap the content of this object with another Buffer object.

Parameters

[in]

other

the other Buffer object.

---

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

• vclib/render/include/vclib/bgfx/buffers/generic_buffer.h