spark::render::IMappable Class Reference

Interface allowing data to be mapped into the object. More...

#include <Mappable.h>

Inheritance diagram for spark::render::IMappable:

Public Member Functions
virtual void	map (const void *data, std::size_t size, unsigned int element)=0
	Maps the memory at data into the internal memory of the object.
virtual void	map (std::span< const void * > data, std::size_t element_size, unsigned int first_element)=0
	Maps the memory blocks within data into the internal memory of the object.
virtual void	map (void *data, size_t size, unsigned int element=0, bool write=true)=0
	Maps the memory at data into the internal memory of the object.
virtual void	map (std::span< void * > data, size_t element_size, unsigned int first_element=0, bool write=true)=0
	Maps the memory blocks within data into the internal memory of the object.

Detailed Description

Interface allowing data to be mapped into the object.

Member Function Documentation

map() [1/4]

virtual void spark::render::IMappable::map ( const void * data, std::size_t size, unsigned int element )

pure virtual

Maps the memory at data into the internal memory of the object.

Parameters

data	Address of the beginning of the data to map (in bytes).
size	Size of the data to map.
element	The array element to map the data to.

map() [2/4]

virtual void spark::render::IMappable::map ( std::span< const void * > data, std::size_t element_size, unsigned int first_element )

pure virtual

Maps the memory blocks within data into the internal memory of the object.

Parameters

data	A std::span of memory blocks to map.
element_size	The size of each element in the span (in bytes).
first_element	The first element to map the data to.

map() [3/4]

virtual void spark::render::IMappable::map ( std::span< void * > data, size_t element_size, unsigned int first_element = 0, bool write = true )

pure virtual

Maps the memory blocks within data into the internal memory of the object.

Parameters

data	A std::span of memory blocks to map.
element_size	The size of each element in the span (in bytes).
first_element	The first element to map the data to.
write	true if the data will be written to the object. false if the data will be read from the object.

map() [4/4]

virtual void spark::render::IMappable::map ( void * data, size_t size, unsigned int element = 0, bool write = true )

pure virtual

Maps the memory at data into the internal memory of the object.

Parameters

data	Address of the beginning of the data to map.
size	Size of the data to map (in bytes).
element	The array element to map the data to.
write	If true, the data will be written to the object. If false, the data will be read from the object.