Ignition Rendering

API Reference

0.1.0

#include <OgreRenderTarget.hh>

Public Member Functions

virtual ~OgreRenderTexture ()
 
virtual void Destroy ()
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
- Public Member Functions inherited from BaseRenderTexture< OgreRenderTarget >
 BaseRenderTexture ()
 
virtual ~BaseRenderTexture ()
 
- Public Member Functions inherited from RenderTexture
virtual ~RenderTexture ()
 Deconstructor. More...
 
- Public Member Functions inherited from RenderTarget
virtual ~RenderTarget ()
 Deconstructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Deconstructor. More...
 
- Public Member Functions inherited from OgreRenderTarget
virtual ~OgreRenderTarget ()
 
virtual unsigned int AntiAliasing () const
 
virtual math::Color BackgroundColor () const
 Get the background color of the render target. This should be the same as the scene background color. More...
 
virtual Ogre::CameraCamera () const
 
virtual void Copy (Image &_image) const
 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 void PreRender ()
 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 void Render ()
 
virtual void SetAntiAliasing (unsigned int _aa)
 
virtual void SetBackgroundColor (math::Color _color)
 
virtual void SetCamera (Ogre::Camera *_camera)
 
- Public Member Functions inherited from BaseRenderTarget< OgreObject >
 BaseRenderTarget ()
 
virtual ~BaseRenderTarget ()
 
virtual PixelFormat Format () const
 Set the render target image format. More...
 
virtual unsigned int Height () const
 Get render target height in pixels. More...
 
virtual void SetFormat (PixelFormat _format)
 Set the render target image format. More...
 
virtual void SetHeight (const unsigned int _height)
 Set the render target height in pixels. More...
 
virtual void SetWidth (const unsigned int _width)
 Set the render target width in pixels. More...
 
virtual unsigned int Width () const
 Get render target width in pixels. More...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const
 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
 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...
 
- Public Member Functions inherited from enable_shared_from_this< BaseObject >
enable_shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 

Protected Member Functions

 OgreRenderTexture ()
 
virtual void BuildTarget ()
 
virtual void DestroyTarget ()
 
virtual void RebuildTarget ()
 
virtual Ogre::RenderTargetRenderTarget () const
 
- Protected Member Functions inherited from OgreRenderTarget
 OgreRenderTarget ()
 
virtual void RebuildImpl ()
 
virtual void RebuildViewport ()
 
virtual void UpdateBackgroundColor ()
 
- Protected Member Functions inherited from BaseRenderTarget< OgreObject >
virtual void Rebuild ()
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre::TextureogreTexture = nullptr
 
- Protected Attributes inherited from OgreRenderTarget
unsigned int antiAliasing = 4
 
bool colorDirty = true
 
Ogre::ColourValue ogreBackgroundColor
 
Ogre::CameraogreCamera = nullptr
 
Ogre::ViewportogreViewport = nullptr
 
- Protected Attributes inherited from BaseRenderTarget< OgreObject >
PixelFormat format
 
unsigned int height
 
bool targetDirty
 
unsigned int width
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Constructor & Destructor Documentation

◆ OgreRenderTexture()

OgreRenderTexture ( )
protected

◆ ~OgreRenderTexture()

virtual ~OgreRenderTexture ( )
virtual

Member Function Documentation

◆ BuildTarget()

virtual void BuildTarget ( )
protectedvirtual

◆ Destroy()

virtual void Destroy ( )
virtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements OgreRenderTarget.

◆ DestroyTarget()

virtual void DestroyTarget ( )
protectedvirtual

◆ RebuildTarget()

virtual void RebuildTarget ( )
protectedvirtual

Implements OgreRenderTarget.

◆ RenderTarget()

virtual Ogre::RenderTarget* RenderTarget ( ) const
protectedvirtual

Implements OgreRenderTarget.

Member Data Documentation

◆ ogreTexture

Ogre::Texture* ogreTexture = nullptr
protected

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