List of all members
clan::Texture2D Class Reference
clanDisplay Display

2D texture object class. More...

`#include <texture_2d.h>`

Inheritance diagram for clan::Texture2D:

## Public Member Functions
Construction
| Texture2D ()
| Constructs a null instance. More...
| Texture2D (const std::shared_ptr< Texture_Impl > &impl)
| Texture2D (GraphicContext &context, int width, int height, TextureFormat format=tf_rgba8, int levels=1)
| Texture2D (GraphicContext &context, const Size &size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Texture2D (GraphicContext &context, const std::string &fullname, const ImageImportDescription &import_desc={})
| Texture2D (GraphicContext &context, const std::string &filename, const FileSystem &fs, const ImageImportDescription &import_desc={})
| Texture2D (GraphicContext &context, IODevice &file, const std::string &image_type, const ImageImportDescription &import_desc={})
| Texture2D (GraphicContext &context, const PixelBuffer &image, bool is_srgb=false)
| Texture2D (GraphicContext &context, const PixelBuffer &image, const Rect &src_rect, bool is_srgb=false)
Attributes
int | get_width () const
| Retrieves the actual width of the texture in the display. More...
int | get_height () const
| Retrieves the actual height of the texture in the display. More...
Size | get_size () const
| Retrieves the actual size of the texture. More...
float | get_pixel_ratio () const
float | get_dip_width () const
| Returns the device independent width of this texture. More...
float | get_dip_height () const
| Returns the device independent height of this texture. More...
Sizef | get_dip_size () const
| Returns the device independent size of this texture. More...
PixelBuffer | get_pixeldata (GraphicContext &gc, int level=0) const
| Retrieve image data from texture. More...
PixelBuffer | get_pixeldata (GraphicContext &gc, TextureFormat texture_format, int level=0) const
TextureWrapMode | get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...
TextureWrapMode | get_wrap_mode_t () const
| Get the texture wrap mode for the t coordinate. More...
Operations
void | set_image (GraphicContext &context, const PixelBuffer &image, int level=0)
void | set_subimage (GraphicContext &context, int x, int y, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | set_subimage (GraphicContext &context, const Point &point, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | copy_image_from (GraphicContext &context, int level, TextureFormat texture_format=tf_rgba8)
| Copy image data from a graphic context. More...
void | copy_image_from (GraphicContext &context, int x, int y, int width, int height, int level=0, TextureFormat texture_format=tf_rgba8)
void | copy_image_from (GraphicContext &context, const Rect &pos, int level=0, TextureFormat texture_format=tf_rgba8)
void | copy_subimage_from (GraphicContext &context, int offset_x, int offset_y, int x, int y, int width, int height, int level=0)
| Copy sub image data from a graphic context. More...
void | copy_subimage_from (GraphicContext &context, const Point &offset, const Rect &pos, int level=0)
void | set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t)
void | set_pixel_ratio (float ratio)
| Sets the display pixel ratio for this texture. More...
Public Member Functions inherited from clan::Texture
| 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 ()
bool | operator== (const Texture &other) const
| Equality operator. More...
bool | operator!= (const Texture &other) const
| Inequality operator. More...
bool | operator< (const Texture &other) const
| Less than operator. More...
bool | is_null () const
| Returns true if this object is invalid. More...
void | throw_if_null () const
| Throw an exception if this object is invalid. More...
float | get_min_lod () const
| Get the minimum level of detail. More...
float | get_max_lod () const
| Get the maximum level of detail. More...
float | get_lod_bias () const
| Get the level of detail bias constant. More...
int | get_base_level () const
| Get the texture base level. More...
int | get_max_level () const
| Get the texture max level. More...
TextureFilter | get_min_filter () const
| Get the texture minification filter. More...
TextureFilter | get_mag_filter () const
| Get the texture magnification filter. More...
bool | is_resident () const
| Returns true if texture is resident in texture memory. More...
TextureCompareMode | get_compare_mode () const
| Get the texture compare mode. More...
CompareFunction | get_compare_function () const
| Get the texture compare function. More...
TextureProvider * | get_provider () const
| Get Provider. More...
std::weak_ptr< Texture_Impl > | get_impl () const
| Get the implementation weakptr. More...
void | generate_mipmap ()
| Generate the mipmap. More...
void | set_min_lod (float min_lod)
| Set the minimum level of detail texture parameter. More...
void | set_max_lod (float max_lod)
| Set the maximum level of detail texture parameter. More...
void | set_lod_bias (float lod_bias)
| Sets the level of detail bias constant. More...
void | set_base_level (int base_level)
| Sets the texture base level texture parameter. More...
void | set_max_level (int max_level)
| Sets the texture max level texture parameter. More...
void | set_min_filter (TextureFilter filter)
| Set the minification filter. 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_texture_compare (TextureCompareMode mode, CompareFunction func)
| Sets the texture compare mode and compare function texture parameters. 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...

## Additional Inherited Members
Static Public Member Functions inherited from clan::Texture
static Resource< Texture > | resource (GraphicContext &gc, const std::string &id, const ResourceManager &resources)
| Retrieves a Texture resource from the resource manager. More...
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...
Protected Attributes inherited from clan::Texture
std::shared_ptr< Texture_Impl > | impl

## Detailed Description

2D texture object class.

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

- texture_2d.h