Public Types |
enum | StatFlags {
SF_NONE = 0,
SF_FPS = 1,
SF_AVG_FPS = 2,
SF_BEST_FPS = 4,
SF_WORST_FPS = 8,
SF_TRIANGLE_COUNT = 16,
SF_ALL = 0xFFFF
} |
Public Methods |
virtual bool | isRenderTarget () |
| @copydoc Texture::isRenderTarget. More...
|
unsigned short | getNumMipMaps (void) |
| Gets the number of mipmaps to be used for this texture. More...
|
void | setNumMipMaps (unsigned short num) |
| Sets the number of mipmaps to be used for this texture. More...
|
float | getGamma (void) |
| Returns the gamma adjustment factor applied to this texture. More...
|
void | setGamma (float g) |
| Sets the gamma adjustment factor applied to this texture. More...
|
unsigned int | getHeight (void) |
| Returns the height of the texture. More...
|
unsigned int | getWidth (void) |
| Returns the width of the texture. More...
|
std::pair< uint, uint > | getDimensions () |
| Returns both the width and height of the texture. More...
|
TextureUsage | getUsage () const |
virtual void | blitToTexture (const Image &src, unsigned uStartX, unsigned uStartY)=0 |
| Blits the contents of src on the texture. More...
|
virtual void | blitImage (const Image &src, const Image::Rect imgRect, const Image::Rect texRect) |
| Blits a rect from an image to the texture. More...
|
virtual void | copyToTexture (Texture *target) |
| Copies (and maybe scales to fit) the contents of this texture to another texture. More...
|
virtual void | loadImage (const Image &img)=0 |
| Loads the data from an image. More...
|
void | enable32Bit (bool setting=true) |
virtual PixelFormat | getFormat () const |
| Returns the pixel format for the texture surface. More...
|
virtual bool | hasAlpha (void) |
| Returns true if the texture has an alpha layer. More...
|
virtual void | load ()=0 |
| Loads the resource, if it is not already. More...
|
virtual void | unload () |
| Unloads the resource, but retains data to recreate. More...
|
virtual size_t | getSize (void) |
| Retrieves info about the size of the resource. More...
|
void | touch (void) |
| 'Touches' the resource to indicate it has been used. More...
|
time_t | getLastAccess (void) const |
| Gets the last time the resource was 'touched'. More...
|
const String & | getName (void) const |
| Gets resource name. More...
|
bool | isLoaded (void) const |
| Returns true if the Resource has been loaded, false otherwise. More...
|
virtual void | destroy () |
| A method to make the resource delete itself. More...
|
virtual String | getName (void) |
| Retrieve target's name. More...
|
virtual void | getMetrics (int &width, int &height, int &colourDepth) |
| Retrieve information about the render target. More...
|
virtual int | getWidth (void) |
virtual int | getHeight (void) |
virtual int | getColourDepth (void) |
virtual void | update (void) |
| Tells the target to update it's contents. More...
|
virtual Viewport * | addViewport (Camera *cam, int ZOrder=0, float left=0, float top=0, float width=100, float height=100) |
| Adds a viewport to the rendering target. More...
|
virtual unsigned short | getNumViewports (void) |
| Returns the number of viewports attached to this target. More...
|
virtual Viewport * | getViewport (unsigned short index) |
| Retrieves a pointer to the viewport with the given index. More...
|
virtual void | removeViewport (int ZOrder) |
| Removes a viewport at a given ZOrder. More...
|
virtual void | removeAllViewports (void) |
| Removes all viewports on this target. More...
|
virtual void | setStatsDisplay (StatFlags sf) |
| DEPRECATED Set what kind of statistics display (if any) should be displayed by the system about this target. More...
|
virtual void | getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) |
| Retieves details of current rendering performance. More...
|
virtual float | getLastFPS () |
| Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered. More...
|
virtual float | getAverageFPS () |
| Individual stats access - gets the average frames per second (FPS) since call to RenderSystem::startRendering. More...
|
virtual float | getBestFPS () |
| Individual stats access - gets the best frames per second (FPS) since call to RenderSystem::startRendering. More...
|
virtual float | getWorstFPS () |
| Individual stats access - gets the worst frames per second (FPS) since call to RenderSystem::startRendering. More...
|
virtual void | resetStatistics (void) |
| Resets saved frame-rate statistices. More...
|
virtual void | outputText (int x, int y, const String &text)=0 |
| DEPRECATED Outputs text to the target at the specified co-ordinates. More...
|
virtual void | getCustomAttribute (String name, void *pData) |
| Gets a custom (maybe platform-specific) attribute. More...
|
virtual void | setDebugText (const String &text) |
| Adds debug text to this window. More...
|
const String & | RenderTarget::getDebugText () const |
| Returns the debug text. More...
|
virtual void | addListener (RenderTargetListener *listener) |
| Add a listener to this RenderTarget which will be called back before & after rendering. More...
|
virtual void | removeListener (RenderTargetListener *listener) |
| Removes a RenderTargetListener previously registered using addListener. More...
|
virtual void | removeAllListeners (void) |
| Removes all listeners from this instance. More...
|
virtual void | setPriority (uchar priority) |
| Sets the priority of this render target in relation to the others. More...
|
virtual uchar | getPriority () const |
| Gets the priority of a render target. More...
|
virtual bool | isActive () const |
| Used to retrieve or set the active state of the render target. More...
|
virtual void | setActive (bool state) |
| Used to retrieve the active state of the render target. More...
|
virtual void | writeContentsToFile (const String &filename)=0 |
| Writes the current contents of the render target to the named file. More...
|
virtual bool | requiresTextureFlipping () const=0 |
Protected Types |
typedef std::map< int, Viewport *,
std::less< int > > | ViewportList |
typedef std::vector< RenderTargetListener * > | RenderTargetListenerList |
Protected Methods |
void | updateStats (void) |
virtual void | firePreUpdate (void) |
| internal method for firing events. More...
|
virtual void | firePostUpdate (void) |
| internal method for firing events. More...
|
Protected Attributes |
unsigned long | mHeight |
unsigned long | mWidth |
unsigned short | mNumMipMaps |
float | mGamma |
PixelFormat | mFormat |
TextureUsage | mUsage |
unsigned short | mSrcBpp |
unsigned long | mSrcWidth |
unsigned long | mSrcHeight |
unsigned short | mFinalBpp |
bool | mHasAlpha |
String | mName |
bool | mIsLoaded |
time_t | mLastAccess |
size_t | mSize |
String | mName |
| The name of this target. More...
|
uchar | mPriority |
| The priority of the render target. More...
|
int | mWidth |
int | mHeight |
int | mColourDepth |
bool | mIsDepthBuffered |
StatFlags | mStatFlags |
float | mLastFPS |
float | mAvgFPS |
float | mBestFPS |
float | mWorstFPS |
unsigned int | mTris |
String | mDebugText |
bool | mActive |
ViewportList | mViewportList |
| List of viewports, map on Z-order. More...
|
RenderTargetListenerList | mListeners |