# Ogre::RenderTargetTexture Class Reference

`#include <OgreRenderTargetTexture.h>`

Inheritance diagram for Ogre::RenderTargetTexture:

List of all members.

## 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 Member Functions

virtual bool | isRenderTarget () const
virtual void | setTextureType (TextureType ttype)
| Sets the type of texture; can only be changed before load().
virtual TextureType | getTextureType (void) const
| Gets the type of texture.
virtual size_t | getNumMipmaps (void) const
| Gets the number of mipmaps to be used for this texture.
virtual void | setNumMipmaps (size_t num)
| Sets the number of mipmaps to be used for this texture.
virtual bool | getMipmapsHardwareGenerated (void) const
| Are mipmaps hardware generated?
virtual float | getGamma (void) const
| Returns the gamma adjustment factor applied to this texture.
virtual void | setGamma (float g)
| Sets the gamma adjustment factor applied to this texture.
virtual unsigned int | getHeight (void) const
| Returns the height of the texture.
virtual unsigned int | getWidth (void) const
| Returns the width of the texture.
virtual unsigned int | getDepth (void) const
| Returns the depth of the texture (only applicable for 3D textures).
virtual unsigned int | getSrcHeight (void) const
| Returns the height of the original input texture (may differ due to hardware requirements).
virtual unsigned int | getSrcWidth (void) const
| Returns the width of the original input texture (may differ due to hardware requirements).
virtual unsigned int | getSrcDepth (void) const
| Returns the original depth of the input texture (only applicable for 3D textures).
virtual void | setHeight (unsigned int h)
| Set the height of the texture; can only do this before load();.
virtual void | setWidth (unsigned int w)
| Set the width of the texture; can only do this before load();.
virtual void | setDepth (unsigned int d)
| Set the depth of the texture (only applicable for 3D textures); ; can only do this before load();.
virtual int | getUsage () const
| Returns the TextureUsage indentifier for this Texture.
virtual void | setUsage (int u)
| Sets the TextureUsage indentifier for this Texture; only useful before load().
virtual void | createInternalResources (void)
| Creates the internal texture resources for this texture.
virtual void | freeInternalResources (void)
| Frees internal texture resources for this texture.
virtual void | copyToTexture (TexturePtr &target)
| Copies (and maybe scales to fit) the contents of this texture to another texture.
virtual void | loadImage (const Image &img)=0
| Loads the data from an image.
virtual void | loadRawData (DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat eFormat)
| Loads the data from a raw stream.
virtual void | enable32Bit (bool setting=true)
virtual PixelFormat | getFormat () const
| Returns the pixel format for the texture surface.
virtual void | setFormat (PixelFormat pf)
| Sets the pixel format for the texture surface; can only be set before load().
virtual bool | hasAlpha (void) const
| Returns true if the texture has an alpha layer.
virtual size_t | getNumFaces () const
| Return the number of faces this texture has.
virtual HardwarePixelBufferSharedPtr | getBuffer (size_t face=0, size_t mipmap=0)=0
| Return hardware pixel buffer for a surface.
virtual void | load (void)
| Loads the resource, if it is not already.
virtual void | reload (void)
| Reloads the resource, if it is already loaded.
bool | isReloadable (void) const
| Returns true if the Resource is reloadable, false otherwise.
bool | isManuallyLoaded (void) const
| Is this resource manually loaded?
virtual void | unload (void)
| Unloads the resource; this is not permanent, the resource can be reloaded later if required.
size_t | getSize (void) const
| Retrieves info about the size of the resource.
virtual void | touch (void)
| 'Touches' the resource to indicate it has been used.
const String & | getName (void) const
| Gets resource name.
ResourceHandle | getHandle (void) const
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise.
const String & | getGroup (void)
| Gets the group which this resource is a member of.
ResourceManager * | getCreator (void)
| Gets the manager which created this resource.
const String & | getOrigin (void) const
| Get the origin of this resource, e.g.
void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin.
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class.
const ParamDictionary * | getParamDictionary (void) const
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object.
virtual bool | setParameter (const String &name, const String &value)
| Generic parameter setting method.
virtual void | setParameterList (const NameValuePairList &paramList)
| Generic multiple parameter setting method.
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method.
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object.
virtual const String & | getName (void) const
| Retrieve target's name.
virtual void | getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
| Retrieve information about the render target.
virtual unsigned int | getWidth (void) const
virtual unsigned int | getHeight (void) const
virtual unsigned int | getColourDepth (void) const
virtual void | update (void)
| Tells the target to update it's contents.
virtual Viewport * | addViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f)
| Adds a viewport to the rendering target.
virtual unsigned short | getNumViewports (void) const
| Returns the number of viewports attached to this target.
virtual Viewport * | getViewport (unsigned short index)
| Retrieves a pointer to the viewport with the given index.
virtual void | removeViewport (int ZOrder)
| Removes a viewport at a given ZOrder.
virtual void | removeAllViewports (void)
| Removes all viewports on this target.
virtual void | getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const
| Retieves details of current rendering performance.
virtual const FrameStats & | getStatistics (void) const
virtual float | getLastFPS () const
| Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
virtual float | getAverageFPS () const
| Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.
virtual float | getBestFPS () const
| Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.
virtual float | getWorstFPS () const
| Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.
virtual float | getBestFrameTime () const
| Individual stats access - gets the best frame time.
virtual float | getWorstFrameTime () const
| Individual stats access - gets the worst frame time.
virtual void | resetStatistics (void)
| Resets saved frame-rate statistices.
virtual void | getCustomAttribute (const String &name, void *pData)
| Gets a custom (maybe platform-specific) attribute.
virtual void | setDebugText (const String &text)
| Adds debug text to this window.
const String & | getDebugText () const
| Returns the debug text.
virtual void | addListener (RenderTargetListener *listener)
| Add a listener to this RenderTarget which will be called back before & after rendering.
virtual void | removeListener (RenderTargetListener *listener)
| Removes a RenderTargetListener previously registered using addListener.
virtual void | removeAllListeners (void)
| Removes all listeners from this instance.
virtual void | setPriority (uchar priority)
| Sets the priority of this render target in relation to the others.
virtual uchar | getPriority () const
| Gets the priority of a render target.
virtual bool | isActive () const
| Used to retrieve or set the active state of the render target.
virtual void | setActive (bool state)
| Used to set the active state of the render target.
virtual void | setAutoUpdated (bool autoupdate)
| Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
virtual bool | isAutoUpdated (void) const
| Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
virtual void | writeContentsToFile (const String &filename)=0
| Writes the current contents of the render target to the named file.
virtual String | writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
| Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.
virtual bool | requiresTextureFlipping () const=0
virtual size_t | getTriangleCount (void) const
| Gets the number of triangles rendered in the last update() call.
virtual void | _notifyCameraRemoved (const Camera *cam)
| Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.
virtual bool | isPrimary (void) const
| Indicates whether this target is the primary window.

