LiteFX 0.3.1.2022
Computer Graphics Engine
LiteFX::Rendering::IMappable Class Referenceabstract

Allows for data to be mapped into the object. More...

#include <rendering_api.hpp>

Inherited by LiteFX::Rendering::IBuffer [virtual].

Public Member Functions

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

Detailed Description

Allows for data to be mapped into the object.

Constructor & Destructor Documentation

◆ ~IMappable()

virtual LiteFX::Rendering::IMappable::~IMappable ( )
virtualdefaultnoexcept

Member Function Documentation

◆ map() [1/2]

virtual void LiteFX::Rendering::IMappable::map ( const void *const  data,
const size_t &  size,
const UInt32 element = 0 
)
pure virtual

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

Parameters
dataThe address that marks the beginning of the data to map.
sizeThe number of bytes to map.
elementThe array element to map the data to.

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

◆ map() [2/2]

virtual void LiteFX::Rendering::IMappable::map ( Span< const void *const >  data,
const size_t &  elementSize,
const UInt32 firstElement = 0 
)
pure virtual

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

Parameters
dataThe data blocks to map.
sizeThe size of each data block within data .
firsElementThe first element of the array to map.

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