Implements a Vulkan IIndexBuffer. More...

#include <buffer.h>

Inherits LiteFX::Rendering::Backends::VulkanBuffer, and LiteFX::Rendering::Backends::IVulkanIndexBuffer.

Classes
class	VulkanIndexBufferImpl

Public Member Functions
	VulkanIndexBuffer (VkBuffer buffer, const VulkanIndexBufferLayout &layout, const UInt32 &elements, const ResourceState &initialState, const VmaAllocator &allocator, const VmaAllocation &allocation, const String &name="")

	VulkanIndexBuffer (VulkanIndexBuffer &&)=delete

	VulkanIndexBuffer (const VulkanIndexBuffer &)=delete

virtual	~VulkanIndexBuffer () noexcept

virtual const VulkanIndexBufferLayout &	layout () const noexcept override
	Gets the layout of the index buffer. More...

Public Member Functions inherited from LiteFX::Rendering::Backends::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)

	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...

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

Public Member Functions inherited from LiteFX::Rendering::IndexBuffer< VulkanIndexBufferLayout >
virtual	~IndexBuffer () noexcept=default

virtual const index_buffer_layout_type &	layout () const noexcept=0
	Gets the layout of the index buffer. More...

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

virtual const IIndexBufferLayout &	layout () const noexcept=0
	Gets the layout of the index buffer. More...

Static Public Member Functions
static UniquePtr< IVulkanIndexBuffer >	allocate (const VulkanIndexBufferLayout &layout, const UInt32 &elements, const ResourceState &initialState, const VmaAllocator &allocator, const VkBufferCreateInfo &createInfo, const VmaAllocationCreateInfo &allocationInfo, VmaAllocationInfo *allocationResult=nullptr)

static UniquePtr< IVulkanIndexBuffer >	allocate (const String &name, const VulkanIndexBufferLayout &layout, const UInt32 &elements, const ResourceState &initialState, const VmaAllocator &allocator, const VkBufferCreateInfo &createInfo, const VmaAllocationCreateInfo &allocationInfo, VmaAllocationInfo *allocationResult=nullptr)

Static Public Member Functions inherited from LiteFX::Rendering::Backends::VulkanBuffer
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
Public Types inherited from LiteFX::Rendering::IndexBuffer< VulkanIndexBufferLayout >
using	index_buffer_layout_type = VulkanIndexBufferLayout

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 IIndexBuffer.

Constructor & Destructor Documentation

◆ VulkanIndexBuffer() [1/3]

VulkanIndexBuffer::VulkanIndexBuffer	(	VkBuffer	buffer,
		const VulkanIndexBufferLayout &	layout,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VmaAllocation &	allocation,
		const String &	name = `""`
	)

explicit

◆ VulkanIndexBuffer() [2/3]

LiteFX::Rendering::Backends::VulkanIndexBuffer::VulkanIndexBuffer ( VulkanIndexBuffer && )

delete

◆ VulkanIndexBuffer() [3/3]

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

delete

◆ ~VulkanIndexBuffer()

VulkanIndexBuffer::~VulkanIndexBuffer ( )

virtualdefaultnoexcept

Member Function Documentation

◆ allocate() [1/2]

UniquePtr< IVulkanIndexBuffer > VulkanIndexBuffer::allocate	(	const String &	name,
		const VulkanIndexBufferLayout &	layout,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VkBufferCreateInfo &	createInfo,
		const VmaAllocationCreateInfo &	allocationInfo,
		VmaAllocationInfo *	allocationResult = `nullptr`
	)

static

◆ allocate() [2/2]

UniquePtr< IVulkanIndexBuffer > VulkanIndexBuffer::allocate	(	const VulkanIndexBufferLayout &	layout,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		const VmaAllocator &	allocator,
		const VkBufferCreateInfo &	createInfo,
		const VmaAllocationCreateInfo &	allocationInfo,
		VmaAllocationInfo *	allocationResult = `nullptr`
	)

static

◆ layout()

const VulkanIndexBufferLayout & VulkanIndexBuffer::layout ( ) const

overridevirtualnoexcept

Gets the layout of the index buffer.

Implements LiteFX::Rendering::IndexBuffer< VulkanIndexBufferLayout >.

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members