uicore::PixelBufferSet Class Referenceabstract

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

#include <pixel_buffer_set.h>

Public Member Functions

virtual int base_level () const =0
 Returns the lowest mip level specified in the set. More...
 
virtual TextureDimensions dimensions () const =0
 Returns the texture dimensions used by the image set. More...
 
virtual TextureFormat format () const =0
 Returns the internal texture format used by the image. More...
 
virtual int height () const =0
 Returns the height of the image. More...
 
virtual PixelBufferPtr image (int slice, int level)=0
 Returns the pixel buffer for a specific slice and level. More...
 
virtual int max_level () const =0
 Returns the highest mip level specified in the set. More...
 
virtual void set_image (int slice, int level, const PixelBufferPtr &image)=0
 Set the pixel buffer to be used for the specified slice and level. More...
 
virtual int slice_count () const =0
 Returns the number of depth/array/cube slices in the set. More...
 
virtual int width () const =0
 Returns the width of the image. More...
 

Static Public Member Functions

static std::shared_ptr< PixelBufferSetcreate (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...
 
static std::shared_ptr< PixelBufferSetcreate (const PixelBufferPtr &image)
 Constructs an image set with a single image using the dimensions and internal format of the pixel buffer. More...
 

Detailed Description

Set of images that combined form a complete texture.

Member Function Documentation

virtual int uicore::PixelBufferSet::base_level ( ) const
pure virtual

Returns the lowest mip level specified in the set.

static std::shared_ptr<PixelBufferSet> uicore::PixelBufferSet::create ( TextureDimensions  dimensions,
TextureFormat  format,
int  width,
int  height = 1,
int  slices = 1 
)
static

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

static std::shared_ptr<PixelBufferSet> uicore::PixelBufferSet::create ( const PixelBufferPtr image)
static

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

virtual TextureDimensions uicore::PixelBufferSet::dimensions ( ) const
pure virtual

Returns the texture dimensions used by the image set.

virtual TextureFormat uicore::PixelBufferSet::format ( ) const
pure virtual

Returns the internal texture format used by the image.

virtual int uicore::PixelBufferSet::height ( ) const
pure virtual

Returns the height of the image.

virtual PixelBufferPtr uicore::PixelBufferSet::image ( int  slice,
int  level 
)
pure virtual

Returns the pixel buffer for a specific slice and level.

virtual int uicore::PixelBufferSet::max_level ( ) const
pure virtual

Returns the highest mip level specified in the set.

virtual void uicore::PixelBufferSet::set_image ( int  slice,
int  level,
const PixelBufferPtr image 
)
pure virtual

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

virtual int uicore::PixelBufferSet::slice_count ( ) const
pure virtual

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

virtual int uicore::PixelBufferSet::width ( ) const
pure virtual

Returns the width of the image.


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