Render window representation. More...

Inheritance diagram for Castor3D::RenderWindow:

Collaboration diagram for Castor3D::RenderWindow:

Classes
class	BinaryParser
	RenderWindow loader. More...

class	TextLoader
	RenderTarget loader. More...

Public Member Functions
C3D_API	RenderWindow (Engine &p_engine, Castor::String const &p_name)
	Constructor. More...

C3D_API	~RenderWindow ()
	Destructor. More...

C3D_API bool	Initialise (Castor::Size const &p_size, WindowHandle const &p_handle)
	Sets the handle, initialises the window. More...

C3D_API void	Cleanup ()
	Cleans up the instance. More...

C3D_API void	Render (bool p_bForce)
	Renders one frame. More...

C3D_API void	Resize (int x, int y)
	Resizes the window. More...

C3D_API void	Resize (Castor::Size const &p_size)
	Resizes the window. More...

C3D_API void	SetCamera (CameraSPtr p_pCamera)
	Sets the camera. More...

C3D_API bool	IsMultisampling () const
	Retrieves the multisampling status. More...

C3D_API int32_t	GetSamplesCount () const
	Retrieves the samples count. More...

C3D_API void	UpdateFullScreen (bool val)
	Changes fullscreen status from contex. More...

C3D_API void	SetSamplesCount (int32_t val)
	Sets the samples count. More...

C3D_API SceneSPtr	GetScene () const
	Retrieves the Scene. More...

C3D_API CameraSPtr	GetCamera () const
	Retrieves the Camera. More...

C3D_API eVIEWPORT_TYPE	GetViewportType () const
	Retrieves the eVIEWPORT_TYPE. More...

C3D_API void	SetViewportType (eVIEWPORT_TYPE val)
	Sets the eVIEWPORT_TYPE. More...

C3D_API void	SetScene (SceneSPtr p_scene)
	Sets the Scene. More...

C3D_API Castor::Size	GetSize () const
	Retrieves the window dimensions. More...

C3D_API bool	IsUsingStereo () const
	Retrieves the stereo status. More...

C3D_API void	SetStereo (bool p_bStereo)
	Defines the stereo status. More...

C3D_API real	GetIntraOcularDistance () const
	Retrieves the intra ocular distance. More...

C3D_API void	SetIntraOcularDistance (real p_rIao)
	Defines the intra ocular distance. More...

C3D_API Castor::ePIXEL_FORMAT	GetPixelFormat () const
	Retrieves the window pixel format. More...

C3D_API void	SetPixelFormat (Castor::ePIXEL_FORMAT val)
	Sets the window pixel format. More...

uint32_t	GetIndex () const
	Retrieves the window index. More...

WindowHandle const &	GetHandle () const
	Retrieves the window handle. More...

bool	IsInitialised () const
	Retrieves the intialisation status. More...

FrameListenerSPtr	GetListener () const
	Retrieves the FrameListener. More...

ContextSPtr	GetContext () const
	Retrieves the Context. More...

RenderTargetSPtr	GetRenderTarget () const
	Retrieves the render target. More...

void	SetRenderTarget (RenderTargetSPtr p_pTarget)
	Sets the render target. More...

void	SetContext (ContextSPtr p_context)
	Sets the Context. More...

bool	GetVSync () const
	Tells the context is using vsync. More...

void	SetVSync (bool p_value)
	Defines the vsync usage. More...

bool	IsFullscreen () const
	Tells the rendering is fullscreen. More...

void	SetFullscreen (bool p_value)
	Defines the fullscreen rendering status. More...

BackBuffersSPtr	GetBackBuffers () const

void	SaveFrame ()
	Tells the next frame must be saved. More...

Castor::PxBufferBaseSPtr	GetSavedFrame () const

Detailed Description

Render window representation.

Author: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

Remarks: Manages a window where you can render a scene.

Constructor & Destructor Documentation

◆ RenderWindow()

C3D_API Castor3D::RenderWindow::RenderWindow	(	Engine &	p_engine,
		Castor::String const &	p_name
	)

Constructor.

Parameters

[in]	p_engine	The engine
[in]	p_name	The window name

◆ ~RenderWindow()

C3D_API Castor3D::RenderWindow::~RenderWindow ( )

Destructor.

Member Function Documentation

◆ Cleanup()

C3D_API void Castor3D::RenderWindow::Cleanup ( )

Cleans up the instance.

◆ GetBackBuffers()

BackBuffersSPtr Castor3D::RenderWindow::GetBackBuffers ( ) const

inline

Returns: The window's back buffers.

◆ GetCamera()

C3D_API CameraSPtr Castor3D::RenderWindow::GetCamera ( ) const

Retrieves the Camera.

Returns: The Camera

◆ GetContext()

ContextSPtr Castor3D::RenderWindow::GetContext ( ) const

inline

Retrieves the Context.

Returns: The Context

◆ GetHandle()

WindowHandle const& Castor3D::RenderWindow::GetHandle ( ) const

inline

Retrieves the window handle.

Returns: The window handle

◆ GetIndex()

uint32_t Castor3D::RenderWindow::GetIndex ( ) const

inline

Retrieves the window index.

Returns: The window index

◆ GetIntraOcularDistance()

C3D_API real Castor3D::RenderWindow::GetIntraOcularDistance ( ) const

Retrieves the intra ocular distance.

Returns: The intra ocular distance

◆ GetListener()

FrameListenerSPtr Castor3D::RenderWindow::GetListener ( ) const

inline

Retrieves the FrameListener.

Returns: The FrameListener

◆ GetPixelFormat()

C3D_API Castor::ePIXEL_FORMAT Castor3D::RenderWindow::GetPixelFormat ( ) const

Retrieves the window pixel format.

Returns: The window pixel format

◆ GetRenderTarget()

RenderTargetSPtr Castor3D::RenderWindow::GetRenderTarget ( ) const

inline

Retrieves the render target.

Returns: The value

◆ GetSamplesCount()

C3D_API int32_t Castor3D::RenderWindow::GetSamplesCount ( ) const

Retrieves the samples count.

Returns: The samples count

◆ GetSavedFrame()

Castor::PxBufferBaseSPtr Castor3D::RenderWindow::GetSavedFrame ( ) const

inline

Returns: The saved image.

◆ GetScene()

C3D_API SceneSPtr Castor3D::RenderWindow::GetScene ( ) const

Retrieves the Scene.

Returns: The Scene

◆ GetSize()

C3D_API Castor::Size Castor3D::RenderWindow::GetSize ( ) const

Retrieves the window dimensions.

Returns: The window dimensions

◆ GetViewportType()

C3D_API eVIEWPORT_TYPE Castor3D::RenderWindow::GetViewportType ( ) const

Retrieves the eVIEWPORT_TYPE.

Returns: The eVIEWPORT_TYPE

◆ GetVSync()

bool Castor3D::RenderWindow::GetVSync ( ) const

inline

Tells the context is using vsync.

◆ Initialise()

C3D_API bool Castor3D::RenderWindow::Initialise	(	Castor::Size const &	p_size,
		WindowHandle const &	p_handle
	)

Sets the handle, initialises the window.

Parameters

[in]	p_size	The window size.
[in]	p_handle	The handle.

Returns: false if any problem occured

◆ IsFullscreen()

bool Castor3D::RenderWindow::IsFullscreen ( ) const

inline

Tells the rendering is fullscreen.

◆ IsInitialised()

bool Castor3D::RenderWindow::IsInitialised ( ) const

inline

Retrieves the intialisation status.

Returns: The intialisation status

◆ IsMultisampling()

C3D_API bool Castor3D::RenderWindow::IsMultisampling ( ) const

Retrieves the multisampling status.

Returns: The multisampling status

◆ IsUsingStereo()

C3D_API bool Castor3D::RenderWindow::IsUsingStereo ( ) const

Retrieves the stereo status.

Returns: true if stereo is used

◆ Render()

C3D_API void Castor3D::RenderWindow::Render ( bool p_bForce )

Renders one frame.

Parameters

[in] p_bForce Forces the rendering

Renders one frame

Parameters

