castor3d::VertexBufferPool Class Reference

#include <ObjectBufferPool.hpp>

Inheritance diagram for castor3d::VertexBufferPool:

Collaboration diagram for castor3d::VertexBufferPool:

Classes
struct	ModelBuffers

Public Types
using	BufferArray = std::vector< std::unique_ptr< ModelBuffers > >

Public Member Functions
C3D_API	VertexBufferPool (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)
	Uploads all GPU buffers to VRAM. More...
template<typename VertexT >
ObjectBufferOffset	getBuffer (VkDeviceSize vertexCount)
	Retrieves a GPU buffer with the given size. More...
C3D_API void	putBuffer (ObjectBufferOffset const &bufferOffset)
	Releases a GPU buffer. More...

Member Typedef Documentation

BufferArray

using castor3d::VertexBufferPool::BufferArray = std::vector< std::unique_ptr< 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.

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()

C3D_API void castor3d::VertexBufferPool::putBuffer

(

ObjectBufferOffset const &

bufferOffset

)

Releases a GPU buffer.

Parameters

[in]

bufferOffset

The buffer offset to release.

upload()

C3D_API void castor3d::VertexBufferPool::upload

(

ashes::CommandBuffer const &

cb

)

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/ObjectBufferPool.hpp