Stellarium 0.13.2
List of all members | Classes | Signals | Public Member Functions
StelTexture Class Reference

Base texture class. More...

#include <StelTexture.hpp>

Classes

struct  StelTextureParams
 Contains the parameters defining how a texture is created. More...
 

Signals

void loadingProcessFinished (bool error)
 Emitted when the texture is ready to be bind(), i.e. More...
 

Public Member Functions

virtual ~StelTexture ()
 Destructor. More...
 
bool bind (int slot=0)
 Bind the texture so that it can be used for openGL drawing (calls glBindTexture). More...
 
bool canBind () const
 Return whether the texture can be binded, i.e. it is fully loaded. More...
 
bool getDimensions (int &width, int &height)
 Return the width and heigth of the texture in pixels. More...
 
const QString & getErrorMessage () const
 Get the error message which caused the texture loading to fail. More...
 
const QString & getFullPath () const
 Return the full path to the image file. More...
 
bool isLoading () const
 Return whether the image is currently being loaded. More...
 

Detailed Description

Base texture class.

For creating an instance, use StelTextureMgr::createTexture() and StelTextureMgr::createTextureThread()

See also
StelTextureSP

Definition at line 41 of file StelTexture.hpp.

Constructor & Destructor Documentation

virtual StelTexture::~StelTexture ( )
virtual

Destructor.

Member Function Documentation

bool StelTexture::bind ( int  slot = 0)

Bind the texture so that it can be used for openGL drawing (calls glBindTexture).

If the texture is lazyly loaded, this starts the loading and return false immediately.

Returns
true if the binding successfully occured, false if the texture is not yet loaded.
bool StelTexture::canBind ( ) const
inline

Return whether the texture can be binded, i.e. it is fully loaded.

Definition at line 71 of file StelTexture.hpp.

bool StelTexture::getDimensions ( int &  width,
int &  height 
)

Return the width and heigth of the texture in pixels.

const QString& StelTexture::getErrorMessage ( ) const
inline

Get the error message which caused the texture loading to fail.

Returns
the human friendly error message or empty string if no errors occured

Definition at line 78 of file StelTexture.hpp.

const QString& StelTexture::getFullPath ( ) const
inline

Return the full path to the image file.

If the texture was downloaded from a remote location, this function return the full URL.

Definition at line 82 of file StelTexture.hpp.

bool StelTexture::isLoading ( ) const
inline

Return whether the image is currently being loaded.

Definition at line 85 of file StelTexture.hpp.

void StelTexture::loadingProcessFinished ( bool  error)
signal

Emitted when the texture is ready to be bind(), i.e.

when downloaded, imageLoading and glLoading is over or when an error occured and the texture will never be available In case of error, you can query what the problem was by calling getErrorMessage()

Parameters
erroris equal to true if an error occured while loading the texture

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