Implémentation d'une fenêtre de rendu. Plus de détails...

Graphe d'héritage de castor3d::RenderWindow:

Graphe de collaboration de castor3d::RenderWindow:

Classes
class	TextWriter

Fonctions membres publiques
C3D_API	RenderWindow (castor::String const &p_name, Engine &engine)
	Constructor. Plus de détails...

C3D_API	~RenderWindow ()
	Destructeur. Plus de détails...

C3D_API bool	initialise (castor::Size const &p_size, WindowHandle const &p_handle)
	Définit l'identifiant de la fenêtre, initialise la fenêtre. Plus de détails...

C3D_API void	cleanup ()
	Nettoie l'instance. Plus de détails...

C3D_API void	render (bool p_bForce)

C3D_API void	resize (int x, int y)
	Redimensionne la fenêtre. Plus de détails...

C3D_API void	resize (castor::Size const &p_size)
	Redimensionne la fenêtre. Plus de détails...

C3D_API void	setCamera (CameraSPtr p_pCamera)
	Définit la caméra. Plus de détails...

C3D_API void	updateFullScreen (bool val)
	Change le statut de plein écran à partir du contexte. Plus de détails...

C3D_API SceneSPtr	getScene () const
	Récupère la Scene. Plus de détails...

C3D_API CameraSPtr	getCamera () const
	Récupère la Camera. Plus de détails...

C3D_API ViewportType	getViewportType () const
	Récupère le ViewportType. Plus de détails...

C3D_API void	setViewportType (ViewportType val)
	Définit le ViewportType. Plus de détails...

C3D_API void	setScene (SceneSPtr p_scene)
	Définit la Scene. Plus de détails...

C3D_API castor::Size	getSize () const
	Récupère les dimensions de la fenêtre. Plus de détails...

C3D_API bool	isUsingStereo () const
	Récupère le statut d'utilisation stéréo. Plus de détails...

C3D_API void	setStereo (bool p_bStereo)
	Définit le statut d'utilisation stéréo. Plus de détails...

C3D_API real	getIntraOcularDistance () const
	Récupère la distance inter oculaire. Plus de détails...

C3D_API void	setIntraOcularDistance (real p_rIao)
	Définit la distance inter oculaire. Plus de détails...

C3D_API castor::PixelFormat	getPixelFormat () const
	Récupère le format des pixels de la fenêtre. Plus de détails...

C3D_API void	setPixelFormat (castor::PixelFormat val)
	Définit le format des pixels de la fenêtre. Plus de détails...

uint32_t	getIndex () const
	Récupère l'index de la fenêtre. Plus de détails...

WindowHandle const &	getHandle () const
	Récupère le handle de la fenêtre. Plus de détails...

bool	isInitialised () const
	Récupère le statut de l'initialisation. Plus de détails...

FrameListenerSPtr	getListener () const
	Récupère le FrameListener. Plus de détails...

ContextSPtr	getContext () const
	Récupère la Context. Plus de détails...

RenderTargetSPtr	getRenderTarget () const
	Récupère la cible du rendu. Plus de détails...

void	setRenderTarget (RenderTargetSPtr p_pTarget)
	Définit la cible du rendu. Plus de détails...

void	setContext (ContextSPtr p_context)
	Définit le Context. Plus de détails...

bool	getVSync () const
	Dit si le contexte utilise la vsync. Plus de détails...

void	setVSync (bool p_value)
	Définit l'utilisation de la vsync. Plus de détails...

bool	isFullscreen () const
	Dit si le rendu est en plein écran. Plus de détails...

void	setFullscreen (bool p_value)
	Définit le statut du rendu plein écran. Plus de détails...

BackBuffersSPtr	getBackBuffers () const

void	saveFrame ()
	Dit que la prochaine image doit être enregistrée. Plus de détails...

castor::PxBufferBaseSPtr	getSavedFrame () const

PickingPass &	getPickingPass ()

Description détaillée

Implémentation d'une fenêtre de rendu.

Auteur: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

Remarques: Gère une fenêtre dans laquelle une scène peut être rendue

Documentation des constructeurs et destructeur

