Represents a off-screen render-texture to which cameras can render images. More...

#include <RenderTarget.hh>

Public Member Functions
virtual	~RenderTexture ()
	Destructor.

virtual unsigned int	GLId () const =0
	Returns the OpenGL texture Id. A valid Id is returned only.

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.

Public Member Functions inherited from RenderTarget
virtual	~RenderTarget ()
	Destructor.

virtual void	AddRenderPass (const RenderPassPtr &_pass)=0
	Add a render pass to the render target.

virtual math::Color	BackgroundColor () const =0
	Get the background color of the render target. This should be the same as the scene background color.

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.

virtual PixelFormat	Format () const =0
	Set the render target image format.

virtual unsigned int	Height () const =0
	Get render target height in pixels.

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.

virtual void	PreRender (const CameraPtr &_camera)=0
	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 =0
	See SetFormat()

virtual void	RemoveAllRenderPasses ()=0
	Remove all render passes from the render target.

virtual void	RemoveRenderPass (const RenderPassPtr &_pass)=0
	Remove a render pass from the render target.

virtual RenderPassPtr	RenderPassByIndex (unsigned int _index) const =0
	Get a render pass by index.

virtual unsigned int	RenderPassCount () const =0
	Get the number of render passes applied to the render target.

virtual void	SetFormat (PixelFormat _format, bool _reinterpretable=false)=0
	Set the render target image format.

virtual void	SetHeight (const unsigned int _height)=0
	Set the render target height in pixels.

virtual void	SetWidth (const unsigned int _width)=0
	Set the render target width in pixels.

virtual unsigned int	Width () const =0
	Get render target width in pixels.

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.

virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

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 void	PostRender ()=0
	Post process this object and any of its children after rendering.

virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Detailed Description

Represents a off-screen render-texture to which cameras can render images.

Constructor & Destructor Documentation

◆ ~RenderTexture()

virtual ~RenderTexture ( )

virtual

Destructor.

Member Function Documentation

◆ GLId()

virtual unsigned int GLId ( ) const

pure virtual

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

Implemented in BaseRenderTexture< T >, BaseRenderTexture< Ogre2RenderTarget >, BaseRenderTexture< OgreRenderTarget >, OgreRenderTexture, and Ogre2RenderTexture.

◆ MetalId()

virtual void MetalId ( void * _textureIdPtr ) const

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 BaseRenderTexture< T >, BaseRenderTexture< Ogre2RenderTarget >, BaseRenderTexture< OgreRenderTarget >, and Ogre2RenderTexture.

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

RenderTarget.hh

Gazebo Rendering