## Static Public Member Functions

void | cleanupDictionary ()
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

## Protected Types

typedef std::map< int, Viewport *, std::less< int > > | ViewportList
typedef std::vector< RenderTargetListener * > | RenderTargetListenerList

## Protected Member Functions

size_t | calculateSize (void) const
virtual void | _loadImages (const std::vector< const Image * > &images)
| Generic method to load the texture from a set of images.
virtual void | createInternalResourcesImpl (void)=0
| Implementation of creating internal texture resources.
virtual void | freeInternalResourcesImpl (void)=0
| Implementation of freeing internal texture resources.
void | unloadImpl (void)
| Default implementation of unload which calls freeInternalResources.
virtual void | loadImpl (void)=0
| Internal implementation of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist.
void | updateStats (void)
virtual void | firePreUpdate (void)
| internal method for firing events
virtual void | firePostUpdate (void)
| internal method for firing events
virtual void | fireViewportPreUpdate (Viewport *vp)
| internal method for firing events
virtual void | fireViewportPostUpdate (Viewport *vp)
| internal method for firing events

## Protected Attributes

unsigned long | mHeight
unsigned long | mWidth
unsigned long | mDepth
size_t | mNumRequestedMipmaps
size_t | mNumMipmaps
bool | mMipmapsHardwareGenerated
float | mGamma
TextureType | mTextureType
PixelFormat | mFormat
int | mUsage
unsigned short | mSrcBpp
unsigned long | mSrcWidth
unsigned long | mSrcHeight
unsigned long | mSrcDepth
unsigned short | mFinalBpp
bool | mHasAlpha
bool | mInternalResourcesCreated
ResourceManager * | mCreator
| Creator.
String | mName
| Unique name of the resource.
String | mGroup
| The name of the resource group.
ResourceHandle | mHandle
| Numeric handle for more efficient look up than name.
bool | mIsLoaded
| Is the resource currently loaded?
size_t | mSize
| The size of the resource in bytes.
bool | mIsManual
| Is this file manually loaded?
String | mOrigin
| Origin of this resource (e.g. script name) - optional.
ManualResourceLoader * | mLoader
| Optional manual loader; if provided, data is loaded from here instead of a file.
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).
String | mName
| The name of this target.
uchar | mPriority
| The priority of the render target.
unsigned int | mWidth
unsigned int | mHeight
unsigned int | mColourDepth
bool | mIsDepthBuffered
FrameStats | mStats
Timer * | mTimer
String | mDebugText
unsigned long | mLastSecond
unsigned long | mLastTime
size_t | mFrameCount
bool | mActive
bool | mAutoUpdate
ViewportList | mViewportList
| List of viewports, map on Z-order.
RenderTargetListenerList | mListeners

## Static Protected Attributes

ParamDictionaryMap | msDictionary
| Dictionary of parameters.

## Member Typedef Documentation

typedef std::vector<RenderTargetListener*> Ogre::RenderTarget::RenderTargetListenerList `[protected, inherited]`

