Ignition Rendering

API Reference

6.3.1
RenderTarget Class Referenceabstract

Represents a render-target to which cameras can render images. More...

#include <ignition/rendering/RenderTarget.hh>

Public Member Functions

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 render-target to which cameras can render images.

Constructor & Destructor Documentation

◆ ~RenderTarget()

Member Function Documentation

◆ AddRenderPass()

virtual void AddRenderPass ( const RenderPassPtr _pass)
pure virtual

Add a render pass to the render target.

Parameters
[in]_passNew render pass to add

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ BackgroundColor()

virtual math::Color BackgroundColor ( ) const
pure virtual

Get the background color of the render target. This should be the same as the scene background color.

Returns
Render target background color.

Implemented in BaseRenderTarget< T >, BaseRenderTarget< OgreObject >, and OgreRenderTarget.

Referenced by RenderTarget::~RenderTarget().

◆ Copy()

virtual void Copy ( Image _image) const
pure virtual

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.

Parameters
[out]_imageImage to which output will be written

Implemented in OgreRenderTarget.

Referenced by RenderTarget::~RenderTarget().

◆ Format()

virtual PixelFormat Format ( ) const
pure virtual

Set the render target image format.

Returns
Render target format

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ Height()

virtual unsigned int Height ( ) const
pure virtual

Get render target height in pixels.

Returns
The Render target height in pixels

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ RemoveRenderPass()

virtual void RemoveRenderPass ( const RenderPassPtr _pass)
pure virtual

Remove a render pass from the render target.

Parameters
[in]_passrender pass to remove

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ RenderPassByIndex()

virtual RenderPassPtr RenderPassByIndex ( unsigned int  _index) const
pure virtual

Get a render pass by index.

Returns
Render pass at the specified index

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ RenderPassCount()

virtual unsigned int RenderPassCount ( ) const
pure virtual

Get the number of render passes applied to the render target.

Returns
Number of render passes applied

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ SetFormat()

virtual void SetFormat ( PixelFormat  _format)
pure virtual

Set the render target image format.

Parameters
[in]_formatNew target format

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ SetHeight()

virtual void SetHeight ( const unsigned int  _height)
pure virtual

Set the render target height in pixels.

Parameters
[in]_heightNew render target height in pixels

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ SetWidth()

virtual void SetWidth ( const unsigned int  _width)
pure virtual

Set the render target width in pixels.

Parameters
[in]_widthNew render target width in pixels

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().

◆ Width()

virtual unsigned int Width ( ) const
pure virtual

Get render target width in pixels.

Returns
The render target width in pixels

Implemented in BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.

Referenced by RenderTarget::~RenderTarget().


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