Ogre2RenderTexture Class Reference

Ogre2.x implementation of the render texture class. More...

#include <Ogre2RenderTarget.hh>

Public Member Functions
virtual	~Ogre2RenderTexture ()
	Destructor.
void	AddRenderPass (const RenderPassPtr &_pass) override
	Add a render pass to the render target.
virtual void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
virtual unsigned int	GLId () const override
	Returns the OpenGL texture Id. A valid Id is returned only.
virtual void	MetalId (void *_textureIdPtr) const override
	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.
virtual void	PostRender () override
	Post process this object and any of its children after rendering.
virtual void	PreRender () override
	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.
void	RemoveAllRenderPasses () override
	Remove all render passes from the render target.
void	RemoveRenderPass (const RenderPassPtr &_pass) override
	Remove a render pass from the render target.
virtual Ogre::TextureGpu *	RenderTarget () const override
	Get a pointer to the ogre render target containing the results of the render.
Public Member Functions inherited from BaseRenderTexture< Ogre2RenderTarget >
	BaseRenderTexture ()
virtual	~BaseRenderTexture ()
Public Member Functions inherited from RenderTexture
virtual	~RenderTexture ()
	Destructor.
Public Member Functions inherited from RenderTarget
virtual	~RenderTarget ()
	Destructor.
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.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
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.
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.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.
Public Member Functions inherited from Ogre2RenderTarget
virtual	~Ogre2RenderTarget ()
	Destructor.
virtual unsigned int	AntiAliasing () const
	Get the anti-aliasing level.
virtual math::Color	BackgroundColor () const override
	Get the background color of the render target. This should be the same as the scene background color.
virtual MaterialPtr	BackgroundMaterial () const
	Get the background material of this camera.
virtual Ogre::Camera *	Camera () const
	Get a pointer to the internal ogre camera.
virtual void	Copy (Image &_image) const override
	Copy the render target buffer data to an image.
unsigned int	GLIdImpl () const
virtual bool	IsRenderWindow () const
	Returns true if this is a render window.
void	MetalIdImpl (void *_textureIdPtr) const
void	PrepareForExternalSampling ()
	See Camera::PrepareForExternalSampling.
virtual void	Render ()
	Main render call.
virtual void	SetAntiAliasing (unsigned int _aa)
	set the anti-aliasing level
virtual void	SetBackgroundColor (math::Color _color)
	Set the background color of the render target.
virtual void	SetBackgroundMaterial (MaterialPtr _material)
	Set the background material of this camera.
virtual void	SetCamera (Ogre::Camera *_camera)
	Set the ogre camera to use for this render target.
void	SetMaterial (MaterialPtr _material)
	Set a material to render on every object. This method is used for special cases like the render target of a depth camera.
void	SetShadowsNodeDefDirty ()
virtual void	SetVisibilityMask (uint32_t _mask)
	Set visibility mask for the viewport associated with this render target.
virtual uint32_t	VisibilityMask () const
	Get visibility mask for the viewport associated with this render target.
Public Member Functions inherited from BaseRenderTarget< Ogre2Object >
	BaseRenderTarget ()
virtual	~BaseRenderTarget ()
virtual PixelFormat	Format () const override
	Set the render target image format.
virtual unsigned int	Height () const override
	Get render target height in pixels.
virtual void	PreRender (const CameraPtr &_camera) override
	See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render.
virtual bool	Reinterpretable () const override
	See SetFormat()
virtual RenderPassPtr	RenderPassByIndex (unsigned int _index) const override
	Get a render pass by index.
virtual unsigned int	RenderPassCount () const override
	Get the number of render passes applied to the render target.
virtual void	SetFormat (PixelFormat _format, bool _reinterpretable=false) override
	Set the render target image format.
virtual void	SetHeight (const unsigned int _height) override
	Set the render target height in pixels.
virtual void	SetWidth (const unsigned int _width) override
	Set the render target width in pixels.
virtual unsigned int	Width () const override
	Get render target width in pixels.
Public Member Functions inherited from Ogre2Object
virtual	~Ogre2Object ()
	Destructor.
virtual ScenePtr	Scene () const override
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override

Protected Member Functions
	Ogre2RenderTexture ()
	Constructor.
virtual void	BuildTarget ()
	Build the render texture.
virtual void	DestroyTarget ()
	Destroy the render texture.
virtual void	RebuildTarget () override
	Rebuild the render target.
Protected Member Functions inherited from Ogre2RenderTarget
	Ogre2RenderTarget ()
	Constructor.
virtual void	BuildCompositor ()
	Build the compositor.
void	BuildTargetImpl ()
	Build the render texture.
virtual void	DestroyCompositor ()
	Destroy the compositor.
void	DestroyTargetImpl ()
	Destroy the render texture.
virtual void	RebuildCompositor ()
	Rebuild the compositor.
virtual void	RebuildImpl () override
	Implementation of the Rebuild function.
void	RebuildMaterial ()
	Re-initializes render target material to apply a material to everything in the scene. Does nothing if no material has been set.
