Texture handler class. More...
#include <TextureHandler.h>
Inheritance diagram for PLRenderer::TextureHandler:
Classes | |
| class | AnimationState |
| Texture animation state. More... | |
Public Member Functions | |
| PLRENDERER_API | TextureHandler () |
| Constructor. | |
| virtual PLRENDERER_API | ~TextureHandler () |
| Destructor. | |
| PLRENDERER_API bool | Load (TextureManager &cTextureManager, const PLCore::String &sFilename, bool bReloadTexture=false) |
| Load texture. | |
| PLRENDERER_API bool | Unload () |
| Unload texture. | |
| PLRENDERER_API bool | Bind (PLCore::uint32 nStage=0) const |
| Makes the texture handlers texture to the current renderer texture. | |
| PLRENDERER_API Texture * | GetTexture () const |
| Returns the texture handlers texture. | |
| PLRENDERER_API TextureHandler & | operator= (const TextureHandler &cSource) |
| Copy operator. | |
| AnimationState * | GetAnimationState () const |
| Returns the texture animation state object (if there's one :) | |
Detailed Description
Texture handler class.
Constructor & Destructor Documentation
| PLRENDERER_API PLRenderer::TextureHandler::TextureHandler | ( | ) |
Constructor.
| virtual PLRENDERER_API PLRenderer::TextureHandler::~TextureHandler | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| PLRENDERER_API bool PLRenderer::TextureHandler::Load | ( | TextureManager & | cTextureManager, |
| const PLCore::String & | sFilename, | ||
| bool | bReloadTexture = false |
||
| ) |
Load texture.
- Parameters:
-
[in] cTextureManager Texture manager to use [in] sFilename Texture filename. It's also possible to create textures dynamically. "Create PLRenderer::TextureCreatorASCII3D Name=\"ASCII3D" ASCIIFilename="Data/Textures/PostProcess/Font.dds"" For instance will use the texture creator class 'PLRenderer::TextureCreatorASCII3D' to create a texture with the name 'ASCII3D' and some parameters. [in] bReloadTexture Force texture itself to be reloaded?
- Returns:
- 'true' if all went fine, else 'false'
| PLRENDERER_API bool PLRenderer::TextureHandler::Unload | ( | ) |
Unload texture.
- Returns:
- 'true' if all went fine, else 'false'
| PLRENDERER_API bool PLRenderer::TextureHandler::Bind | ( | PLCore::uint32 | nStage = 0 | ) | const |
Makes the texture handlers texture to the current renderer texture.
- Parameters:
-
[in] nStage Which texture stage?
- Returns:
- 'true' if all went fine, else 'false'
- Note:
- The texture handlers texture transformation matrix is also set!
| PLRENDERER_API Texture* PLRenderer::TextureHandler::GetTexture | ( | ) | const |
Returns the texture handlers texture.
- Returns:
- Pointer to the texture handlers texture, can be a null pointer
| PLRENDERER_API TextureHandler& PLRenderer::TextureHandler::operator= | ( | const TextureHandler & | cSource | ) |
Copy operator.
- Parameters:
-
[in] cSource Source to copy from
- Returns:
- This instance
| TextureHandler::AnimationState * PLRenderer::TextureHandler::GetAnimationState | ( | ) | const [inline] |
Returns the texture animation state object (if there's one :)
- Returns:
- The texture animation state object, a null pointer if there's no such object
The documentation for this class was generated from the following files:
