castor3d::GpuBufferT< AllocatorT > Class Template Reference

A GPU buffer pool, that uses an allocator to allocate sub-buffers. More...

#include <GpuBuffer.hpp>

Inheritance diagram for castor3d::GpuBufferT< AllocatorT >:

Collaboration diagram for castor3d::GpuBufferT< AllocatorT >:

Public Member Functions
	GpuBufferT (RenderSystem const &renderSystem, VkBufferUsageFlags usage, VkMemoryPropertyFlags memoryFlags, castor::String const &debugName, ashes::QueueShare sharingMode, AllocatorT allocator)
	Constructor.
bool	hasAvailable (VkDeviceSize size) const noexcept
VkDeviceSize	getAvailable () const noexcept
MemChunk	allocate (VkDeviceSize size)
	Allocates a memory chunk for a CPU buffer.
void	deallocate (MemChunk const &mem) noexcept
	Deallocates memory.
size_t	getMinAlignment () const noexcept
Public Member Functions inherited from castor3d::GpuBufferBase
C3D_API	GpuBufferBase (RenderSystem const &renderSystem, VkBufferUsageFlags usage, VkMemoryPropertyFlags memoryFlags, castor::String const &debugName, ashes::QueueShare sharingMode, VkDeviceSize allocatedSize)
	Constructor.
C3D_API void	upload (UploadData &uploader)
	Uploads all ready memory ranges to VRAM.
C3D_API void	upload (UploadData &uploader, VkDeviceSize offset, VkDeviceSize size, VkAccessFlags dstAccessFlags, VkPipelineStageFlags dstPipelineFlags)
	Uploads a memory range.
C3D_API void	markDirty (VkDeviceSize offset, VkDeviceSize size, VkAccessFlags dstAccessFlags, VkPipelineStageFlags dstPipelineFlags)
	Marks a memory range to be ready for upload.
bool	hasBuffer () const noexcept
ashes::Buffer< uint8_t > const &	getBuffer () const noexcept
ashes::Buffer< uint8_t > &	getBuffer () noexcept
template<typename DataT >
DataT const &	getData (VkDeviceSize offset) const noexcept
template<typename DataT >
DataT &	getData (VkDeviceSize offset) noexcept
castor::ByteArrayView const &	getDatas () const noexcept
castor::ByteArrayView &	getDatas () noexcept

Friends
class	GpuBufferPool

Detailed Description

template<typename AllocatorT>
class castor3d::GpuBufferT< AllocatorT >

A GPU buffer pool, that uses an allocator to allocate sub-buffers.

Constructor & Destructor Documentation

GpuBufferT()

template<typename AllocatorT >

castor3d::GpuBufferT< AllocatorT >::GpuBufferT	(	RenderSystem const &	renderSystem,
		VkBufferUsageFlags	usage,
		VkMemoryPropertyFlags	memoryFlags,
		castor::String const &	debugName,
		ashes::QueueShare	sharingMode,
		AllocatorT	allocator )

Constructor.

Parameters

[in]	renderSystem	The device on which the storage is allocated.
[in]	usage	The buffer targets.
[in]	memoryFlags	The buffer memory properties.
[in]	debugName	The debug name.
[in]	sharingMode	The sharing mode.
[in]	allocator	The allocator.

Member Function Documentation

allocate()

template<typename AllocatorT >

MemChunk castor3d::GpuBufferT< AllocatorT >::allocate

(

VkDeviceSize

size

)

Allocates a memory chunk for a CPU buffer.

Parameters

[in]

size

The requested memory size.

Returns

The memory chunk offset.

deallocate()

template<typename AllocatorT >

void castor3d::GpuBufferT< AllocatorT >::deallocate ( MemChunk const & mem )

noexcept

Deallocates memory.

Parameters

[in]

mem

The memory chunk.

getAvailable()

template<typename AllocatorT >

VkDeviceSize castor3d::GpuBufferT< AllocatorT >::getAvailable ( ) const

noexcept

Returns

The remaining memory.

getMinAlignment()

template<typename AllocatorT >

size_t castor3d::GpuBufferT< AllocatorT >::getMinAlignment ( ) const

noexcept

Returns

The element aligned size.

hasAvailable()

template<typename AllocatorT >

bool castor3d::GpuBufferT< AllocatorT >::hasAvailable ( VkDeviceSize size ) const

noexcept

Parameters

[in]

size

The requested memory size.

Returns

true if there is enough remaining memory for given size.

Friends And Related Symbol Documentation

GpuBufferPool

template<typename AllocatorT >

friend class GpuBufferPool

friend

---

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

• Castor3D/Buffer/BufferModule.hpp
• Castor3D/Buffer/GpuBuffer.hpp