| Definition at line 319 of file OgreRenderTarget.h.

typedef std::map<int, Viewport*, std::less<int> > Ogre::RenderTarget::ViewportList `[protected, inherited]`

| Definition at line 315 of file OgreRenderTarget.h.

## Member Enumeration Documentation

enum Ogre::RenderTarget::StatFlags `[inherited]`

Enumeration values:

  SF_NONE |
  SF_FPS |
  SF_AVG_FPS |
  SF_BEST_FPS |
  SF_WORST_FPS |
  SF_TRIANGLE_COUNT |
  SF_ALL |

Definition at line 58 of file OgreRenderTarget.h.

## Member Function Documentation

virtual void Ogre::Texture::_loadImages | ( | const std::vector< const Image * > & | images | ) | `[protected, virtual, inherited]`

Generic method to load the texture from a set of images.

This can be used by the specific implementation for convience. Implementations might decide not to use this function if they can use their own image loading functions.

Parameters:

  images | Vector of pointers to Images. If there is only one image in this vector, the faces of that image will be used. If there are multiple images in the vector each image will be loaded as a face.

virtual void Ogre::RenderTarget::_notifyCameraRemoved | ( | const Camera * | cam | ) | `[virtual, inherited]`

| Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.

void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | `[inherited]`

| Notify this resource of it's origin. Definition at line 214 of file OgreResource.h. References Ogre::String.

virtual void Ogre::RenderTarget::addListener | ( | RenderTargetListener * | listener | ) | `[virtual, inherited]`

Add a listener to this RenderTarget which will be called back before & after rendering.

Remarks:
  If you want notifications before and after a target is updated by the system, use this method to register your own custom RenderTargetListener class. This is useful for potentially adding your own manual rendering commands before and after the 'normal' system rendering.

NB this should not be used for frame-based scene updates, use Root::addFrameListener for that.

virtual Viewport* Ogre::RenderTarget::addViewport | ( | Camera * | cam,
|  | int | ZOrder = 0,
|  | float | left = 0.0f,
|  | float | top = 0.0f,
|  | float | width = 1.0f,
|  | float | height = 1.0f
| ) | `[virtual, inherited]`

Adds a viewport to the rendering target.

Remarks:
  A viewport is the rectangle into which redering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.

Parameters:

  cam | The camera from which the viewport contents will be rendered (mandatory)
  ZOrder | The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher ZOrders are on top of lower ones. The actual number is irrelevant, only the relative ZOrder matters (you can leave gaps in the numbering)
  left | The relative position of the left of the viewport on the target, as a value between 0 and 1.
  top | The relative position of the top of the viewport on the target, as a value between 0 and 1.
  width | The relative width of the viewport on the target, as a value between 0 and 1.
  height | The relative height of the viewport on the target, as a value between 0 and 1.

size_t Ogre::Texture::calculateSize | ( | void |  | ) | const`[protected, virtual, inherited]`

| Implements Ogre::Resource.

void Ogre::StringInterface::cleanupDictionary | ( |  | ) | `[static, inherited]`

| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. MaterialManager) initializes.

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const`[virtual, inherited]`

Method for copying this object's parameters to another object.

Remarks:
  This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

  Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 296 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

virtual void Ogre::Texture::copyToTexture | ( | TexturePtr & | target | ) | `[virtual, inherited]`

| Copies (and maybe scales to fit) the contents of this texture to another texture. Reimplemented in Ogre::D3DTexture, and Ogre::D3D9Texture. Definition at line 201 of file OgreTexture.h.

virtual void Ogre::Texture::createInternalResources | ( | void |  | ) | `[virtual, inherited]`

Creates the internal texture resources for this texture.

Remarks:
  This method creates the internal texture resources (pixel buffers, texture surfaces etc) required to begin using this texture. You do not need to call this method directly unless you are manually creating a texture, in which case something must call it, after having set the size and format of the texture (e.g. the ManualResourceLoader might be the best one to call it). If you are not defining a manual texture, or if you use one of the self-contained load...() methods, then it will be called for you.

virtual void Ogre::Texture::createInternalResourcesImpl | ( | void |  | ) | `[protected, pure virtual, inherited]`

| Implementation of creating internal texture resources. Implemented in Ogre::D3DTexture, Ogre::D3D9Texture, and Ogre::GLTexture.

bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | `[protected, inherited]`

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

  className | the name of the class using the dictionary

Returns:
  true if a new dictionary was created, false if it was already there

Definition at line 172 of file OgreStringInterface.h.

References Ogre::String.

virtual void Ogre::Texture::enable32Bit | ( | bool | setting = true | ) | `[virtual, inherited]`

| Definition at line 212 of file OgreTexture.h.

virtual void Ogre::RenderTarget::firePostUpdate | ( | void |  | ) | `[protected, virtual, inherited]`

| internal method for firing events Reimplemented in Ogre::RenderTexture.

virtual void Ogre::RenderTarget::firePreUpdate | ( | void |  | ) | `[protected, virtual, inherited]`

| internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPostUpdate | ( | Viewport * | vp | ) | `[protected, virtual, inherited]`

| internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPreUpdate | ( | Viewport * | vp | ) | `[protected, virtual, inherited]`

| internal method for firing events

virtual void Ogre::Texture::freeInternalResources | ( | void |  | ) | `[virtual, inherited]`

| Frees internal texture resources for this texture.

virtual void Ogre::Texture::freeInternalResourcesImpl | ( | void |  | ) | `[protected, pure virtual, inherited]`

| Implementation of freeing internal texture resources. Implemented in Ogre::D3DTexture, Ogre::D3D9Texture, and Ogre::GLTexture.

virtual float Ogre::RenderTarget::getAverageFPS | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getBestFPS | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getBestFrameTime | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the best frame time.

virtual HardwarePixelBufferSharedPtr Ogre::Texture::getBuffer | ( | size_t | face = 0,
|  | size_t | mipmap = 0
| ) | `[pure virtual, inherited]`

Return hardware pixel buffer for a surface.

This buffer can then be used to copy data from and to a particular level of the texture.

Parameters:

  face | Face number, in case of a cubemap texture. Must be 0 for other types of textures.
  mipmap | Mipmap level. This goes from 0 for the first, largest mipmap level to getNumMipmaps()-1 for the smallest.

Returns:
  A shared pointer to a hardware pixel buffer

Remarks:
  The buffer is invalidated when the resource is unloaded or destroyed. Do not use it after the lifetime of the containing texture.

Implemented in Ogre::D3DTexture, Ogre::D3D9Texture, and Ogre::GLTexture.

virtual unsigned int Ogre::RenderTarget::getColourDepth | ( | void |  | ) | const`[virtual, inherited]`

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) | `[inherited]`

| Gets the manager which created this resource. Definition at line 205 of file OgreResource.h.

virtual void Ogre::RenderTarget::getCustomAttribute | ( | const String & | name,
|  | void * | pData
| ) | `[virtual, inherited]`

Gets a custom (maybe platform-specific) attribute.

Remarks:
  This is a nasty way of satisfying any API's need to see platform-specific details. It horrid, but D3D needs this kind of info. At least it's abstracted.

Parameters:

  name | The name of the attribute.
  pData | Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D7RenderWindow, Ogre::D3D7RenderTexture, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GLXWindow, Ogre::GTKWindow, and Ogre::Win32Window.

const String& Ogre::RenderTarget::getDebugText | ( |  | ) | const`[inherited]`

| Returns the debug text.

virtual unsigned int Ogre::Texture::getDepth | ( | void |  | ) | const`[virtual, inherited]`

| Returns the depth of the texture (only applicable for 3D textures). Definition at line 140 of file OgreTexture.h.

virtual PixelFormat Ogre::Texture::getFormat | ( |  | ) | const`[virtual, inherited]`

| Returns the pixel format for the texture surface. Definition at line 218 of file OgreTexture.h. References Ogre::PixelFormat.

virtual float Ogre::Texture::getGamma | ( | void |  | ) | const`[virtual, inherited]`

| Returns the gamma adjustment factor applied to this texture. Definition at line 122 of file OgreTexture.h.

const String& Ogre::Resource::getGroup | ( | void |  | ) | `[inherited]`

| Gets the group which this resource is a member of. Definition at line 202 of file OgreResource.h. References Ogre::String.

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle.

virtual unsigned int Ogre::RenderTarget::getHeight | ( | void |  | ) | const`[virtual, inherited]`

virtual unsigned int Ogre::Texture::getHeight | ( | void |  | ) | const`[virtual, inherited]`

| Returns the height of the texture. Definition at line 132 of file OgreTexture.h.

virtual float Ogre::RenderTarget::getLastFPS | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.

virtual void Ogre::RenderTarget::getMetrics | ( | unsigned int & | width,
|  | unsigned int & | height,
|  | unsigned int & | colourDepth
| ) | `[virtual, inherited]`

| Retrieve information about the render target.

virtual bool Ogre::Texture::getMipmapsHardwareGenerated | ( | void |  | ) | const`[virtual, inherited]`

Are mipmaps hardware generated?

Remarks:
  Will only be accurate after texture load, or createInternalResources

Definition at line 118 of file OgreTexture.h.

virtual const String& Ogre::RenderTarget::getName | ( | void |  | ) | const`[virtual, inherited]`

| Retrieve target's name.

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

| Gets resource name. Definition at line 183 of file OgreResource.h. References Ogre::String.

virtual size_t Ogre::Texture::getNumFaces | ( |  | ) | const`[virtual, inherited]`

| Return the number of faces this texture has. This will be 6 for a cubemap texture and 1 for a 1D, 2D or 3D one.

virtual size_t Ogre::Texture::getNumMipmaps | ( | void |  | ) | const`[virtual, inherited]`

| Gets the number of mipmaps to be used for this texture. Definition at line 106 of file OgreTexture.h.

