Implements a Vulkan IBuffer. More...

#include <buffer.h>

Inherits LiteFX::Rendering::Backends::IVulkanBuffer, LiteFX::Resource< VkBuffer >, and LiteFX::Rendering::StateResource.

Inherited by LiteFX::Rendering::Backends::VulkanIndexBuffer, and LiteFX::Rendering::Backends::VulkanVertexBuffer.

Classes
class	VulkanBufferImpl

Public Member Functions
	VulkanBuffer (VkBuffer buffer, const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, const VmaAllocator &allocator, const VmaAllocation &allocation, const String &name)

	VulkanBuffer (VulkanBuffer &&)=delete

	VulkanBuffer (const VulkanBuffer &)=delete

virtual	~VulkanBuffer () noexcept

virtual const BufferType &	type () const noexcept override
	Returns the type of the buffer. More...

virtual const UInt32 &	elements () const noexcept override
	Gets the number of sub-resources inside the memory chunk. More...

virtual size_t	size () const noexcept override
	Gets the size (in bytes) of the aligned memory chunk. More...

virtual size_t	elementSize () const noexcept override
	Returns the size of a single element within the buffer. If there is only one element, this is equal to size. More...

virtual size_t	elementAlignment () const noexcept override
	Returns the alignment of a single element. More...

virtual size_t	alignedElementSize () const noexcept override
	Returns the actual size of the element in device memory. More...

virtual const bool &	writable () const noexcept override
	Returns `true`, if the resource can be bound to a read/write descriptor. More...

virtual const ResourceState &	state (const UInt32 &subresource=0) const override
	Returns the current state of the resource. More...

virtual ResourceState &	state (const UInt32 &subresource=0) override
	Returns a reference of the current state of the resource. More...

virtual void	map (const void *const data, const size_t &size, const UInt32 &element=0) override
	Maps the memory at data to the internal memory of this object. More...

virtual void	map (Span< const void *const > data, const size_t &elementSize, const UInt32 &firstElement=0) override
	Maps the memory blocks within data to the internal memory of an array. More...

Public Member Functions inherited from LiteFX::Rendering::Backends::IVulkanBuffer
virtual	~IVulkanBuffer () noexcept=default

Public Member Functions inherited from LiteFX::Rendering::IBuffer
virtual	~IBuffer () noexcept=default

virtual const BufferType &	type () const noexcept=0
	Returns the type of the buffer. More...

Public Member Functions inherited from LiteFX::Rendering::IDeviceMemory
virtual	~IDeviceMemory () noexcept=default

virtual const UInt32 &	elements () const noexcept=0
	Gets the number of sub-resources inside the memory chunk. More...

virtual size_t	size () const noexcept=0
	Gets the size (in bytes) of the aligned memory chunk. More...

virtual size_t	elementSize () const noexcept=0
	Returns the size of a single element within the buffer. If there is only one element, this is equal to size. More...

virtual size_t	elementAlignment () const noexcept=0
	Returns the alignment of a single element. More...

virtual size_t	alignedElementSize () const noexcept=0
	Returns the actual size of the element in device memory. More...

virtual const bool &	writable () const noexcept=0
	Returns `true`, if the resource can be bound to a read/write descriptor. More...

virtual const ResourceState &	state (const UInt32 &subresource=0) const =0
	Returns the current state of the resource. More...

virtual ResourceState &	state (const UInt32 &subresource=0)=0
	Returns a reference of the current state of the resource. More...

Public Member Functions inherited from LiteFX::Rendering::IMappable
virtual	~IMappable () noexcept=default

virtual void	map (const void *const data, const size_t &size, const UInt32 &element=0)=0
	Maps the memory at data to the internal memory of this object. More...

virtual void	map (Span< const void *const > data, const size_t &elementSize, const UInt32 &firstElement=0)=0
	Maps the memory blocks within data to the internal memory of an array. More...

Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual	~IStateResource () noexcept=default

virtual const String &	name () const noexcept=0
	Returns the name of the resource. More...

Public Member Functions inherited from LiteFX::IResource< VkBuffer >
virtual	~IResource () noexcept=default

virtual const VkBuffer &	handle () const noexcept=0
	Returns the resource managed by the class. More...

Public Member Functions inherited from LiteFX::Resource< VkBuffer >
	Resource (const Resource &)=delete

	Resource (Resource &&)=delete

virtual	~Resource () noexcept=default

const VkBuffer &	handle () const noexcept override
	Returns the resource managed by the class. More...

Public Member Functions inherited from LiteFX::Rendering::StateResource
	StateResource (StringView name)
	Initializes a new state resource instance. More...

	StateResource (StateResource &&)=delete

	StateResource (const StateResource &)=delete

virtual	~StateResource () noexcept

virtual const String &	name () const noexcept override
	Returns the name of the resource. More...

Static Public Member Functions
static UniquePtr< IVulkanBuffer >	allocate (const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, const VmaAllocator &allocator, const VkBufferCreateInfo &createInfo, const VmaAllocationCreateInfo &allocationInfo, VmaAllocationInfo *allocationResult=nullptr)

static UniquePtr< IVulkanBuffer >	allocate (const String &name, const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, const VmaAllocator &allocator, const VkBufferCreateInfo &createInfo, const VmaAllocationCreateInfo &allocationInfo, VmaAllocationInfo *allocationResult=nullptr)

