clan::PixelBufferSet Class Reference

Set of images that combined form a complete texture. More...

#include <pixel_buffer_set.h>

Public Member Functions

 PixelBufferSet ()
 Constructs a null instance. More...
 
 PixelBufferSet (TextureDimensions dimensions, TextureFormat format, int width, int height=1, int slices=1)
 Constructs an image set of the specified dimensions type and internal format. More...
 
 PixelBufferSet (const PixelBuffer &image)
 Constructs an image set with a single image using the dimensions and internal format of the pixel buffer. More...
 
int get_base_level () const
 Returns the lowest mip level specified in the set. More...
 
TextureDimensions get_dimensions () const
 Returns the texture dimensions used by the image set. More...
 
TextureFormat get_format () const
 Returns the internal texture format used by the image. More...
 
int get_height () const
 Returns the height of the image. More...
 
PixelBuffer get_image (int slice, int level)
 Returns the pixel buffer for a specific slice and level. More...
 
int get_max_level () const
 Returns the highest mip level specified in the set. More...
 
int get_slice_count () const
 Returns the number of depth/array/cube slices in the set. More...
 
int get_width () const
 Returns the width of the image. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
 operator bool () const
 
void set_image (int slice, int level, const PixelBuffer &image)
 Set the pixel buffer to be used for the specified slice and level. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Detailed Description

Set of images that combined form a complete texture.

Constructor & Destructor Documentation

clan::PixelBufferSet::PixelBufferSet ( )

Constructs a null instance.

clan::PixelBufferSet::PixelBufferSet ( TextureDimensions  dimensions,
TextureFormat  format,
int  width,
int  height = 1,
int  slices = 1 
)

Constructs an image set of the specified dimensions type and internal format.

clan::PixelBufferSet::PixelBufferSet ( const PixelBuffer image)

Constructs an image set with a single image using the dimensions and internal format of the pixel buffer.

Member Function Documentation

int clan::PixelBufferSet::get_base_level ( ) const

Returns the lowest mip level specified in the set.

TextureDimensions clan::PixelBufferSet::get_dimensions ( ) const

Returns the texture dimensions used by the image set.

TextureFormat clan::PixelBufferSet::get_format ( ) const

Returns the internal texture format used by the image.

int clan::PixelBufferSet::get_height ( ) const

Returns the height of the image.

PixelBuffer clan::PixelBufferSet::get_image ( int  slice,
int  level 
)

Returns the pixel buffer for a specific slice and level.

int clan::PixelBufferSet::get_max_level ( ) const

Returns the highest mip level specified in the set.

int clan::PixelBufferSet::get_slice_count ( ) const

Returns the number of depth/array/cube slices in the set.

int clan::PixelBufferSet::get_width ( ) const

Returns the width of the image.

bool clan::PixelBufferSet::is_null ( ) const
inline

Returns true if this object is invalid.

clan::PixelBufferSet::operator bool ( ) const
inlineexplicit
void clan::PixelBufferSet::set_image ( int  slice,
int  level,
const PixelBuffer image 
)

Set the pixel buffer to be used for the specified slice and level.

void clan::PixelBufferSet::throw_if_null ( ) const

Throw an exception if this object is invalid.


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