virtual unsigned short Ogre::RenderTarget::getNumViewports | ( | void |  | ) | const`[virtual, inherited]`

| Returns the number of viewports attached to this target.

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const`[inherited]`

Get the origin of this resource, e.g.

a script file name.

Remarks:
  This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 212 of file OgreResource.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | `[inherited]`

Retrieves the parameter dictionary for this class.

Remarks:
  Only valid to call this after createParamDictionary.

Returns:
  Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const`[virtual, inherited]`

Generic parameter retrieval method.

Remarks:
  Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

  name | The name of the parameter to get

Returns:
  String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

const ParameterList& Ogre::StringInterface::getParameters | ( | void |  | ) | const`[inherited]`

Retrieves a list of parameters valid for this object.

Returns:
  A reference to a static list of ParameterDef objects.

virtual uchar Ogre::RenderTarget::getPriority | ( |  | ) | const`[virtual, inherited]`

| Gets the priority of a render target. Definition at line 239 of file OgreRenderTarget.h. References Ogre::uchar.

size_t Ogre::Resource::getSize | ( | void |  | ) | const`[inherited]`

| Retrieves info about the size of the resource. Definition at line 172 of file OgreResource.h.

virtual unsigned int Ogre::Texture::getSrcDepth | ( | void |  | ) | const`[virtual, inherited]`

| Returns the original depth of the input texture (only applicable for 3D textures). Definition at line 152 of file OgreTexture.h.

virtual unsigned int Ogre::Texture::getSrcHeight | ( | void |  | ) | const`[virtual, inherited]`

| Returns the height of the original input texture (may differ due to hardware requirements). Definition at line 144 of file OgreTexture.h.

virtual unsigned int Ogre::Texture::getSrcWidth | ( | void |  | ) | const`[virtual, inherited]`

| Returns the width of the original input texture (may differ due to hardware requirements). Definition at line 148 of file OgreTexture.h.

virtual const FrameStats& Ogre::RenderTarget::getStatistics | ( | void |  | ) | const`[virtual, inherited]`

virtual void Ogre::RenderTarget::getStatistics | ( | float & | lastFPS,
|  | float & | avgFPS,
|  | float & | bestFPS,
|  | float & | worstFPS
| ) | const`[virtual, inherited]`

Retieves details of current rendering performance.

Remarks:
  If the user application wishes to do it's own performance display, or use performance for some other means, this method allows it to retrieve the statistics.

Parameters:

  lastFPS | Pointer to a float to receive the number of frames per second (FPS) based on the last frame rendered.
  avgFPS | Pointer to a float to receive the FPS rating based on an average of all the frames rendered since rendering began (the call to Root::startRendering).
  bestFPS | Pointer to a float to receive the best FPS rating that has been achieved since rendering began.
  worstFPS | Pointer to a float to receive the worst FPS rating seen so far.

virtual TextureType Ogre::Texture::getTextureType | ( | void |  | ) | const`[virtual, inherited]`

| Gets the type of texture. Definition at line 102 of file OgreTexture.h. References Ogre::TextureType.

virtual size_t Ogre::RenderTarget::getTriangleCount | ( | void |  | ) | const`[virtual, inherited]`

| Gets the number of triangles rendered in the last update() call.

virtual int Ogre::Texture::getUsage | ( | void |  | ) | const`[virtual, inherited]`

| Returns the TextureUsage indentifier for this Texture. Definition at line 169 of file OgreTexture.h.

virtual Viewport* Ogre::RenderTarget::getViewport | ( | unsigned short | index | ) | `[virtual, inherited]`

| Retrieves a pointer to the viewport with the given index.

virtual unsigned int Ogre::RenderTarget::getWidth | ( | void |  | ) | const`[virtual, inherited]`

virtual unsigned int Ogre::Texture::getWidth | ( | void |  | ) | const`[virtual, inherited]`

| Returns the width of the texture. Definition at line 136 of file OgreTexture.h.

virtual float Ogre::RenderTarget::getWorstFPS | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getWorstFrameTime | ( |  | ) | const`[virtual, inherited]`

| Individual stats access - gets the worst frame time.

virtual bool Ogre::Texture::hasAlpha | ( | void |  | ) | const`[virtual, inherited]`

| Returns true if the texture has an alpha layer. Definition at line 227 of file OgreTexture.h.

virtual bool Ogre::RenderTarget::isActive | ( |  | ) | const`[virtual, inherited]`

| Used to retrieve or set the active state of the render target. Reimplemented in Ogre::RenderWindow, Ogre::D3D7RenderWindow, Ogre::GLXWindow, Ogre::GTKWindow, and Ogre::SDLWindow.

virtual bool Ogre::RenderTarget::isAutoUpdated | ( | void |  | ) | const`[virtual, inherited]`

| Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const`[inherited]`

| Is this resource manually loaded? Definition at line 160 of file OgreResource.h.

