castor3d::VertexBufferPool Class Reference

#include <ObjectBufferPool.hpp>

Inheritance diagram for castor3d::VertexBufferPool:

Collaboration diagram for castor3d::VertexBufferPool:

Classes
struct	ModelBuffers

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

Public Member Functions
C3D_API	VertexBufferPool (RenderDevice const &device, castor::String debugName)
	Constructor.
C3D_API void	cleanup ()
	Cleans up all GPU buffers.
C3D_API AllocationStats	getAllocationStats () const noexcept
template<typename VertexT >
ObjectBufferOffset	getBuffer (VkDeviceSize vertexCount)
	Retrieves a GPU buffer with the given size.
template<typename VertexT >
void	putBuffer (ObjectBufferOffset const &bufferOffset) noexcept
	Releases a GPU buffer.
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::VertexBufferPool::BufferArray = castor::Vector< ModelBuffers >

Constructor & Destructor Documentation

VertexBufferPool()

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

explicit

Constructor.

Parameters

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

Member Function Documentation

cleanup()

C3D_API void castor3d::VertexBufferPool::cleanup

(

)

Cleans up all GPU buffers.

getAllocationStats()

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

noexcept

Returns

The allocation statistics.

getBuffer()

template<typename VertexT >

ObjectBufferOffset castor3d::VertexBufferPool::getBuffer

(

VkDeviceSize

vertexCount

)

Retrieves a GPU buffer with the given size.

Parameters

[in]

vertexCount

The wanted buffer element count.

Returns

The GPU buffer.

putBuffer()

template<typename VertexT >

void castor3d::VertexBufferPool::putBuffer ( ObjectBufferOffset const & bufferOffset )

noexcept

Releases a GPU buffer.

Parameters

[in]

bufferOffset

The buffer offset to release.

---

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

• Castor3D/Buffer/ObjectBufferPool.hpp