 |
OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
|
OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
This class represents a RenderTarget that renders to a Texture. More...
#include <OgreRenderTexture.h>
Inheritance diagram for Ogre::RenderTexture:Public Member Functions | |
| RenderTexture (HardwarePixelBuffer *buffer, uint32 zoffset) | |
| virtual | ~RenderTexture () |
| void | copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO) override |
| Copies the current contents of the render target to a pixelbox. More... | |
| virtual void | copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0 |
| Copies the current contents of the render target to a pixelbox. More... | |
| void | copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
| PixelFormat | suggestPixelFormat () const override |
| Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory. More... | |
| Public Member Functions inherited from Ogre::RenderTarget | |
| RenderTarget () | |
| virtual | ~RenderTarget () |
| virtual void | _beginUpdate () |
| Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More... | |
| virtual void | _detachDepthBuffer () |
| Detaches DepthBuffer without notifying it from the detach. More... | |
| virtual void | _endUpdate () |
| Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More... | |
| virtual void | _notifyCameraRemoved (const Camera *cam) |
| Utility method to notify a render target that a camera has been removed, in case it was referring to it as a viewer. More... | |
| virtual void | _updateAutoUpdatedViewports (bool updateStatistics=true) |
| Method for manual management of rendering - renders only viewports that are auto updated. More... | |
| virtual void | _updateViewport (int zorder, bool updateStatistics=true) |
| Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More... | |
| virtual void | _updateViewport (Viewport *viewport, bool updateStatistics=true) |
| Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More... | |
| virtual void | addListener (RenderTargetListener *listener) |
| Add a listener to this RenderTarget which will be called back before & after rendering. More... | |
| 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. More... | |
| virtual bool | attachDepthBuffer (DepthBuffer *depthBuffer) |
| void | copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
| virtual void | detachDepthBuffer () |
| uint | getCustomAttribute (const String &name) |
| simplified API for bindings More... | |
| virtual void | getCustomAttribute (const String &name, void *pData) |
| Retrieve a platform or API-specific piece of information. More... | |
| DepthBuffer * | getDepthBuffer () const |
| uint16 | getDepthBufferPool () const |
| virtual uint | getFSAA () const |
| Indicates whether multisampling is performed on rendering and at what level. More... | |
| virtual const String & | getFSAAHint () const |
| RenderSystem specific FSAA option. See RenderSystem::_createRenderWindow for details. More... | |
| virtual uint32 | getHeight (void) const |
| void | getMetrics (unsigned int &width, unsigned int &height) |
| Retrieve information about the render target. More... | |
| virtual const String & | getName (void) const |
| Retrieve target's name. More... | |
| virtual unsigned short | getNumViewports (void) const |
| Returns the number of viewports attached to this target. More... | |
| virtual uchar | getPriority () const |
| Gets the priority of a render target. More... | |
| const FrameStats & | getStatistics (void) const |
| Retrieves details of current rendering performance. More... | |
| virtual Viewport * | getViewport (unsigned short index) |
| Retrieves a pointer to the viewport with the given index. More... | |
| virtual Viewport * | getViewportByZOrder (int ZOrder) |
| Retrieves a pointer to the viewport with the given Z-order. More... | |
| virtual uint32 | getWidth (void) const |
| virtual bool | hasViewportWithZOrder (int ZOrder) |
| Returns true if and only if a viewport exists at the given Z-order. More... | |
| virtual void | insertListener (RenderTargetListener *listener, const unsigned int pos=0) |
| same as addListener, but force the position in the vector, so we can control the call order More... | |
| virtual bool | isActive () const |
| Used to retrieve or set the active state of the render target. More... | |
| virtual bool | isAutoUpdated (void) const |
| Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More... | |
| virtual bool | isHardwareGammaEnabled () const |
| Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More... | |
| virtual bool | isPrimary (void) const |
| Indicates whether this target is the primary window. More... | |
| virtual bool | isStereoEnabled (void) const |
| Indicates whether stereo is currently enabled for this target. More... | |
| virtual void | removeAllListeners (void) |
| Removes all listeners from this instance. More... | |
| virtual void | removeAllViewports (void) |
| Removes all viewports on this target. More... | |
| virtual void | removeListener (RenderTargetListener *listener) |
| Removes a RenderTargetListener previously registered using addListener. More... | |
| virtual void | removeViewport (int ZOrder) |
| Removes a viewport at a given Z-order. More... | |
| virtual bool | requiresTextureFlipping () const =0 |
| void | resetStatistics (void) |
| Resets saved frame-rate statistices. More... | |
| virtual void | setActive (bool state) |
| Used to set the active state of the render target. More... | |
| virtual void | setAutoUpdated (bool autoupdate) |
| Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More... | |
| void | setDepthBufferPool (uint16 poolId) |
| Sets the pool ID this RenderTarget should query from. More... | |
| virtual void | setFSAA (uint fsaa, const String &fsaaHint) |
| Set the level of multisample AA to be used if hardware support it. More... | |
| virtual void | setPriority (uchar priority) |
| Sets the priority of this render target in relation to the others. More... | |
| virtual void | swapBuffers () |
| Swaps the frame buffers to display the next frame. More... | |
| virtual void | update (bool swapBuffers=true) |
| Tells the target to update it's contents. More... | |
| void | writeContentsToFile (const String &filename) |
| Writes the current contents of the render target to the named file. More... | |
| virtual String | writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix) |
| Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More... | |
Additional Inherited Members | |
| Public Types inherited from Ogre::RenderTarget | |
| enum | FrameBuffer { FB_FRONT , FB_BACK , FB_AUTO } |
This class represents a RenderTarget that renders to a Texture.
There is no 1 on 1 relation between Textures and RenderTextures, as there can be multiple RenderTargets rendering to different mipmaps, faces (for cubemaps) or slices (for 3D textures) of the same Texture.
| Ogre::RenderTexture::RenderTexture | ( | HardwarePixelBuffer * | buffer, |
| uint32 | zoffset | ||
| ) |
|
virtual |
|
overridevirtual |
Copies the current contents of the render target to a pixelbox.
Implements Ogre::RenderTarget.
|
overridevirtual |
Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory.
Reimplemented from Ogre::RenderTarget.
| virtual void Ogre::RenderTarget::copyContentsToMemory |
Copies the current contents of the render target to a pixelbox.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Sometimes the whole rect was used as a source, sometimes the rect with the size equal to the size of destination rect but located in the top left corner of the render target, sometimes the destination rect itself. Use the overload with explicitly specified source and destination boxes instead.
1.9.1