Ogre::TextureGpu *	RenderTargetImpl () const
	Get a pointer to the ogre render target containing the results of the render (implemented separately to avoid breaking ABI of the pure virtual function)
uint8_t	TargetFSAA () const
	Returns the FSAA to use based on supported specs by HW and value specified in Ogre2RenderTarget::AntiAliasing.
virtual void	UpdateBackgroundColor ()
	Update the background color.
virtual void	UpdateBackgroundMaterial ()
	Update the background material.
virtual void	UpdateRenderPassChain ()
	Update the render pass chain.
Protected Member Functions inherited from BaseRenderTarget< Ogre2Object >
virtual void	Rebuild ()
Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Init ()
virtual void	Load ()

Additional Inherited Members
Static Public Member Functions inherited from Ogre2RenderTarget
static uint8_t	TargetFSAA (uint8_t _fsaa)
	Returns the FSAA to use based on supported specs by HW and value specified in _fsaa.
static void	UpdateRenderPassChain (Ogre::CompositorWorkspace *_workspace, const std::string &_workspaceDefName, const std::string &_baseNode, const std::string &_finalNode, const std::vector< RenderPassPtr > &_renderPasses, bool _recreateNodes, Ogre::TextureGpu *(*_ogreTextures)[2], bool _isRenderWindow)
	Update the render pass chain.
Protected Attributes inherited from Ogre2RenderTarget
unsigned int	antiAliasing = 4
	Anti-aliasing level.
MaterialPtr	backgroundMaterial
	Background material of the render target.
bool	backgroundMaterialDirty = false
	Flag to indicate if the render target background material has changed.
bool	colorDirty = true
	Flag to indicate if the render target color has changed.
MaterialPtr	material
	a material used by for the render target
Ogre2RenderTargetMaterialPtr	materialApplicator
	Helper class that applies the material to the render target.
Ogre::ColourValue	ogreBackgroundColor
	Stores the background color of the render target.
Ogre::Camera *	ogreCamera = nullptr
	Pointer to the internal ogre camera.
Ogre::CompositorWorkspace *	ogreCompositorWorkspace = nullptr
	Ogre's compositor workspace - the main interface to render into a render target or render texture.
std::string	ogreCompositorWorkspaceDefName
	Ogre's compositor workspace definition name.
uint32_t	visibilityMask = GZ_VISIBILITY_ALL
	visibility mask associated with this render target
Protected Attributes inherited from BaseRenderTarget< Ogre2Object >
PixelFormat	format
unsigned int	height
bool	reinterpretable
bool	renderPassDirty
	Flag to indicate if render pass need to be rebuilt.
std::vector< RenderPassPtr >	renderPasses
	A chain of render passes applied to the render target.
bool	targetDirty
unsigned int	width
Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre2.x implementation of the render texture class.

Constructor & Destructor Documentation

Ogre2RenderTexture()

Ogre2RenderTexture ( )

protected

Constructor.

~Ogre2RenderTexture()

virtual ~Ogre2RenderTexture ( )

virtual

Destructor.

Member Function Documentation

AddRenderPass()

void AddRenderPass ( const RenderPassPtr &  _pass )

overridevirtual

Add a render pass to the render target.

Parameters

[in]

_pass

New render pass to add

Implements RenderTarget.

BuildTarget()

virtual void BuildTarget ( )

protectedvirtual

Build the render texture.

Destroy()

virtual void Destroy ( )

overridevirtual

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

Implements Object.

DestroyTarget()

virtual void DestroyTarget ( )

protectedvirtual

Destroy the render texture.

GLId()

virtual unsigned int GLId ( ) const

overridevirtual

Returns the OpenGL texture Id. A valid Id is returned only.

Reimplemented from BaseRenderTexture< Ogre2RenderTarget >.

MetalId()

virtual void MetalId ( void *  _textureIdPtr ) const

overridevirtual

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.

Reimplemented from BaseRenderTexture< Ogre2RenderTarget >.

PostRender()

virtual void PostRender ( )

overridevirtual

Post process this object and any of its children after rendering.

Implements Object.

PreRender()

virtual void PreRender ( )

overridevirtual

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.

Implements Object.

RebuildTarget()

virtual void RebuildTarget ( )

overrideprotectedvirtual

Rebuild the render target.

Implements Ogre2RenderTarget.

RemoveAllRenderPasses()

void RemoveAllRenderPasses ( )

overridevirtual

Remove all render passes from the render target.

Implements RenderTarget.

RemoveRenderPass()

void RemoveRenderPass ( const RenderPassPtr &  _pass )

overridevirtual

Remove a render pass from the render target.

Parameters

[in]

_pass

render pass to remove

Implements RenderTarget.

RenderTarget()

virtual Ogre::TextureGpu * RenderTarget ( ) const

overridevirtual

Get a pointer to the ogre render target containing the results of the render.

Implements Ogre2RenderTarget.

---

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

• Ogre2RenderTarget.hh