LiteFX::Rendering::IIndexBuffer Class Reference

The interface for an index buffer. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IBuffer.

Inherited by LiteFX::Rendering::IndexBuffer< DirectX12IndexBufferLayout > [virtual], LiteFX::Rendering::IndexBuffer< VulkanIndexBufferLayout > [virtual], and LiteFX::Rendering::IndexBuffer< TIndexBufferLayout > [virtual].

Public Member Functions
virtual	~IIndexBuffer () noexcept=default
virtual const IIndexBufferLayout &	layout () const noexcept=0
	Gets the layout of the index buffer. More...
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...

Detailed Description

The interface for an index buffer.

Constructor & Destructor Documentation

~IIndexBuffer()

virtual LiteFX::Rendering::IIndexBuffer::~IIndexBuffer ( )

virtualdefaultnoexcept

Member Function Documentation

layout()

virtual const IIndexBufferLayout & LiteFX::Rendering::IIndexBuffer::layout ( ) const

pure virtualnoexcept

Gets the layout of the index buffer.

Returns

The layout of the index buffer.

Implemented in LiteFX::Rendering::Backends::DirectX12IndexBuffer, LiteFX::Rendering::Backends::VulkanIndexBuffer, LiteFX::Rendering::IndexBuffer< TIndexBufferLayout >, LiteFX::Rendering::IndexBuffer< DirectX12IndexBufferLayout >, and LiteFX::Rendering::IndexBuffer< VulkanIndexBufferLayout >.