Texture object class. More...

#include <texture.h>

+ Inheritance diagram for clan::Texture:

Public Member Functions

 Texture ()
 Constructs a null instance. More...
 
 Texture (GraphicContext &gc, PixelBufferSet pixelbuffer_set)
 Constructs a texture as described in a pixelbuffer set. More...
 
 Texture (const std::shared_ptr< Texture_Impl > &impl)
 Constructs a texture from an implementation. More...
 
 Texture (TextureProvider *provider)
 Constructs a texture from a texture provider. More...
 
virtual ~Texture ()
 
void generate_mipmap ()
 Generate the mipmap. More...
 
int get_base_level () const
 Get the texture base level. More...
 
CompareFunction get_compare_function () const
 Get the texture compare function. More...
 
TextureCompareMode get_compare_mode () const
 Get the texture compare mode. More...
 
std::weak_ptr< Texture_Impl > get_impl () const
 Get the implementation weakptr. More...
 
float get_lod_bias () const
 Get the level of detail bias constant. More...
 
TextureFilter get_mag_filter () const
 Get the texture magnification filter. More...
 
int get_max_level () const
 Get the texture max level. More...
 
float get_max_lod () const
 Get the maximum level of detail. More...
 
TextureFilter get_min_filter () const
 Get the texture minification filter. More...
 
float get_min_lod () const
 Get the minimum level of detail. More...
 
TextureProviderget_provider () const
 Get Provider. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
bool is_resident () const
 Returns true if texture is resident in texture memory. More...
 
 operator bool () const
 
bool operator!= (const Texture &other) const
 Inequality operator. More...
 
bool operator< (const Texture &other) const
 Less than operator. More...
 
bool operator== (const Texture &other) const
 Equality operator. More...
 
void set_base_level (int base_level)
 Sets the texture base level texture parameter. More...
 
void set_lod_bias (float lod_bias)
 Sets the level of detail bias constant. More...
 
void set_mag_filter (TextureFilter filter)
 Set the magnification filter. More...
 
void set_max_anisotropy (float max_anisotropy)
 Set the maximum degree of anisotropy. More...
 
void set_max_level (int max_level)
 Sets the texture max level texture parameter. More...
 
void set_max_lod (float max_lod)
 Set the maximum level of detail texture parameter. More...
 
void set_min_filter (TextureFilter filter)
 Set the minification filter. More...
 
void set_min_lod (float min_lod)
 Set the minimum level of detail texture parameter. More...
 
void set_texture_compare (TextureCompareMode mode, CompareFunction func)
 Sets the texture compare mode and compare function texture parameters. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
Texture1D to_texture_1d () const
 Dynamic cast to Texture1D. More...
 
Texture1DArray to_texture_1d_array () const
 Dynamic cast to Texture1DArray. More...
 
Texture2D to_texture_2d () const
 Dynamic cast to Texture2D. More...
 
Texture2DArray to_texture_2d_array () const
 Dynamic cast to Texture2DArray. More...
 
Texture3D to_texture_3d () const
 Dynamic cast to Texture3D. More...
 
TextureCube to_texture_cube () const
 Dynamic cast to TextureCube. More...
 
TextureCubeArray to_texture_cube_array () const
 Dynamic cast to TextureCubeArray. More...
 

Static Public Member Functions

static Texture load (GraphicContext &gc, const std::string &id, const XMLResourceDocument &doc, const ImageImportDescription &import_desc=ImageImportDescription())
 Loads a Texture from a XML resource definition. More...
 
static Resource< Textureresource (GraphicContext &gc, const std::string &id, const ResourceManager &resources)
 Retrieves a Texture resource from the resource manager. More...
 

Protected Attributes

std::shared_ptr< Texture_Impl > impl
 

Friends

class Texture2DArray
 

Detailed Description

Texture object class.

Constructor & Destructor Documentation

clan::Texture::Texture ( )

Constructs a null instance.

clan::Texture::Texture ( GraphicContext gc,
PixelBufferSet  pixelbuffer_set 
)

Constructs a texture as described in a pixelbuffer set.

clan::Texture::Texture ( const std::shared_ptr< Texture_Impl > &  impl)

Constructs a texture from an implementation.

Parameters
impl= The implementation
clan::Texture::Texture ( TextureProvider provider)