virtual bool Ogre::RenderTarget::isPrimary | ( | void |  | ) | const`[virtual, inherited]`

| Indicates whether this target is the primary window. The primary window is special in that it is destroyed when ogre is shut down, and cannot be destroyed directly. This is the case because it holds the context for vertex, index buffers and textures. Reimplemented in Ogre::RenderWindow.

bool Ogre::Resource::isReloadable | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource is reloadable, false otherwise. Definition at line 153 of file OgreResource.h.

virtual bool Ogre::RenderTargetTexture::isRenderTarget | ( |  | ) | const`[virtual]`

| Definition at line 14 of file OgreRenderTargetTexture.h.

virtual void Ogre::Resource::load | ( | void |  | ) | `[virtual, inherited]`

Loads the resource, if it is not already.

Remarks:
  If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own

Reimplemented in Ogre::Mesh, and Ogre::GLSLGpuProgram.

virtual void Ogre::Texture::loadImage | ( | const Image & | img | ) | `[pure virtual, inherited]`

| Loads the data from an image. Implemented in Ogre::D3DTexture, Ogre::D3D9Texture, and Ogre::GLTexture.

virtual void Ogre::Resource::loadImpl | ( | void |  | ) | `[protected, pure virtual, inherited]`

| Internal implementation of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. Implemented in Ogre::Font, Ogre::GpuProgram, Ogre::HighLevelGpuProgram, Ogre::Material, Ogre::Mesh, Ogre::PatchMesh, Ogre::Skeleton, Ogre::SkeletonInstance, Ogre::BspLevel, Ogre::D3DTexture, Ogre::D3D9GpuProgram, Ogre::D3D9Texture, and Ogre::GLTexture.

virtual void Ogre::Texture::loadRawData | ( | DataStreamPtr & | stream,
|  | ushort | uWidth,
|  | ushort | uHeight,
|  | PixelFormat | eFormat
| ) | `[virtual, inherited]`

| Loads the data from a raw stream.

virtual void Ogre::Resource::reload | ( | void |  | ) | `[virtual, inherited]`

Reloads the resource, if it is already loaded.

Remarks:
  Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

virtual void Ogre::RenderTarget::removeAllListeners | ( | void |  | ) | `[virtual, inherited]`

| Removes all listeners from this instance.

virtual void Ogre::RenderTarget::removeAllViewports | ( | void |  | ) | `[virtual, inherited]`

| Removes all viewports on this target.

virtual void Ogre::RenderTarget::removeListener | ( | RenderTargetListener * | listener | ) | `[virtual, inherited]`

| Removes a RenderTargetListener previously registered using addListener.

virtual void Ogre::RenderTarget::removeViewport | ( | int | ZOrder | ) | `[virtual, inherited]`

| Removes a viewport at a given ZOrder.

virtual bool Ogre::RenderTarget::requiresTextureFlipping | ( |  | ) | const`[pure virtual, inherited]`

| Implemented in Ogre::D3D7RenderWindow, Ogre::D3D7RenderTexture, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GLXWindow, Ogre::GTKWindow, Ogre::GLRenderTexture, Ogre::SDLWindow, and Ogre::Win32Window.

virtual void Ogre::RenderTarget::resetStatistics | ( | void |  | ) | `[virtual, inherited]`

| Resets saved frame-rate statistices.

virtual void Ogre::RenderTarget::setActive | ( | bool | state | ) | `[virtual, inherited]`

| Used to set the active state of the render target.

virtual void Ogre::RenderTarget::setAutoUpdated | ( | bool | autoupdate | ) | `[virtual, inherited]`

Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

Remarks:
  By default, if you use Ogre's own rendering loop (Root::startRendering) or call Root::_updateAllRenderTargets, all render targets are updated automatically. This method allows you to control that behaviour, if for example you have a render target which you only want to update periodically.

Parameters:

  autoupdate | If true, the render target is updated during the automatic render loop or when Root::_updateAllRenderTargets is called. If false, the target is only updated when its update() method is called explicitly.

virtual void Ogre::RenderTarget::setDebugText | ( | const String & | text | ) | `[virtual, inherited]`

| Adds debug text to this window.

virtual void Ogre::Texture::setDepth | ( | unsigned int | d | ) | `[virtual, inherited]`

| Set the depth of the texture (only applicable for 3D textures); ; can only do this before load();. Definition at line 165 of file OgreTexture.h.

virtual void Ogre::Texture::setFormat | ( | PixelFormat | pf | ) | `[virtual, inherited]`

| Sets the pixel format for the texture surface; can only be set before load().

virtual void Ogre::Texture::setGamma | ( | float | g | ) | `[virtual, inherited]`

Sets the gamma adjustment factor applied to this texture.

Note:
  Must be called before any 'load' method.

Definition at line 128 of file OgreTexture.h.

virtual void Ogre::Texture::setHeight | ( | unsigned int | h | ) | `[virtual, inherited]`

| Set the height of the texture; can only do this before load();. Definition at line 156 of file OgreTexture.h.

