#include <OgreRenderTarget.hh>

Public Member Functions
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::Camera *	Camera () 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	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object 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 RenderTarget
virtual	~RenderTarget ()
	Deconstructor. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. 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 >
T	enable_shared_from_this (T... args)

T	~enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

Protected Member Functions
	OgreRenderTarget ()

virtual void	RebuildImpl ()

virtual void	RebuildTarget ()=0

virtual void	RebuildViewport ()

virtual Ogre::RenderTarget *	RenderTarget () const =0

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
unsigned int	antiAliasing = 4

bool	colorDirty = true

Ogre::ColourValue	ogreBackgroundColor

Ogre::Camera *	ogreCamera = nullptr

Ogre::Viewport *	ogreViewport = 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

◆ OgreRenderTarget()

OgreRenderTarget ( )

protected

◆ ~OgreRenderTarget()

virtual ~OgreRenderTarget ( )

virtual

Member Function Documentation

◆ AntiAliasing()

virtual unsigned int AntiAliasing ( ) const

virtual

◆ BackgroundColor()

virtual math::Color BackgroundColor ( ) const

virtual

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

Returns: Render target background color.

Reimplemented from BaseRenderTarget< OgreObject >.

◆ Camera()

virtual Ogre::Camera* Camera ( ) const

virtual

◆ Copy()

virtual void Copy ( Image & _image ) const

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] _image Image to which output will be written

Implements RenderTarget.

◆ Destroy()

virtual void Destroy ( )

pure virtual

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

Reimplemented from BaseObject.

Implemented in OgreRenderWindow, and OgreRenderTexture.

◆ PreRender()

virtual void PreRender ( )

virtual

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.

Reimplemented from BaseRenderTarget< OgreObject >.

◆ RebuildImpl()

virtual void RebuildImpl ( )

protectedvirtual

Implements BaseRenderTarget< OgreObject >.

◆ RebuildTarget()

virtual void RebuildTarget ( )

protectedpure virtual

Implemented in OgreRenderWindow, and OgreRenderTexture.

◆ RebuildViewport()

virtual void RebuildViewport ( )

protectedvirtual

◆ Render()

virtual void Render ( )

virtual

◆ RenderTarget()

virtual Ogre::RenderTarget* RenderTarget ( ) const

protectedpure virtual

Implemented in OgreRenderWindow, and OgreRenderTexture.

◆ SetAntiAliasing()

virtual void SetAntiAliasing ( unsigned int _aa )

virtual

◆ SetBackgroundColor()

virtual void SetBackgroundColor ( math::Color _color )

virtual

◆ SetCamera()

virtual void SetCamera ( Ogre::Camera * _camera )

virtual

◆ UpdateBackgroundColor()

virtual void UpdateBackgroundColor ( )

protectedvirtual

Member Data Documentation

◆ antiAliasing

unsigned int antiAliasing = 4

protected

◆ colorDirty

bool colorDirty = true

protected

◆ ogreBackgroundColor

Ogre::ColourValue ogreBackgroundColor

protected

◆ ogreCamera

Ogre::Camera* ogreCamera = nullptr

protected

◆ ogreViewport

Ogre::Viewport* ogreViewport = nullptr

protected

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

OgreRenderTarget.hh

Ignition Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ OgreRenderTarget()

◆ ~OgreRenderTarget()

Member Function Documentation

◆ AntiAliasing()

◆ BackgroundColor()

◆ Camera()

◆ Copy()

◆ Destroy()

◆ PreRender()

◆ RebuildImpl()

◆ RebuildTarget()

◆ RebuildViewport()

◆ Render()

◆ RenderTarget()

◆ SetAntiAliasing()

◆ SetBackgroundColor()

◆ SetCamera()

◆ UpdateBackgroundColor()

Member Data Documentation

◆ antiAliasing

◆ colorDirty

◆ ogreBackgroundColor

◆ ogreCamera

◆ ogreViewport