Constructs a texture from a texture provider.

Parameters
provider= The provider
virtual clan::Texture::~Texture ( )
virtual

Member Function Documentation

void clan::Texture::generate_mipmap ( )

Generate the mipmap.

int clan::Texture::get_base_level ( ) const

Get the texture base level.

CompareFunction clan::Texture::get_compare_function ( ) const

Get the texture compare function.

TextureCompareMode clan::Texture::get_compare_mode ( ) const

Get the texture compare mode.

std::weak_ptr<Texture_Impl> clan::Texture::get_impl ( ) const

Get the implementation weakptr.

This is used to assist is creating Texture caches internally within clanlib

float clan::Texture::get_lod_bias ( ) const

Get the level of detail bias constant.

TextureFilter clan::Texture::get_mag_filter ( ) const

Get the texture magnification filter.

int clan::Texture::get_max_level ( ) const

Get the texture max level.

float clan::Texture::get_max_lod ( ) const

Get the maximum level of detail.

TextureFilter clan::Texture::get_min_filter ( ) const

Get the texture minification filter.

float clan::Texture::get_min_lod ( ) const

Get the minimum level of detail.

TextureProvider* clan::Texture::get_provider ( ) const

Get Provider.

Returns
provider
bool clan::Texture::is_null ( ) const
inline

Returns true if this object is invalid.

References impl.

bool clan::Texture::is_resident ( ) const

Returns true if texture is resident in texture memory.

static Texture clan::Texture::load ( GraphicContext gc,
const std::string id,
const XMLResourceDocument doc,
const ImageImportDescription import_desc = ImageImportDescription() 
)
static

Loads a Texture from a XML resource definition.

clan::Texture::operator bool ( ) const
inlineexplicit
bool clan::Texture::operator!= ( const Texture other) const
inline

Inequality operator.

References impl.

bool clan::Texture::operator< ( const Texture other) const
inline

Less than operator.

References impl.

bool clan::Texture::operator== ( const Texture other) const
inline

Equality operator.

References impl.

static Resource<Texture> clan::Texture::resource ( GraphicContext gc,
const std::string id,
const ResourceManager resources 
)
static

Retrieves a Texture resource from the resource manager.

Parameters
gc= Graphic Context
resources= Resource manager
id= id
void clan::Texture::set_base_level ( int  base_level)

Sets the texture base level texture parameter.

void clan::Texture::set_lod_bias ( float  lod_bias)

Sets the level of detail bias constant.

void clan::Texture::set_mag_filter ( TextureFilter  filter)

Set the magnification filter.

void clan::Texture::set_max_anisotropy ( float  max_anisotropy)

Set the maximum degree of anisotropy.

void clan::Texture::set_max_level ( int  max_level)

Sets the texture max level texture parameter.

void clan::Texture::set_max_lod ( float  max_lod)

Set the maximum level of detail texture parameter.

void clan::Texture::set_min_filter ( TextureFilter  filter)

Set the minification filter.

void clan::Texture::set_min_lod ( float  min_lod)

Set the minimum level of detail texture parameter.

void clan::Texture::set_texture_compare ( TextureCompareMode  mode,
CompareFunction  func 
)

Sets the texture compare mode and compare function texture parameters.

void clan::Texture::throw_if_null ( ) const

Throw an exception if this object is invalid.

Texture1D clan::Texture::to_texture_1d ( ) const

Dynamic cast to Texture1D.

Texture1DArray clan::Texture::to_texture_1d_array ( ) const

Dynamic cast to Texture1DArray.

Texture2D clan::Texture::to_texture_2d ( ) const

Dynamic cast to Texture2D.

Texture2DArray clan::Texture::to_texture_2d_array ( ) const

Dynamic cast to Texture2DArray.

Texture3D clan::Texture::to_texture_3d ( ) const

Dynamic cast to Texture3D.

TextureCube clan::Texture::to_texture_cube ( ) const

Dynamic cast to TextureCube.

TextureCubeArray clan::Texture::to_texture_cube_array ( ) const

Dynamic cast to TextureCubeArray.

Friends And Related Function Documentation

friend class Texture2DArray
friend

Member Data Documentation

std::shared_ptr<Texture_Impl> clan::Texture::impl
protected

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