#include <BaseRenderTarget.hh>

Public Member Functions
	BaseRenderTarget ()

virtual	~BaseRenderTarget ()

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 PixelFormat	Format () const
	Set the render target image format. More...

virtual unsigned int	Height () const
	Get render target height in pixels. 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	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...

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...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. 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 ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Protected Member Functions
virtual void	Rebuild ()

virtual void	RebuildImpl ()=0

Protected Attributes
PixelFormat	format = PF_UNKNOWN

unsigned int	height = 0u

bool	targetDirty = true

unsigned int	width = 0u

Constructor & Destructor Documentation

◆ BaseRenderTarget()

BaseRenderTarget ( )

◆ ~BaseRenderTarget()

~BaseRenderTarget ( )

virtual

Member Function Documentation

◆ BackgroundColor()

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.

Implements RenderTarget.

Reimplemented in OgreRenderTarget.

◆ Format()

PixelFormat Format ( ) const

virtual

Set the render target image format.

Returns: Render target format

Implements RenderTarget.

◆ Height()

unsigned int Height ( ) const

virtual

Get render target height in pixels.

Returns: The Render target height in pixels

Implements RenderTarget.

◆ PreRender()

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.

Implements Object.

Reimplemented in OgreRenderTarget.