#include <RenderWindow.hpp>

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

[légende]

Graphe de collaboration de castor3d::RenderWindow:

[légende]

Classes
class	EvtHandler

class	InputListener

Fonctions membres publiques
C3D_API	RenderWindow (castor::String const &name, Engine &engine, castor::Size const &size, ashes::WindowHandle handle)
	Constructor.

C3D_API	~RenderWindow () noexcept
	Destructeur.

C3D_API void	initialise (RenderWindowDesc const &desc)
	Initialises la render window avec la RenderTarget donnée.

C3D_API void	cleanup ()
	Nettoie l'instance.

C3D_API void	update (CpuUpdater &updater)
	Met à jour la render window, au niveau CPU.

C3D_API void	update (GpuUpdater &updater)
	Met à jour la render window, au niveau GPU.

C3D_API void	upload (UploadData &uploader)
	Met à jour tous les tampons GPU d'incrustations en VRAM.

C3D_API void	render (RenderInfo &info, bool signalOnly, crg::SemaphoreWaitArray &toWait)
	Renders one frame.

C3D_API void	resize (uint32_t x, uint32_t y)
	Redimensionne la fenêtre.

C3D_API void	resize (castor::Size const &size)
	Redimensionne la fenêtre.

C3D_API void	setCamera (Camera &camera) const
	Définit la caméra.

C3D_API void	enableFullScreen (bool value)
	Change le statut de plein écran.

C3D_API SceneRPtr	getScene () const

C3D_API CameraRPtr	getCamera () const

C3D_API ViewportType	getViewportType () const

C3D_API void	setViewportType (ViewportType value) const
	Définit le ViewportType.

C3D_API void	setScene (Scene &value) const
	Définit la Scene.

C3D_API castor::Size	getSize () const

C3D_API bool	isUsingStereo () const

C3D_API void	setStereo (bool stereo) const
	Définit le statut d'utilisation stéréo.

C3D_API float	getIntraOcularDistance () const
	Récupère la distance inter oculaire.

C3D_API void	setIntraOcularDistance (float intraOcularDistance) const
	Définit la distance inter oculaire.

C3D_API VkFormat	getPixelFormat () const

C3D_API PickNodeType	pick (castor::Position const &position)
	Sélectionne la géométrie à la position de souris donnée.

C3D_API void	destroyLoadingScreen ()
	Détruit la loading scene.

C3D_API void	createLoadingScreen ()
	Crée la loading scene.


C3D_API GeometryRPtr	getPickedGeometry () const

C3D_API Submesh const *	getPickedSubmesh () const

C3D_API uint32_t	getPickedFace () const

C3D_API ShadowMapLightTypeArray	getShadowMaps () const

C3D_API ShadowBuffer *	getShadowBuffer () const

uint32_t	getIndex () const noexcept

FrameListenerRPtr	getListener () const noexcept

RenderDevice const &	getDevice () const noexcept

RenderTargetRPtr	getRenderTarget () const noexcept

bool	isVSyncEnabled () const noexcept

bool	isFullscreen () const noexcept

bool	isSkipped () const noexcept

castor::PxBufferBaseRPtr	getSavedFrame () const noexcept

ashes::Surface const &	getSurface () const noexcept

ProgressBar &	getProgressBar () noexcept

EventHandlerRPtr	getEventHandler () const noexcept


C3D_API void	enableLoading ()

C3D_API void	allowHdrSwapchain (bool value=true)

void	enableVSync (bool value) noexcept

void	setFullscreen (bool value) noexcept

void	enableSaveFrame (bool value=true) noexcept

Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.

T const &	getName () const noexcept
	Récupère le nom.

void	rename (T name) noexcept

Membres hérités additionnels
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.

Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des constructeurs et destructeur

◆ RenderWindow()

C3D_API castor3d::RenderWindow::RenderWindow	(	castor::String const &	name,
		Engine &	engine,
		castor::Size const &	size,
		ashes::WindowHandle	handle )

Constructor.

Paramètres

[in]	engine	Le moteur.
[in]	name	Le nom de la fenêtre.
[in]	size	Les dimensions de la fenêtre.
[in]	handle	Le handle de la fenêtre native.

