RenderTexture Class Referenceabstract
Represents a off-screen render-texture to which cameras can render images. More...
#include <RenderTarget.hh>
Public Member Functions | |
| virtual | ~RenderTexture () |
| Destructor. More... | |
| virtual unsigned int | GLId () const =0 |
| Returns the OpenGL texture Id. A valid Id is returned only. More... | |
| virtual void | MetalId (void *_textureIdPtr) const =0 |
| Gets the Metal texture id. A valid Id is obtained only if this is an Metal render texture. The pointer set by this function must be released to an id<MTLTexture> using CFBridgingRelease. More... | |
 Public Member Functions inherited from RenderTarget | |
| virtual | ~RenderTarget () |
| Destructor. More... | |
| virtual void | AddRenderPass (const RenderPassPtr &_pass)=0 |
| Add a render pass to the render target. More... | |
| virtual math::Color | BackgroundColor () const =0 |
| Get the background color of the render target. This should be the same as the scene background color. More... | |
| virtual void | Copy (Image &_image) const =0 |
| Write rendered image to given Image. The RenderTarget will convert the underlying image to the specified format listed in the given Image. However if the given image is not of the correct size no work will be done. Calling this function before an image has been rendered will result in undefined behavior. More... | |
| virtual PixelFormat | Format () const =0 |
| Set the render target image format. More... | |
| virtual unsigned int | Height () const =0 |
| Get render target height in pixels. More... | |
| virtual void | RemoveRenderPass (const RenderPassPtr &_pass)=0 |
| Remove a render pass from the render target. More... | |
| virtual RenderPassPtr | RenderPassByIndex (unsigned int _index) const =0 |
| Get a render pass by index. More... | |
| virtual unsigned int | RenderPassCount () const =0 |
| Get the number of render passes applied to the render target. More... | |
| virtual void | SetFormat (PixelFormat _format)=0 |
| Set the render target image format. More... | |
| virtual void | SetHeight (const unsigned int _height)=0 |
| Set the render target height in pixels. More... | |
| virtual void | SetWidth (const unsigned int _width)=0 |
| Set the render target width in pixels. More... | |
| virtual unsigned int | Width () const =0 |
| Get render target width in pixels. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. More... | |
| virtual void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More... | |
| virtual unsigned int | Id () const =0 |
| Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual std::string | Name () const =0 |
| Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual void | PostRender ()=0 |
| Post process this object and any of its children after rendering. More... | |
| virtual void | PreRender ()=0 |
| Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More... | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
Detailed Description
Represents a off-screen render-texture to which cameras can render images.
Constructor & Destructor Documentation
◆ ~RenderTexture()
|
virtual |
Destructor.
Member Function Documentation
◆ GLId()
|
pure virtual |
Returns the OpenGL texture Id. A valid Id is returned only.
Implemented in Ogre2RenderTexture, and BaseRenderTexture< T >.
◆ MetalId()
|
pure virtual |
Gets the Metal texture id. A valid Id is obtained only if this is an Metal render texture. The pointer set by this function must be released to an id<MTLTexture> using CFBridgingRelease.
- Parameters
-
[out] _textureIdPtr the address of a void* pointer.
Implemented in Ogre2RenderTexture, BaseRenderTexture< T >, BaseRenderTexture< OgreRenderTarget >, and BaseRenderTexture< Ogre2RenderTarget >.
The documentation for this class was generated from the following file: