RenderWindow Class Reference

Represents a on-screen render-window to which cameras can render images. More...

#include <RenderTarget.hh>

Public Member Functions
virtual	~RenderWindow ()
	Destructor.
virtual double	DevicePixelRatio () const =0
	Get the device to pixel ratio.
virtual std::string	Handle () const =0
	Get the window handle that the render window is attached to.
virtual void	OnMove ()=0
	Alert the window of a window move event.
virtual void	OnResize (unsigned int _width, unsigned int _height)=0
	Alert the window of a window resize event.
virtual void	SetDevicePixelRatio (const double _ratio)=0
	Set the device to pixel ratio.
virtual void	SetHandle (const std::string &_handle)=0
	Set the window handle to attach the render window to.
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 on-screen render-window to which cameras can render images.

Constructor & Destructor Documentation

~RenderWindow()

virtual ~RenderWindow ( )

virtual

Destructor.

Member Function Documentation

DevicePixelRatio()

virtual double DevicePixelRatio ( ) const

pure virtual

Get the device to pixel ratio.

Returns

Device to pixel ratio

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

Handle()

virtual std::string Handle ( ) const

pure virtual

Get the window handle that the render window is attached to.

Returns

Window handle

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

OnMove()

virtual void OnMove ( )

pure virtual

Alert the window of a window move event.

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

OnResize()

virtual void OnResize ( unsigned int  _width, unsigned int  _height  )

pure virtual

Alert the window of a window resize event.

Parameters

[in]	_width	New window width in pixels
[in]	_height	New window height in pixels

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

SetDevicePixelRatio()

virtual void SetDevicePixelRatio ( const double  _ratio )

pure virtual

Set the device to pixel ratio.

Parameters

[in]

_ratio

Device to pixel ratio

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

SetHandle()

virtual void SetHandle ( const std::string &  _handle )

pure virtual

Set the window handle to attach the render window to.

Parameters

[in]

_handle

Window handle

Implemented in BaseRenderWindow< T >, BaseRenderWindow< Ogre2RenderTarget >, and BaseRenderWindow< OgreRenderTarget >.

---

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

• RenderTarget.hh