◆ ~RenderWindow()

C3D_API castor3d::RenderWindow::~RenderWindow ( )

noexcept

Destructeur.

Documentation des fonctions membres

◆ allowHdrSwapchain()

C3D_API void castor3d::RenderWindow::allowHdrSwapchain ( bool value = true )

◆ cleanup()

C3D_API void castor3d::RenderWindow::cleanup ( )

Nettoie l'instance.

◆ createLoadingScreen()

C3D_API void castor3d::RenderWindow::createLoadingScreen ( )

Crée la loading scene.

◆ destroyLoadingScreen()

C3D_API void castor3d::RenderWindow::destroyLoadingScreen ( )

Détruit la loading scene.

◆ enableFullScreen()

C3D_API void castor3d::RenderWindow::enableFullScreen ( bool value )

Change le statut de plein écran.

Paramètres

[in] value Le nouveau statut.

◆ enableLoading()

C3D_API void castor3d::RenderWindow::enableLoading ( )

name Mutateurs.

◆ enableSaveFrame()

void castor3d::RenderWindow::enableSaveFrame ( bool value = true )

inlinenoexcept

◆ enableVSync()

void castor3d::RenderWindow::enableVSync ( bool value )

inlinenoexcept

◆ getCamera()

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

Renvoie: La caméra.

◆ getDevice()

RenderDevice const & castor3d::RenderWindow::getDevice ( ) const

inlinenoexcept

◆ getEventHandler()

EventHandlerRPtr castor3d::RenderWindow::getEventHandler ( ) const

inlinenoexcept

◆ getIndex()

uint32_t castor3d::RenderWindow::getIndex ( ) const

inlinenoexcept

◆ getIntraOcularDistance()

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

Récupère la distance inter oculaire.

Renvoie: La distance inter oculaire

◆ getListener()

FrameListenerRPtr castor3d::RenderWindow::getListener ( ) const

inlinenoexcept

◆ getPickedFace()

C3D_API uint32_t castor3d::RenderWindow::getPickedFace ( ) const

◆ getPickedGeometry()

C3D_API GeometryRPtr castor3d::RenderWindow::getPickedGeometry ( ) const

name Accesseurs.

◆ getPickedSubmesh()

C3D_API Submesh const * castor3d::RenderWindow::getPickedSubmesh ( ) const

◆ getPixelFormat()

C3D_API VkFormat castor3d::RenderWindow::getPixelFormat ( ) const

Renvoie: Le format des pixels de la fenêtre.

◆ getProgressBar()

ProgressBar & castor3d::RenderWindow::getProgressBar ( )

inlinenoexcept

Références CU_Require.

◆ getRenderTarget()

RenderTargetRPtr castor3d::RenderWindow::getRenderTarget ( ) const

inlinenoexcept

◆ getSavedFrame()

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

inlinenoexcept

◆ getScene()

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

Renvoie: La scène.

◆ getShadowBuffer()

C3D_API ShadowBuffer * castor3d::RenderWindow::getShadowBuffer ( ) const

◆ getShadowMaps()

C3D_API ShadowMapLightTypeArray castor3d::RenderWindow::getShadowMaps ( ) const

◆ getSize()

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

Renvoie: Les dimensions de la fenêtre.

◆ getSurface()

ashes::Surface const & castor3d::RenderWindow::getSurface ( ) const

inlinenoexcept

Références CU_Require.

◆ getViewportType()

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

Renvoie: Le ViewportType.

◆ initialise()

C3D_API void castor3d::RenderWindow::initialise ( RenderWindowDesc const & desc )

Initialises la render window avec la RenderTarget donnée.

◆ isFullscreen()

bool castor3d::RenderWindow::isFullscreen ( ) const

inlinenoexcept

◆ isSkipped()

bool castor3d::RenderWindow::isSkipped ( ) const

inlinenoexcept

◆ isUsingStereo()

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

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

◆ isVSyncEnabled()

bool castor3d::RenderWindow::isVSyncEnabled ( ) const