[in] p_bForce Dit si on force le rendu

◆ Resize() [1/2]

C3D_API void Castor3D::RenderWindow::Resize	(	int	x,
		int	y
	)

Resizes the window.

Parameters

[in] x,y The new size

◆ Resize() [2/2]

C3D_API void Castor3D::RenderWindow::Resize ( Castor::Size const & p_size )

Resizes the window.

Parameters

[in] p_size The new size

◆ SaveFrame()

void Castor3D::RenderWindow::SaveFrame ( )

inline

Tells the next frame must be saved.

◆ SetCamera()

C3D_API void Castor3D::RenderWindow::SetCamera ( CameraSPtr p_pCamera )

Sets the camera.

Parameters

[in] p_pCamera The camera

◆ SetContext()

void Castor3D::RenderWindow::SetContext ( ContextSPtr p_context )

inline

Sets the Context.

Parameters

[in] p_context The new Context

◆ SetFullscreen()

void Castor3D::RenderWindow::SetFullscreen ( bool p_value )

inline

Defines the fullscreen rendering status.

Parameters

[in] p_value The status

◆ SetIntraOcularDistance()

C3D_API void Castor3D::RenderWindow::SetIntraOcularDistance ( real p_rIao )

Defines the intra ocular distance.

Parameters

[in] p_rIao The intra ocular distance

◆ SetPixelFormat()

C3D_API void Castor3D::RenderWindow::SetPixelFormat ( Castor::ePIXEL_FORMAT val )

Sets the window pixel format.

Parameters

[in] val The new window pixel format

◆ SetRenderTarget()

void Castor3D::RenderWindow::SetRenderTarget ( RenderTargetSPtr p_pTarget )

inline

Sets the render target.

Parameters

[in] p_pTarget The new value

◆ SetSamplesCount()

C3D_API void Castor3D::RenderWindow::SetSamplesCount ( int32_t val )

Sets the samples count.

Parameters

[in] val The new samples count

◆ SetScene()

C3D_API void Castor3D::RenderWindow::SetScene ( SceneSPtr p_scene )

Sets the Scene.

Parameters

[in] p_scene The new Scene

◆ SetStereo()

C3D_API void Castor3D::RenderWindow::SetStereo ( bool p_bStereo )

Defines the stereo status.

Parameters

[in] p_bStereo true if stereo is to be used

◆ SetViewportType()

C3D_API void Castor3D::RenderWindow::SetViewportType ( eVIEWPORT_TYPE val )

Sets the eVIEWPORT_TYPE.

Parameters

[in] val The new eVIEWPORT_TYPE

◆ SetVSync()

void Castor3D::RenderWindow::SetVSync ( bool p_value )

inline

Defines the vsync usage.

Parameters

[in] p_value The usage

◆ UpdateFullScreen()

C3D_API void Castor3D::RenderWindow::UpdateFullScreen ( bool val )

Changes fullscreen status from contex.

Parameters

[in] val The new fullscreen status

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/RenderWindow.hpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RenderWindow()

◆ ~RenderWindow()

Member Function Documentation

◆ Cleanup()

◆ GetBackBuffers()

◆ GetCamera()

◆ GetContext()

◆ GetHandle()

◆ GetIndex()

◆ GetIntraOcularDistance()

◆ GetListener()

◆ GetPixelFormat()

◆ GetRenderTarget()

◆ GetSamplesCount()

◆ GetSavedFrame()

◆ GetScene()

◆ GetSize()

◆ GetViewportType()

◆ GetVSync()

◆ Initialise()

◆ IsFullscreen()

◆ IsInitialised()

◆ IsMultisampling()

◆ IsUsingStereo()

◆ Render()

◆ Resize() [1/2]

◆ Resize() [2/2]

◆ SaveFrame()

◆ SetCamera()

◆ SetContext()

◆ SetFullscreen()

◆ SetIntraOcularDistance()

◆ SetPixelFormat()

◆ SetRenderTarget()

◆ SetSamplesCount()

◆ SetScene()

◆ SetStereo()

◆ SetViewportType()

◆ SetVSync()

◆ UpdateFullScreen()