◆ RenderWindow()

C3D_API castor3d::RenderWindow::RenderWindow	(	castor::String const &	p_name,
		Engine &	engine
	)

Constructor.

Paramètres

[in]	engine	Le moteur
[in]	p_name	Le nom de la fenêtre

◆ ~RenderWindow()

C3D_API castor3d::RenderWindow::~RenderWindow ( )

Destructeur.

Documentation des fonctions membres

◆ cleanup()

C3D_API void castor3d::RenderWindow::cleanup ( )

Nettoie l'instance.

◆ getBackBuffers()

BackBuffersSPtr castor3d::RenderWindow::getBackBuffers ( ) const

inline

Renvoie: Les tampons de rendu de la fenêtre.

◆ getCamera()

C3D_API CameraSPtr castor3d::RenderWindow::getCamera ( ) const

Récupère la Camera.

Renvoie: La Camera

◆ getContext()

ContextSPtr castor3d::RenderWindow::getContext ( ) const

inline

Récupère la Context.

Renvoie: La Context

◆ getHandle()

WindowHandle const& castor3d::RenderWindow::getHandle ( ) const

inline

Récupère le handle de la fenêtre.

Renvoie: Le handle de la fenêtre

◆ getIndex()

uint32_t castor3d::RenderWindow::getIndex ( ) const

inline

Récupère l'index de la fenêtre.

Renvoie: L'index de la fenêtre

◆ getIntraOcularDistance()

C3D_API real castor3d::RenderWindow::getIntraOcularDistance ( ) const

Récupère la distance inter oculaire.

Renvoie: La distance inter oculaire

◆ getListener()

FrameListenerSPtr castor3d::RenderWindow::getListener ( ) const

inline

Récupère le FrameListener.

Renvoie: Le FrameListener

◆ getPickingPass()

PickingPass& castor3d::RenderWindow::getPickingPass ( )

inline

Renvoie: La passe de picking.

◆ getPixelFormat()

C3D_API castor::PixelFormat castor3d::RenderWindow::getPixelFormat ( ) const

Récupère le format des pixels de la fenêtre.

Renvoie: Le format des pixels de la fenêtre

◆ getRenderTarget()

RenderTargetSPtr castor3d::RenderWindow::getRenderTarget ( ) const

inline

Récupère la cible du rendu.

Renvoie: La valeur

◆ getSavedFrame()

castor::PxBufferBaseSPtr castor3d::RenderWindow::getSavedFrame ( ) const

inline

Renvoie: L'image enregistrée.

◆ getScene()

C3D_API SceneSPtr castor3d::RenderWindow::getScene ( ) const

Récupère la Scene.

Renvoie: La Scene

◆ getSize()

C3D_API castor::Size castor3d::RenderWindow::getSize ( ) const

Récupère les dimensions de la fenêtre.

Renvoie: Les dimensions de la fenêtre

◆ getViewportType()

C3D_API ViewportType castor3d::RenderWindow::getViewportType ( ) const

Récupère le ViewportType.

Renvoie: Le ViewportType

◆ getVSync()

bool castor3d::RenderWindow::getVSync ( ) const

inline

Dit si le contexte utilise la vsync.

◆ initialise()

C3D_API bool castor3d::RenderWindow::initialise	(	castor::Size const &	p_size,
		WindowHandle const &	p_handle
	)

Définit l'identifiant de la fenêtre, initialise la fenêtre.

Paramètres

[in]	p_size	Les dimensions de la fenêtre.
[in]	p_handle	Le handle.

Renvoie: false si un problème quelconque a été rencontré.

◆ isFullscreen()

bool castor3d::RenderWindow::isFullscreen ( ) const

inline

Dit si le rendu est en plein écran.

◆ isInitialised()

bool castor3d::RenderWindow::isInitialised ( ) const

inline

Récupère le statut de l'initialisation.

Renvoie: Le statut de l'initialisation

◆ isUsingStereo()

C3D_API bool castor3d::RenderWindow::isUsingStereo ( ) const

Récupère le statut d'utilisation stéréo.

Renvoie: true si le rendu stéréo est utilisé