inlinenoexcept

◆ pick()

C3D_API PickNodeType castor3d::RenderWindow::pick ( castor::Position const & position )

Sélectionne la géométrie à la position de souris donnée.

Paramètres

[in] position La position dans la passe.

Renvoie: PickNodeType si rien n'a été pické.

◆ render()

C3D_API void castor3d::RenderWindow::render	(	RenderInfo &	info,
		bool	signalOnly,
		crg::SemaphoreWaitArray &	toWait )

Renders one frame.

Paramètres

[in,out]	info	Reçoit les infos de rendu.
[in]	signalOnly	`true` pour ne faire que signaler les semaphores.
[in]	toWait	Les sémaphores à attendre.

◆ resize() [1/2]

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

Redimensionne la fenêtre.

Paramètres

[in] size Les nouvelles dimensions.

◆ resize() [2/2]

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

Redimensionne la fenêtre.

Paramètres

[in] x,y Les nouvelles dimensions.

◆ setCamera()

C3D_API void castor3d::RenderWindow::setCamera ( Camera & camera ) const

Définit la caméra.

Paramètres

[in] camera La caméra.

◆ setFullscreen()

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

inlinenoexcept

◆ setIntraOcularDistance()

C3D_API void castor3d::RenderWindow::setIntraOcularDistance ( float intraOcularDistance ) const

Définit la distance inter oculaire.

Paramètres

[in] intraOcularDistance La distance inter oculaire.

◆ setScene()

C3D_API void castor3d::RenderWindow::setScene ( Scene & value ) const

Définit la Scene.

Paramètres

[in] value La nouvelle valeur.

◆ setStereo()

C3D_API void castor3d::RenderWindow::setStereo ( bool stereo ) const

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

Paramètres

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

◆ setViewportType()

C3D_API void castor3d::RenderWindow::setViewportType ( ViewportType value ) const

Définit le ViewportType.

Paramètres

[in] value La nouvelle valeur.

◆ update() [1/2]

C3D_API void castor3d::RenderWindow::update ( CpuUpdater & updater )

Met à jour la render window, au niveau CPU.

Paramètres

[in,out] updater Les données d'update.

◆ update() [2/2]

C3D_API void castor3d::RenderWindow::update ( GpuUpdater & updater )

Met à jour la render window, au niveau GPU.

Paramètres

[in,out] updater Les données d'update.

◆ upload()

C3D_API void castor3d::RenderWindow::upload ( UploadData & uploader )

Met à jour tous les tampons GPU d'incrustations en VRAM.

Paramètres

[in,out] uploader Reçoit les requêtes d'upload.

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

Castor3D/Render/RenderWindow.hpp

Classes

Fonctions membres publiques

Membres hérités additionnels

Documentation des constructeurs et destructeur

◆ RenderWindow()

◆ ~RenderWindow()

Documentation des fonctions membres

◆ allowHdrSwapchain()

◆ cleanup()

◆ createLoadingScreen()

◆ destroyLoadingScreen()

◆ enableFullScreen()

◆ enableLoading()

◆ enableSaveFrame()

◆ enableVSync()

◆ getCamera()

◆ getDevice()

◆ getEventHandler()

◆ getIndex()

◆ getIntraOcularDistance()

◆ getListener()

◆ getPickedFace()

◆ getPickedGeometry()

◆ getPickedSubmesh()

◆ getPixelFormat()

◆ getProgressBar()

◆ getRenderTarget()

◆ getSavedFrame()

◆ getScene()

◆ getShadowBuffer()

◆ getShadowMaps()

◆ getSize()

◆ getSurface()

◆ getViewportType()

◆ initialise()

◆ isFullscreen()

◆ isSkipped()

◆ isUsingStereo()

◆ isVSyncEnabled()

◆ pick()

◆ render()

◆ resize() [1/2]

◆ resize() [2/2]

◆ setCamera()

◆ setFullscreen()

◆ setIntraOcularDistance()

◆ setScene()

◆ setStereo()

◆ setViewportType()

◆ update() [1/2]

◆ update() [2/2]

◆ upload()