virtual void Ogre::Texture::setNumMipmaps | ( | size_t | num | ) | `[virtual, inherited]`

Sets the number of mipmaps to be used for this texture.

Note:
  Must be set before calling any 'load' method.

Definition at line 112 of file OgreTexture.h.

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) | `[virtual, inherited]`

Generic parameter setting method.

Remarks:
  Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  name | The name of the parameter to set
  value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns:
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | `[virtual, inherited]`

Generic multiple parameter setting method.

Remarks:
  Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  paramList | Name/value pair list

virtual void Ogre::RenderTarget::setPriority | ( | uchar | priority | ) | `[virtual, inherited]`

Sets the priority of this render target in relation to the others.

Remarks:
  This can be used in order to schedule render target updates. Lower priorities will be rendered first. Note that the priority must be set at the time the render target is attached to the render system, changes afterwards will not affect the ordering.

Definition at line 237 of file OgreRenderTarget.h.

References Ogre::uchar.

virtual void Ogre::Texture::setTextureType | ( | TextureType | ttype | ) | `[virtual, inherited]`

| Sets the type of texture; can only be changed before load(). Definition at line 98 of file OgreTexture.h.

virtual void Ogre::Texture::setUsage | ( | int | u | ) | `[virtual, inherited]`

Sets the TextureUsage indentifier for this Texture; only useful before load().

Parameters:

  u | is a combination of TU_STATIC, TU_DYNAMIC, TU_WRITE_ONLY TU_AUTOMIPMAP and TU_RENDERTARGET (see TextureUsage enum). You are strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to update regularly, consider HBU_DYNAMIC_WRITE_ONLY.

Definition at line 181 of file OgreTexture.h.

virtual void Ogre::Texture::setWidth | ( | unsigned int | w | ) | `[virtual, inherited]`

| Set the width of the texture; can only do this before load();. Definition at line 160 of file OgreTexture.h.

virtual void Ogre::Resource::touch | ( | void |  | ) | `[virtual, inherited]`

| 'Touches' the resource to indicate it has been used. Reimplemented in Ogre::Material.

virtual void Ogre::Resource::unload | ( | void |  | ) | `[virtual, inherited]`

| Unloads the resource; this is not permanent, the resource can be reloaded later if required. Reimplemented in Ogre::GLSLGpuProgram.

void Ogre::Texture::unloadImpl | ( | void |  | ) | `[protected, virtual, inherited]`

| Default implementation of unload which calls freeInternalResources. Implements Ogre::Resource.

virtual void Ogre::RenderTarget::update | ( | void |  | ) | `[virtual, inherited]`

Tells the target to update it's contents.

Remarks:
  If OGRE is not running in an automatic rendering loop (started using Root::startRendering), the user of the library is responsible for asking each render target to refresh. This is the method used to do this. It automatically re-renders the contents of the target using whatever cameras have been pointed at it (using Camera::setRenderTarget).

  This allows OGRE to be used in multi-windowed utilities and for contents to be refreshed only when required, rather than constantly as with the automatic rendering loop.

Reimplemented in Ogre::RenderWindow, and Ogre::D3D9RenderWindow.

void Ogre::RenderTarget::updateStats | ( | void |  | ) | `[protected, inherited]`

virtual void Ogre::RenderTarget::writeContentsToFile | ( | const String & | filename | ) | `[pure virtual, inherited]`

| Writes the current contents of the render target to the named file. Implemented in Ogre::D3D7RenderWindow, Ogre::D3D7RenderTexture, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GLXWindow, Ogre::GTKWindow, Ogre::GLRenderTexture, Ogre::SDLWindow, and Ogre::Win32Window.

virtual String Ogre::RenderTarget::writeContentsToTimestampedFile | ( | const String & | filenamePrefix,
|  | const String & | filenameSuffix
| ) | `[virtual, inherited]`

Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.

Returns:
  the name of the file used.

## Member Data Documentation

bool Ogre::RenderTarget::mActive `[protected, inherited]`

| Reimplemented in Ogre::D3D7RenderWindow, and Ogre::SDLWindow. Definition at line 310 of file OgreRenderTarget.h.

bool Ogre::RenderTarget::mAutoUpdate `[protected, inherited]`

| Definition at line 311 of file OgreRenderTarget.h.

unsigned int Ogre::RenderTarget::mColourDepth `[protected, inherited]`

| Definition at line 298 of file OgreRenderTarget.h.

ResourceManager* Ogre::Resource::mCreator `[protected, inherited]`

| Creator. Definition at line 73 of file OgreResource.h.

String Ogre::RenderTarget::mDebugText `[protected, inherited]`

| Definition at line 305 of file OgreRenderTarget.h.

unsigned long Ogre::Texture::mDepth `[protected, inherited]`

| Definition at line 252 of file OgreTexture.h.

unsigned short Ogre::Texture::mFinalBpp `[protected, inherited]`

| Definition at line 265 of file OgreTexture.h.

