vitrio::image_scratch_storage Class Reference

Memory in which a scratch keeps its copies. More...

#include <vitrio/image_scratch_storage.hpp>

Public Member Functions
	image_scratch_storage (const image_scratch_storage &other)=delete
	image_scratch_storage (image_scratch_storage &&other)=delete
image_scratch_storage &	operator= (const image_scratch_storage &other)=delete
image_scratch_storage &	operator= (image_scratch_storage &&other)=delete
virtual byte *	get_data () noexcept=0
	Get the block of bytes.
virtual const byte *	get_data () const noexcept=0
	Get the block of bytes, to read them.
virtual std::size_t	get_size () const noexcept=0
	Get the size of the block.

Detailed Description

Memory in which a scratch keeps its copies.

A block of bytes that the host can read and write. Where the block lives is up to the implementation: in main memory, or in a file.

Thread safety

Every method may be called concurrently. Threads may read and write different bytes of the block at the same time.

Member Function Documentation

get_data() [1/2]

virtual const byte * vitrio::image_scratch_storage::get_data ( ) const

pure virtualnoexcept

Get the block of bytes, to read them.

Returns

const byte* The first byte. Never null. It is valid for as long as this storage is alive.

get_data() [2/2]

virtual byte * vitrio::image_scratch_storage::get_data ( )

pure virtualnoexcept

Get the block of bytes.

Returns

byte* The first byte. Never null. It is valid for as long as this storage is alive.

get_size()

virtual std::size_t vitrio::image_scratch_storage::get_size ( ) const

pure virtualnoexcept

Get the size of the block.

Returns

std::size_t The number of bytes, which does not change.

---

The documentation for this class was generated from the following file:

• vitrio/image_scratch_storage.hpp