spark::render::IBuffer Class Reference

Base interface for all buffers. More...

#include <Buffer.h>

Inheritance diagram for spark::render::IBuffer:

Public Member Functions
virtual BufferType	type () const =0
	Gets the type of the buffer.
Public Member Functions inherited from spark::render::IDeviceMemory
virtual unsigned int	elements () const noexcept=0
	Get the number of sub-resources in the memory chunk.
virtual std::size_t	size () const noexcept=0
	Gets the size (in bytes) of the memory chunk.
virtual std::size_t	elementSize () const noexcept=0
	Gets the size (in bytes) of one element in the memory chunk. If there is only one element, this equals the result of IDeviceMemory::size().
virtual std::size_t	elementAlignment () const =0
	Gets the alignment of one element in the memory chunk.
virtual std::size_t	alignedElementSize () const noexcept=0
	Gets the real size (in bytes) of the memory chunk.
virtual bool	writable () const noexcept=0
	Checks if the resource can be bound to a read/write descriptor.
Public Member Functions inherited from spark::render::IMappable
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.
Public Member Functions inherited from spark::render::IStateResource
virtual const std::string &	name () const noexcept=0
	Gets the name of the state resource.

Detailed Description

Base interface for all buffers.

Member Function Documentation

type()

virtual BufferType spark::render::IBuffer::type ( ) const

nodiscardpure virtual

Gets the type of the buffer.

Returns

A BufferType representing the type of the buffer.

Implemented in spark::render::vk::VulkanBuffer.