Implements a DirectX 12 IIndexBuffer. More...

#include <buffer.h>

Inherits LiteFX::Rendering::Backends::DirectX12Buffer, and LiteFX::Rendering::Backends::IDirectX12IndexBuffer.

Classes
class	DirectX12IndexBufferImpl

Public Member Functions
	DirectX12IndexBuffer (ComPtr< ID3D12Resource > &&buffer, const DirectX12IndexBufferLayout &layout, const UInt32 &elements, const ResourceState &initialState, AllocatorPtr allocator, AllocationPtr &&allocation, const String &name="")

	DirectX12IndexBuffer (DirectX12IndexBuffer &&)=delete

	DirectX12IndexBuffer (const DirectX12IndexBuffer &)=delete

virtual	~DirectX12IndexBuffer () noexcept

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

virtual const D3D12_INDEX_BUFFER_VIEW &	view () const noexcept override

Public Member Functions inherited from LiteFX::Rendering::Backends::DirectX12Buffer
	DirectX12Buffer (ComPtr< ID3D12Resource > &&buffer, const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, AllocatorPtr allocator=nullptr, AllocationPtr &&allocation=nullptr, const String &name="")

	DirectX12Buffer (DirectX12Buffer &&)=delete

	DirectX12Buffer (const DirectX12Buffer &)=delete

virtual	~DirectX12Buffer () 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::IDirectX12Buffer
virtual	~IDirectX12Buffer () 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< ComPtr< ID3D12Resource > >
virtual	~IResource () noexcept=default

virtual const ComPtr< ID3D12Resource > &	handle () const noexcept=0
	Returns the resource managed by the class. More...

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

	Resource (Resource &&)=delete

virtual	~Resource () noexcept=default

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

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

virtual const THandle &	handle () const noexcept=0
	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::IDirectX12IndexBuffer
virtual	~IDirectX12IndexBuffer () noexcept=default

virtual const D3D12_INDEX_BUFFER_VIEW &	view () const noexcept=0

Public Member Functions inherited from LiteFX::Rendering::IndexBuffer< DirectX12IndexBufferLayout >
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< IDirectX12IndexBuffer >	allocate (const DirectX12IndexBufferLayout &layout, AllocatorPtr allocator, const UInt32 &elements, const ResourceState &initialState, const D3D12_RESOURCE_DESC &resourceDesc, const D3D12MA::ALLOCATION_DESC &allocationDesc)

static UniquePtr< IDirectX12IndexBuffer >	allocate (const String &name, const DirectX12IndexBufferLayout &layout, AllocatorPtr allocator, const UInt32 &elements, const ResourceState &initialState, const D3D12_RESOURCE_DESC &resourceDesc, const D3D12MA::ALLOCATION_DESC &allocationDesc)

Static Public Member Functions inherited from LiteFX::Rendering::Backends::DirectX12Buffer
static UniquePtr< IDirectX12Buffer >	allocate (AllocatorPtr allocator, const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, const D3D12_RESOURCE_DESC &resourceDesc, const D3D12MA::ALLOCATION_DESC &allocationDesc)

static UniquePtr< IDirectX12Buffer >	allocate (const String &name, AllocatorPtr allocator, const BufferType &type, const UInt32 &elements, const size_t &elementSize, const size_t &alignment, const bool &writable, const ResourceState &initialState, const D3D12_RESOURCE_DESC &resourceDesc, const D3D12MA::ALLOCATION_DESC &allocationDesc)

Additional Inherited Members
Public Types inherited from LiteFX::Rendering::IndexBuffer< DirectX12IndexBufferLayout >
using	index_buffer_layout_type = DirectX12IndexBufferLayout

Protected Member Functions inherited from LiteFX::Rendering::Backends::DirectX12Buffer
virtual AllocatorPtr	allocator () const noexcept

virtual const D3D12MA::Allocation *	allocationInfo () const noexcept

Protected Member Functions inherited from LiteFX::IResource< ComPtr< ID3D12Resource > >
virtual ComPtr< ID3D12Resource > &	handle () noexcept=0
	Returns the resource managed by the class. More...

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

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

virtual THandle &	handle () noexcept=0
	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 DirectX 12 IIndexBuffer.

Constructor & Destructor Documentation

◆ DirectX12IndexBuffer() [1/3]

DirectX12IndexBuffer::DirectX12IndexBuffer	(	ComPtr< ID3D12Resource > &&	buffer,
		const DirectX12IndexBufferLayout &	layout,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		AllocatorPtr	allocator,
		AllocationPtr &&	allocation,
		const String &	name = `""`
	)

explicit

◆ DirectX12IndexBuffer() [2/3]

LiteFX::Rendering::Backends::DirectX12IndexBuffer::DirectX12IndexBuffer ( DirectX12IndexBuffer && )

delete

◆ DirectX12IndexBuffer() [3/3]

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

delete

◆ ~DirectX12IndexBuffer()

DirectX12IndexBuffer::~DirectX12IndexBuffer ( )

virtualdefaultnoexcept

Member Function Documentation

◆ allocate() [1/2]

UniquePtr< IDirectX12IndexBuffer > DirectX12IndexBuffer::allocate	(	const DirectX12IndexBufferLayout &	layout,
		AllocatorPtr	allocator,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		const D3D12_RESOURCE_DESC &	resourceDesc,
		const D3D12MA::ALLOCATION_DESC &	allocationDesc
	)

static

◆ allocate() [2/2]

UniquePtr< IDirectX12IndexBuffer > DirectX12IndexBuffer::allocate	(	const String &	name,
		const DirectX12IndexBufferLayout &	layout,
		AllocatorPtr	allocator,
		const UInt32 &	elements,
		const ResourceState &	initialState,
		const D3D12_RESOURCE_DESC &	resourceDesc,
		const D3D12MA::ALLOCATION_DESC &	allocationDesc
	)

static

◆ layout()

const DirectX12IndexBufferLayout & DirectX12IndexBuffer::layout ( ) const

overridevirtualnoexcept

Gets the layout of the index buffer.

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

◆ view()

const D3D12_INDEX_BUFFER_VIEW & DirectX12IndexBuffer::view ( ) const