◆ render()

C3D_API void castor3d::RenderWindow::render ( bool p_bForce )

◆ resize() [1/2]

C3D_API void castor3d::RenderWindow::resize	(	int	x,
		int	y
	)

Redimensionne la fenêtre.

Paramètres

[in] x,y Les nouvelles dimensions

◆ resize() [2/2]

C3D_API void castor3d::RenderWindow::resize ( castor::Size const & p_size )

Redimensionne la fenêtre.

Paramètres

[in] p_size Les nouvelles dimensions

◆ saveFrame()

void castor3d::RenderWindow::saveFrame ( )

inline

Dit que la prochaine image doit être enregistrée.

◆ setCamera()

C3D_API void castor3d::RenderWindow::setCamera ( CameraSPtr p_pCamera )

Définit la caméra.

Paramètres

[in] p_pCamera La caméra

◆ setContext()

void castor3d::RenderWindow::setContext ( ContextSPtr p_context )

inline

Définit le Context.

Paramètres

[in] p_context Le nouveau Context

◆ setFullscreen()

void castor3d::RenderWindow::setFullscreen ( bool p_value )

inline

Définit le statut du rendu plein écran.

Paramètres

[in] p_value Le statut

◆ setIntraOcularDistance()

C3D_API void castor3d::RenderWindow::setIntraOcularDistance ( real p_rIao )

Définit la distance inter oculaire.

Paramètres

[in] p_rIao La distance inter oculaire

◆ setPixelFormat()

C3D_API void castor3d::RenderWindow::setPixelFormat ( castor::PixelFormat val )

Définit le format des pixels de la fenêtre.

Paramètres

[in] val Le nouveau format des pixels de la fenêtre

◆ setRenderTarget()

void castor3d::RenderWindow::setRenderTarget ( RenderTargetSPtr p_pTarget )

inline

Définit la cible du rendu.

Paramètres

[in] p_pTarget La nouvelle valeur

◆ setScene()

C3D_API void castor3d::RenderWindow::setScene ( SceneSPtr p_scene )

Définit la Scene.

Paramètres

[in] p_scene La nouvelle Scene

◆ setStereo()

C3D_API void castor3d::RenderWindow::setStereo ( bool p_bStereo )

Définit le statut d'utilisation stéréo.

Paramètres

[in] p_bStereo true si le rendu stéréo est à utiliser

◆ setViewportType()

C3D_API void castor3d::RenderWindow::setViewportType ( ViewportType val )

Définit le ViewportType.

Paramètres

[in] val Le nouveau ViewportType

◆ setVSync()

void castor3d::RenderWindow::setVSync ( bool p_value )

inline

Définit l'utilisation de la vsync.

Paramètres

[in] p_value L'utilisation

◆ updateFullScreen()

C3D_API void castor3d::RenderWindow::updateFullScreen ( bool val )

Change le statut de plein écran à partir du contexte.

Paramètres

[in] val Le nouveau statut de plein écran

La documentation de cette classe a été générée à partir du fichier suivant :

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

Classes

Fonctions membres publiques

Description détaillée

Documentation des constructeurs et destructeur

◆ RenderWindow()

◆ ~RenderWindow()

Documentation des fonctions membres

◆ cleanup()

◆ getBackBuffers()

◆ getCamera()

◆ getContext()

◆ getHandle()

◆ getIndex()

◆ getIntraOcularDistance()

◆ getListener()

◆ getPickingPass()

◆ getPixelFormat()

◆ getRenderTarget()

◆ getSavedFrame()

◆ getScene()

◆ getSize()

◆ getViewportType()

◆ getVSync()

◆ initialise()

◆ isFullscreen()

◆ isInitialised()

◆ isUsingStereo()

◆ render()

◆ resize() [1/2]

◆ resize() [2/2]

◆ saveFrame()

◆ setCamera()

◆ setContext()

◆ setFullscreen()

◆ setIntraOcularDistance()

◆ setPixelFormat()

◆ setRenderTarget()

◆ setScene()

◆ setStereo()

◆ setViewportType()

◆ setVSync()

◆ updateFullScreen()