Additional Inherited Members
virtual VkBuffer &	handle () noexcept=0
	Returns the resource managed by the class. More...

Protected Member Functions inherited from LiteFX::Resource< VkBuffer >
	Resource (const VkBuffer handle) noexcept
	Initializes the managed resource. More...

VkBuffer &	handle () noexcept override
	Returns the resource managed by the class. More...

Protected Member Functions inherited from LiteFX::Rendering::StateResource
	StateResource () noexcept

String &	name () noexcept

Detailed Description

Implements a Vulkan IBuffer.

Constructor & Destructor Documentation

◆ VulkanBuffer() [1/3]

VulkanBuffer::VulkanBuffer	(	VkBuffer	buffer,
		const BufferType &	type,
		const UInt32 &	elements,
		const size_t &	elementSize,
		const size_t &	alignment,
		const bool &	writable,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VmaAllocation &	allocation,
		const String &	name
	)

explicit

◆ VulkanBuffer() [2/3]

LiteFX::Rendering::Backends::VulkanBuffer::VulkanBuffer ( VulkanBuffer && )

delete

◆ VulkanBuffer() [3/3]

LiteFX::Rendering::Backends::VulkanBuffer::VulkanBuffer ( const VulkanBuffer & )

delete

◆ ~VulkanBuffer()

VulkanBuffer::~VulkanBuffer ( )

virtualnoexcept

Member Function Documentation

◆ alignedElementSize()

size_t VulkanBuffer::alignedElementSize ( ) const

overridevirtualnoexcept

Returns the actual size of the element in device memory.

Implements LiteFX::Rendering::IDeviceMemory.

◆ allocate() [1/2]

UniquePtr< IVulkanBuffer > VulkanBuffer::allocate	(	const BufferType &	type,
		const UInt32 &	elements,
		const size_t &	elementSize,
		const size_t &	alignment,
		const bool &	writable,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VkBufferCreateInfo &	createInfo,
		const VmaAllocationCreateInfo &	allocationInfo,
		VmaAllocationInfo *	allocationResult = `nullptr`
	)

static

◆ allocate() [2/2]

UniquePtr< IVulkanBuffer > VulkanBuffer::allocate	(	const String &	name,
		const BufferType &	type,
		const UInt32 &	elements,
		const size_t &	elementSize,
		const size_t &	alignment,
		const bool &	writable,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VkBufferCreateInfo &	createInfo,
		const VmaAllocationCreateInfo &	allocationInfo,
		VmaAllocationInfo *	allocationResult = `nullptr`
	)

static

◆ elementAlignment()

size_t VulkanBuffer::elementAlignment ( ) const

overridevirtualnoexcept

Returns the alignment of a single element.

Implements LiteFX::Rendering::IDeviceMemory.

◆ elements()

const UInt32 & VulkanBuffer::elements ( ) const

overridevirtualnoexcept

Gets the number of sub-resources inside the memory chunk.

Implements LiteFX::Rendering::IDeviceMemory.

◆ elementSize()

size_t VulkanBuffer::elementSize ( ) const

overridevirtualnoexcept

Returns the size of a single element within the buffer. If there is only one element, this is equal to size.

Implements LiteFX::Rendering::IDeviceMemory.

◆ map() [1/2]

void VulkanBuffer::map	(	const void *const	data,
		const size_t &	size,
		const UInt32 &	element = `0`
	)

overridevirtual

Maps the memory at data to the internal memory of this object.

Implements LiteFX::Rendering::IMappable.

◆ map() [2/2]

void VulkanBuffer::map	(	Span< const void *const >	data,
		const size_t &	elementSize,
		const UInt32 &	firstElement = `0`
	)

overridevirtual

Maps the memory blocks within data to the internal memory of an array.

Implements LiteFX::Rendering::IMappable.

◆ size()

size_t VulkanBuffer::size ( ) const

overridevirtualnoexcept

Gets the size (in bytes) of the aligned memory chunk.

Implements LiteFX::Rendering::IDeviceMemory.

◆ state() [1/2]

const ResourceState & VulkanBuffer::state ( const UInt32 & subresource = 0 ) const

overridevirtual

Returns the current state of the resource.

Implements LiteFX::Rendering::IDeviceMemory.

◆ state() [2/2]

ResourceState & VulkanBuffer::state ( const UInt32 & subresource = 0 )

overridevirtual

Returns a reference of the current state of the resource.

Implements LiteFX::Rendering::IDeviceMemory.

◆ type()

const BufferType & VulkanBuffer::type ( ) const

overridevirtualnoexcept

Returns the type of the buffer.

Implements LiteFX::Rendering::IBuffer.

◆ writable()

const bool & VulkanBuffer::writable ( ) const

overridevirtualnoexcept

Returns true, if the resource can be bound to a read/write descriptor.

Implements LiteFX::Rendering::IDeviceMemory.

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VulkanBuffer() [1/3]

◆ VulkanBuffer() [2/3]

◆ VulkanBuffer() [3/3]

◆ ~VulkanBuffer()

Member Function Documentation

◆ alignedElementSize()

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ elementAlignment()

◆ elements()

◆ elementSize()

◆ map() [1/2]

◆ map() [2/2]

◆ size()

◆ state() [1/2]

◆ state() [2/2]

◆ type()

◆ writable()