castor3d::UniformBufferPool Class Reference

#include <UniformBufferPool.hpp>

Inheritance diagram for castor3d::UniformBufferPool:

Collaboration diagram for castor3d::UniformBufferPool:

Classes
struct	Buffer

Public Types
using	BufferArray = castor::Vector< Buffer >

Public Member Functions
C3D_API	UniformBufferPool (RenderDevice const &device, castor::String debugName)
	Constructor.
C3D_API void	cleanup ()
	Cleans up all GPU buffers.
C3D_API AllocationStats	getAllocationStats () const noexcept
C3D_API castor::Vector< castor::Pair< MemChunk, castor::String > >	listAllocations () const
C3D_API void	upload (UploadData const &uploader) const
	Uploads all GPU buffers to VRAM.
template<typename DataT >
UniformBufferOffsetT< DataT >	getBuffer (VkMemoryPropertyFlags flags)
	Retrieves a uniform buffer.
template<typename DataT >
void	putBuffer (UniformBufferOffsetT< DataT > &bufferOffset) noexcept
	Releases a GPU buffer.
C3D_API uint32_t	getBufferCount () const
Public Member Functions inherited from castor::OwnedBy< RenderSystem >
RenderSystem *	getOwner () const noexcept
void	setOwner (RenderSystem &owner) noexcept

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< RenderSystem >
	OwnedBy (RenderSystem &owner) noexcept
	Constructor.

Member Typedef Documentation

BufferArray

using castor3d::UniformBufferPool::BufferArray = castor::Vector< Buffer >

Constructor & Destructor Documentation

UniformBufferPool()

C3D_API castor3d::UniformBufferPool::UniformBufferPool	(	RenderDevice const &	device,
		castor::String	debugName )

Constructor.

Parameters

[in]	device	The GPU device.
[in]	debugName	The buffer debug name.

Member Function Documentation

cleanup()

C3D_API void castor3d::UniformBufferPool::cleanup

(

)

Cleans up all GPU buffers.

getAllocationStats()

C3D_API AllocationStats castor3d::UniformBufferPool::getAllocationStats ( ) const

noexcept

Returns

The allocation statistics.

getBuffer()

template<typename DataT >

UniformBufferOffsetT< DataT > castor3d::UniformBufferPool::getBuffer

(

VkMemoryPropertyFlags

flags

)

Retrieves a uniform buffer.

Parameters

[in]

flags

The buffer memory flags.

Returns

The uniform buffer.

getBufferCount()

C3D_API uint32_t castor3d::UniformBufferPool::getBufferCount

(

)

const

Returns

The pool buffers count.

listAllocations()

C3D_API castor::Vector< castor::Pair< MemChunk, castor::String > > castor3d::UniformBufferPool::listAllocations

(

)

const

Returns

The allocation statistics.

putBuffer()

template<typename DataT >

void castor3d::UniformBufferPool::putBuffer ( UniformBufferOffsetT< DataT > & bufferOffset )

noexcept

Releases a GPU buffer.

Parameters

[in]

bufferOffset

The buffer offset to release.

upload()

C3D_API void castor3d::UniformBufferPool::upload

(

UploadData const &

uploader

)

const

Uploads all GPU buffers to VRAM.

Parameters

[in]

uploader

Receives the upload requests.

---

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

• Castor3D/Buffer/UniformBufferPool.hpp