clan::Subtexture Class Reference

Sub-texture description. More...

#include <subtexture.h>

Public Member Functions

 Subtexture ()
 Constructs a null instance. More...
 
 Subtexture (Texture2D texture, const Rect &geometry)
 Constructs a Subtexture. More...
 
 ~Subtexture ()
 
Rect get_geometry () const
 Returns the part of the texture used by this object. More...
 
Texture2D get_texture ()
 Returns the texture. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
 operator bool () const
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Detailed Description

Sub-texture description.

Constructor & Destructor Documentation

clan::Subtexture::Subtexture ( )

Constructs a null instance.

clan::Subtexture::Subtexture ( Texture2D  texture,
const Rect geometry 
)

Constructs a Subtexture.

Parameters
texture= Texture
geometry= Rect
clan::Subtexture::~Subtexture ( )

Member Function Documentation

Rect clan::Subtexture::get_geometry ( ) const

Returns the part of the texture used by this object.

Texture2D clan::Subtexture::get_texture ( )

Returns the texture.

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

Returns true if this object is invalid.

clan::Subtexture::operator bool ( ) const
inlineexplicit
void clan::Subtexture::throw_if_null ( ) const

Throw an exception if this object is invalid.


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