image Class Reference

Public Member Functions
void	clear ()
template<typename genType >
void	clear (genType const &Texel)
void *	data ()
void const *	data () const
template<typename genType >
genType *	data ()
template<typename genType >
genType const *	data () const
dim_type	dimensions () const
bool	empty () const
format_type	format () const
	image ()
	image (format_type Format, dim_type const &Dimensions)
	image (image const &Image, format_type Format)
template<typename genType >
genType	load (dim_type const &TexelCoord)
size_type	size () const
template<typename genType >
size_type	size () const
template<typename genType >
void	store (dim_type const &TexelCoord, genType const &Data)

Detailed Description

Image.

Definition at line 39 of file image.hpp.

Constructor & Destructor Documentation

image ( image const &  Image, format_type  Format  )

explicit

Create an image object by sharing an existing image storage from another image instance.

This image object is effectively an image view where format can be reinterpreted with a different compatible image format. For formats to be compatible, the block size of source and destination must match.

Member Function Documentation

void clear

(

genType const &

Texel

)

Clear the entire image storage with Texel which type must match the image storage format block size If the type of genType doesn't match the type of the image format, no conversion is performed and the data will be reinterpreted as if is was of the image format.

genType load

(

dim_type const &

TexelCoord

)

Load the texel located at TexelCoord coordinates.

It's an error to call this function if the format is compressed. It's an error if TexelCoord values aren't between [0, dimensions].

size_type size

(

)

const

Return the number of blocks contained in an image instance storage.

genType size must match the block size conresponding to the image format.

void store	(	dim_type const &	TexelCoord,
		genType const &	Data
	)

Store the texel located at TexelCoord coordinates.

It's an error to call this function if the format is compressed. It's an error if TexelCoord values aren't between [0, dimensions].