castor3d::UniformBufferPool Class Reference

#include <UniformBufferPool.hpp>

Inheritance diagram for castor3d::UniformBufferPool:

Collaboration diagram for castor3d::UniformBufferPool:

Classes
struct	Buffer

Public Types
using	BufferArray = std::vector< Buffer >

Public Member Functions
C3D_API	UniformBufferPool (RenderDevice const &device, castor::String debugName)
	Constructor. More...
C3D_API void	cleanup ()
	Cleans up all GPU buffers. More...
C3D_API void	upload (ashes::CommandBuffer const &cb) const
	Uploads all GPU buffers to VRAM. More...
template<typename DataT >
UniformBufferOffsetT< DataT >	getBuffer (VkMemoryPropertyFlags flags)
	Retrieves a uniform buffer. More...
template<typename DataT >
void	putBuffer (UniformBufferOffsetT< DataT > const &bufferOffset)
	Releases a GPU buffer. More...
C3D_API uint32_t	getBufferCount () const

Member Typedef Documentation

BufferArray

using castor3d::UniformBufferPool::BufferArray = std::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.

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.

putBuffer()

template<typename DataT >

void castor3d::UniformBufferPool::putBuffer

(

UniformBufferOffsetT< DataT > const &

bufferOffset

)

Releases a GPU buffer.

Parameters

[in]

bufferOffset

The buffer offset to release.

upload()

C3D_API void castor3d::UniformBufferPool::upload

(

ashes::CommandBuffer const &

cb

)

const

Uploads all GPU buffers to VRAM.

Parameters

[in]

cb

The command buffer on which transfer commands are recorded.

---

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

• Buffer/UniformBufferPool.hpp