PixelFormat Ogre::Texture::mFormat `[protected, inherited]`

| Definition at line 260 of file OgreTexture.h.

size_t Ogre::RenderTarget::mFrameCount `[protected, inherited]`

| Definition at line 308 of file OgreRenderTarget.h.

float Ogre::Texture::mGamma `[protected, inherited]`

| Definition at line 257 of file OgreTexture.h.

String Ogre::Resource::mGroup `[protected, inherited]`

| The name of the resource group. Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle `[protected, inherited]`

| Numeric handle for more efficient look up than name. Definition at line 79 of file OgreResource.h.

bool Ogre::Texture::mHasAlpha `[protected, inherited]`

| Definition at line 266 of file OgreTexture.h.

unsigned int Ogre::RenderTarget::mHeight `[protected, inherited]`

| Definition at line 297 of file OgreRenderTarget.h.

unsigned long Ogre::Texture::mHeight `[protected, inherited]`

| Definition at line 250 of file OgreTexture.h.

bool Ogre::Texture::mInternalResourcesCreated `[protected, inherited]`

| Definition at line 268 of file OgreTexture.h.

bool Ogre::RenderTarget::mIsDepthBuffered `[protected, inherited]`

| Definition at line 299 of file OgreRenderTarget.h.

bool Ogre::Resource::mIsLoaded `[protected, inherited]`

| Is the resource currently loaded? Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual `[protected, inherited]`

| Is this file manually loaded? Definition at line 85 of file OgreResource.h.

unsigned long Ogre::RenderTarget::mLastSecond `[protected, inherited]`

| Definition at line 306 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastTime `[protected, inherited]`

| Definition at line 307 of file OgreRenderTarget.h.

RenderTargetListenerList Ogre::RenderTarget::mListeners `[protected, inherited]`

| Definition at line 320 of file OgreRenderTarget.h.

ManualResourceLoader* Ogre::Resource::mLoader `[protected, inherited]`

| Optional manual loader; if provided, data is loaded from here instead of a file. Definition at line 89 of file OgreResource.h.

bool Ogre::Texture::mMipmapsHardwareGenerated `[protected, inherited]`

| Definition at line 256 of file OgreTexture.h.

String Ogre::RenderTarget::mName `[protected, inherited]`

| The name of this target. Definition at line 292 of file OgreRenderTarget.h.

String Ogre::Resource::mName `[protected, inherited]`

| Unique name of the resource. Definition at line 75 of file OgreResource.h.

size_t Ogre::Texture::mNumMipmaps `[protected, inherited]`

| Definition at line 255 of file OgreTexture.h.

size_t Ogre::Texture::mNumRequestedMipmaps `[protected, inherited]`

| Definition at line 254 of file OgreTexture.h.

String Ogre::Resource::mOrigin `[protected, inherited]`

| Origin of this resource (e.g. script name) - optional. Definition at line 87 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName `[protected, inherited]`

| Class name for this instance to be used as a lookup (must be initialised by subclasses). Definition at line 160 of file OgreStringInterface.h.

uchar Ogre::RenderTarget::mPriority `[protected, inherited]`

| The priority of the render target. Definition at line 294 of file OgreRenderTarget.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary `[static, protected, inherited]`

| Dictionary of parameters. Definition at line 157 of file OgreStringInterface.h.

size_t Ogre::Resource::mSize `[protected, inherited]`

| The size of the resource in bytes. Definition at line 83 of file OgreResource.h.

unsigned short Ogre::Texture::mSrcBpp `[protected, inherited]`

| Definition at line 263 of file OgreTexture.h.

unsigned long Ogre::Texture::mSrcDepth `[protected, inherited]`

| Definition at line 264 of file OgreTexture.h.

unsigned long Ogre::Texture::mSrcHeight `[protected, inherited]`

| Definition at line 264 of file OgreTexture.h.

unsigned long Ogre::Texture::mSrcWidth `[protected, inherited]`

| Definition at line 264 of file OgreTexture.h.

FrameStats Ogre::RenderTarget::mStats `[protected, inherited]`

| Definition at line 302 of file OgreRenderTarget.h.

TextureType Ogre::Texture::mTextureType `[protected, inherited]`

| Definition at line 259 of file OgreTexture.h.

Timer* Ogre::RenderTarget::mTimer `[protected, inherited]`

| Definition at line 304 of file OgreRenderTarget.h.

int Ogre::Texture::mUsage `[protected, inherited]`

| Definition at line 261 of file OgreTexture.h.

ViewportList Ogre::RenderTarget::mViewportList `[protected, inherited]`

| List of viewports, map on Z-order. Definition at line 317 of file OgreRenderTarget.h.

unsigned int Ogre::RenderTarget::mWidth `[protected, inherited]`

| Definition at line 296 of file OgreRenderTarget.h.

unsigned long Ogre::Texture::mWidth `[protected, inherited]`

| Definition at line 251 of file OgreTexture.h.

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

- OgreRenderTargetTexture.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:02:39 2006