LiteFX::Rendering::IBuffer Class Reference

Base interface for buffer objects. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IDeviceMemory, LiteFX::Rendering::IMappable, LiteFX::Rendering::IStateResource, and LiteFX::SharedObject.

Inherited by LiteFX::Rendering::Backends::IDirectX12Buffer [virtual], LiteFX::Rendering::Backends::IVulkanBuffer [virtual], LiteFX::Rendering::IIndexBuffer [virtual], and LiteFX::Rendering::IVertexBuffer [virtual].

Public Member Functions
	~IBuffer () noexcept override=default
virtual BufferType	type () const noexcept=0
	Returns the type of the buffer.
Public Member Functions inherited from LiteFX::Rendering::IDeviceMemory
virtual	~IDeviceMemory () noexcept=default
virtual UInt32	elements () const noexcept=0
	Gets the number of sub-resources inside the memory chunk.
virtual size_t	size () const noexcept=0
	Gets the size (in bytes) of the aligned memory chunk.
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.
virtual size_t	elementAlignment () const noexcept=0
	Returns the alignment of a single element.
virtual size_t	alignedElementSize () const noexcept=0
	Returns the actual size of the element in device memory.
virtual ResourceUsage	usage () const noexcept=0
	Returns the usage flags for the resource.
bool	writable () const noexcept
	Returns true, if the resource can be bound to a read/write descriptor.
virtual UInt64	virtualAddress () const noexcept=0
	Gets the address of the resource in GPU memory.
Public Member Functions inherited from LiteFX::Rendering::IMappable
virtual	~IMappable () noexcept=default
virtual void	map (const void *const data, size_t size, UInt32 element=0)=0
	Maps the memory at data to the internal memory of this object.
virtual void	map (Span< const void *const > data, size_t elementSize, UInt32 firstElement=0)=0
	Maps the memory blocks within data to the internal memory of an array.
virtual void	map (void *data, size_t size, UInt32 element=0, bool write=true)=0
	Maps the memory at data to the internal memory of this object.
virtual void	map (Span< void * > data, size_t elementSize, UInt32 firstElement=0, bool write=true)=0
	Maps the memory blocks within data to the internal memory of an array.
Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual	~IStateResource () noexcept=default
	Releases the state resource instance.
virtual const String &	name () const noexcept=0
	Returns the name of the resource.
Public Member Functions inherited from LiteFX::SharedObject
virtual	~SharedObject () noexcept=default
	Destroys the shared object.
template<typename TSelf >
auto	shared_from_this (this TSelf &&self) noexcept
	Returns a shared pointer to the current object instance.
template<typename TSelf >
auto	weak_from_this (this TSelf &&self) noexcept -> WeakPtr< std::remove_reference_t< TSelf > >
	Returns a weak pointer to the current object instance.

Protected Member Functions
	IBuffer () noexcept=default
	IBuffer (IBuffer &&) noexcept=default
	IBuffer (const IBuffer &)=delete
IBuffer &	operator= (IBuffer &&) noexcept=default
IBuffer &	operator= (const IBuffer &)=delete
Protected Member Functions inherited from LiteFX::Rendering::IDeviceMemory
	IDeviceMemory () noexcept=default
	IDeviceMemory (IDeviceMemory &&) noexcept=default
	IDeviceMemory (const IDeviceMemory &)=default
IDeviceMemory &	operator= (IDeviceMemory &&) noexcept=default
IDeviceMemory &	operator= (const IDeviceMemory &)=default
Protected Member Functions inherited from LiteFX::Rendering::IMappable
	IMappable () noexcept=default
	IMappable (IMappable &&) noexcept=default
	IMappable (const IMappable &)=default
IMappable &	operator= (IMappable &&) noexcept=default
IMappable &	operator= (const IMappable &)=default
Protected Member Functions inherited from LiteFX::Rendering::IStateResource
	IStateResource () noexcept=default
	IStateResource (const IStateResource &)=delete
	IStateResource (IStateResource &&) noexcept=default
IStateResource &	operator= (const IStateResource &)=delete
IStateResource &	operator= (IStateResource &&) noexcept=default
Protected Member Functions inherited from LiteFX::SharedObject
	SharedObject () noexcept=default
	Initializes a new shared object.
	SharedObject (SharedObject &&) noexcept=default
	SharedObject (const SharedObject &)=default
SharedObject &	operator= (SharedObject &&) noexcept=default
SharedObject &	operator= (const SharedObject &)=default

Additional Inherited Members
Static Protected Member Functions inherited from LiteFX::SharedObject
template<typename T , typename... TArgs>
static auto	create (TArgs &&... args) -> SharedPtr< T >
	Generic factory method used to create instances of the shared object.

Detailed Description

Base interface for buffer objects.

Constructor & Destructor Documentation

IBuffer() [1/3]

LiteFX::Rendering::IBuffer::IBuffer ( )

protecteddefaultnoexcept

IBuffer() [2/3]

LiteFX::Rendering::IBuffer::IBuffer ( IBuffer && )

protecteddefaultnoexcept

IBuffer() [3/3]

LiteFX::Rendering::IBuffer::IBuffer ( const IBuffer & )

protecteddelete

~IBuffer()

LiteFX::Rendering::IBuffer::~IBuffer ( )

overridedefaultnoexcept

Member Function Documentation

operator=() [1/2]

IBuffer & LiteFX::Rendering::IBuffer::operator= ( const IBuffer & )

protecteddelete

operator=() [2/2]

IBuffer & LiteFX::Rendering::IBuffer::operator= ( IBuffer && )

protecteddefaultnoexcept

type()

virtual BufferType LiteFX::Rendering::IBuffer::type ( ) const

pure virtualnoexcept

Returns the type of the buffer.

Returns

The type of the buffer.

Implemented in LiteFX::Rendering::Backends::DirectX12Buffer, and LiteFX::Rendering::Backends::VulkanBuffer.