Arcade Shooter
Public Member Functions | Static Public Member Functions | List of all members
KatanaEngine::RenderTarget Class Reference

Contains a 2D texture that can be used as a render target. More...

#include <RenderTarget.h>

Inheritance diagram for KatanaEngine::RenderTarget:
KatanaEngine::Texture KatanaEngine::Resource

Public Member Functions

 RenderTarget (const int width, const int height)
 Instantiate a render target object. More...
 
virtual bool Load (const std::string &path, ResourceManager *pManager)
 Render targets don't need to be loaded so this simply returns true. More...
 
- Public Member Functions inherited from KatanaEngine::Texture
int GetWidth () const
 Gets the width of the texture in pixels. More...
 
int GetHeight () const
 Gets the height of the texture in pixels. More...
 
Vector2 GetSize () const
 Gets the dimensions of the texture. More...
 
Vector2 GetCenter () const
 Gets the center position of the texture. More...
 
virtual bool IsCloneable () const
 Used to determine if the texture is cloneable. More...
 
virtual ALLEGRO_BITMAP * GetAllegroBitmap () const
 Get the allegro bitmap representation of the texture. More...
 
- Public Member Functions inherited from KatanaEngine::Resource
unsigned short GetResourceID () const
 Gets the ID of the resource. More...
 

Static Public Member Functions

static void Set (RenderTarget *pTarget)
 Set the desired target to render to when drawing. More...
 
static void SetDisplay (ALLEGRO_DISPLAY *pDisplay)
 Set the display of the target. More...
 

Additional Inherited Members

- Protected Member Functions inherited from KatanaEngine::Texture
virtual void SetTexture (ALLEGRO_BITMAP *pBitmap)
 Used to set the underlaying allegro bitmap. More...
 
- Protected Member Functions inherited from KatanaEngine::Resource
void Split (const std::string &line, const char delimeter, std::vector< std::string > &elements)
 Splits a string into a vector of strings. More...
 
void ParseComments (std::string &line)
 Removes c-style, single-line comments from a line of text. More...
 
void TrimLine (std::string &line)
 Removes white-space at the front and end of a line of text. More...
 
ResourceManagerGetResourceManager ()
 Gets a pointer to the ResourceManager that was used to load the resource. More...
 
virtual ResourceClone ()
 Clones a resource. More...
 

Detailed Description

Contains a 2D texture that can be used as a render target.

Constructor & Destructor Documentation

◆ RenderTarget()

KatanaEngine::RenderTarget::RenderTarget ( const int  width,
const int  height 
)

Instantiate a render target object.

Parameters
widthThe width of the render target.
heightThe height of the render target.

Member Function Documentation

◆ Load()

virtual bool KatanaEngine::RenderTarget::Load ( const std::string &  path,
ResourceManager pManager 
)
inlinevirtual

Render targets don't need to be loaded so this simply returns true.

Parameters
pathThe path to the desired resource.
pManagerA pointer to the ResourceManager that will manage the resource.
Returns
Returns true.

Reimplemented from KatanaEngine::Texture.

◆ Set()

void KatanaEngine::RenderTarget::Set ( RenderTarget pTarget)
static

Set the desired target to render to when drawing.

Parameters
pTargetA pointer to the desired render target.

◆ SetDisplay()

static void KatanaEngine::RenderTarget::SetDisplay ( ALLEGRO_DISPLAY *  pDisplay)
inlinestatic

Set the display of the target.

Parameters
pDisplayA pointer to the display.

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