Classe de base d'une boucle de rendu. Plus de détails...

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

Graphe de collaboration de castor3d::RenderLoop:

Fonctions membres publiques
C3D_API	RenderLoop (Engine &engine, uint32_t p_wantedFPS, bool p_isAsync)
	Constructeur. Plus de détails...

virtual C3D_API	~RenderLoop ()
	Destructeur. Plus de détails...

C3D_API void	cleanup ()
	Nettoie la boucle de rendu. Plus de détails...

C3D_API void	createContext (RenderWindow &p_window)
	Crée un contexte de rendu. Plus de détails...

C3D_API void	showDebugOverlays (bool p_show)
	Affiche ou cache les incrustations de débogage. Plus de détails...

virtual C3D_API void	updateVSync (bool p_enable)
	Met à jour le statut de synchronisation verticale. Plus de détails...

C3D_API void	flushEvents ()
	Vide tous les évènements de tous les frame listeners. Plus de détails...

C3D_API void	registerTimer (RenderPassTimer &timer)
	Enregistre un timer de passe de rendu. Plus de détails...

C3D_API void	unregisterTimer (RenderPassTimer &timer)
	Désenregistre un timer de passe de rendu. Plus de détails...

virtual C3D_API void	beginRendering ()=0
	Commence le rendu threadé. Plus de détails...

virtual C3D_API void	renderSyncFrame ()=0
	Rend une image, uniquement hors de la boucle de rendu. Plus de détails...

virtual C3D_API void	pause ()=0
	Met la boucle de rendu en pause. Plus de détails...

virtual C3D_API void	resume ()=0
	Redémarre la boucle de rendu. Plus de détails...

virtual C3D_API void	endRendering ()=0
	Termine le rendu, nettoie le moteur. Plus de détails...

castor::Milliseconds	getFrameTime ()

uint32_t	getWantedFps ()

bool	hasDebugOverlays () const

Fonctions membres protégées
C3D_API ContextSPtr	doCreateContext (RenderWindow &p_window)
	Demande la création du contexte de rendu. Plus de détails...

C3D_API void	doRenderFrame ()
	Commence le rendu threadé. Plus de détails...

virtual C3D_API ContextSPtr	doCreateMainContext (RenderWindow &p_window)=0
	Demande la création du contexte de rendu principal. Plus de détails...

Attributs protégés
RenderSystem &	m_renderSystem

uint32_t	m_wantedFPS

castor::Milliseconds	m_frameTime

std::unique_ptr< DebugOverlays >	m_debugOverlays

castor::ThreadPool	m_queueUpdater

Description détaillée

Classe de base d'une boucle de rendu.

Auteur: Sylvain DOREMUS

Date: 14/10/2015

Version: 0.8.0

Documentation des constructeurs et destructeur

◆ RenderLoop()

C3D_API castor3d::RenderLoop::RenderLoop	(	Engine &	engine,
		uint32_t	p_wantedFPS,
		bool	p_isAsync
	)

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	p_wantedFPS	Le nombre voulu du FPS.
[in]	p_isAsync	Dit si la boucle de rendu est asynchrone.

◆ ~RenderLoop()

virtual C3D_API castor3d::RenderLoop::~RenderLoop ( )

virtual

Destructeur.

Documentation des fonctions membres

◆ beginRendering()

virtual C3D_API void castor3d::RenderLoop::beginRendering ( )

pure virtual

Commence le rendu threadé.

Implémenté dans castor3d::RenderLoopAsync, et castor3d::RenderLoopSync.

◆ cleanup()

C3D_API void castor3d::RenderLoop::cleanup ( )

Nettoie la boucle de rendu.

◆ createContext()

C3D_API void castor3d::RenderLoop::createContext ( RenderWindow & p_window )

Crée un contexte de rendu.

Remarques: Si le contexte principal n'a pas encore été créé, le premier contexte créé deviendra le contexte principal. Pour la boucles de rendu asynchrone, cela signifie que le thread appelant cette fonction sera sans contexte associé, prévenant l'appel de renderSyncFrame.

Paramètres

[in] p_window La fenêtre de rendu utilisée pour initialiser le contexte de rendu, recevra le contexte.

◆ doCreateContext()

C3D_API ContextSPtr castor3d::RenderLoop::doCreateContext ( RenderWindow & p_window )

protected

Demande la création du contexte de rendu.

Paramètres

[in] p_window La fenêtre de rendu utilisée pour initialiser le contexte de rendu, recevra le contexte.

Renvoie: Le contexte créé, ou l'existant.

Référencé par hasDebugOverlays().

Voici le graphe des appelants de cette fonction :

◆ doCreateMainContext()

virtual C3D_API ContextSPtr castor3d::RenderLoop::doCreateMainContext ( RenderWindow & p_window )

protectedpure virtual

Demande la création du contexte de rendu principal.

Paramètres

[in] p_window La fenêtre de rendu utilisée pour initialiser le contexte de rendu, recevra le contexte.

Référencé par hasDebugOverlays().

Voici le graphe des appelants de cette fonction :

◆ doRenderFrame()

C3D_API void castor3d::RenderLoop::doRenderFrame ( )

protected

Commence le rendu threadé.

Référencé par hasDebugOverlays().

Voici le graphe des appelants de cette fonction :

◆ endRendering()

virtual C3D_API void castor3d::RenderLoop::endRendering ( )

pure virtual

Termine le rendu, nettoie le moteur.

Remarques: Arrête la boucle de rendu threadé, si elle existe.

Implémenté dans castor3d::RenderLoopAsync, et castor3d::RenderLoopSync.

◆ flushEvents()

C3D_API void castor3d::RenderLoop::flushEvents ( )

Vide tous les évènements de tous les frame listeners.

◆ getFrameTime()

castor::Milliseconds castor3d::RenderLoop::getFrameTime ( )

inline

Renvoie: Le temps voulu pour une frame, en millisecondes.

Références m_frameTime.

◆ getWantedFps()

uint32_t castor3d::RenderLoop::getWantedFps ( )

inline

Renvoie: La vitesse de rafraichissement.

Références m_wantedFPS.

◆ hasDebugOverlays()

bool castor3d::RenderLoop::hasDebugOverlays ( ) const

inline

Renvoie: Le statut d'affichage des incrustations de débogage.

Références C3D_API, doCreateContext(), doCreateMainContext(), doRenderFrame(), et m_debugOverlays.

Voici le graphe d'appel pour cette fonction :

◆ pause()

virtual C3D_API void castor3d::RenderLoop::pause ( )

pure virtual

Met la boucle de rendu en pause.

Implémenté dans castor3d::RenderLoopAsync, et castor3d::RenderLoopSync.

◆ registerTimer()

C3D_API void castor3d::RenderLoop::registerTimer ( RenderPassTimer & timer )

Enregistre un timer de passe de rendu.

Paramètres

[in] timer Le timer à enregistrer.

◆ renderSyncFrame()

virtual C3D_API void castor3d::RenderLoop::renderSyncFrame ( )

pure virtual

Rend une image, uniquement hors de la boucle de rendu.

Implémenté dans castor3d::RenderLoopAsync, et castor3d::RenderLoopSync.

◆ resume()

virtual C3D_API void castor3d::RenderLoop::resume ( )

pure virtual

Redémarre la boucle de rendu.

Implémenté dans castor3d::RenderLoopAsync, et castor3d::RenderLoopSync.

◆ showDebugOverlays()

C3D_API void castor3d::RenderLoop::showDebugOverlays ( bool p_show )

Affiche ou cache les incrustations de débogage.

Paramètres

[in] p_show Le statut.

◆ unregisterTimer()

C3D_API void castor3d::RenderLoop::unregisterTimer ( RenderPassTimer & timer )

Désenregistre un timer de passe de rendu.

Paramètres

[in] timer Le timer à désenregistrer.

◆ updateVSync()

virtual C3D_API void castor3d::RenderLoop::updateVSync ( bool p_enable )

virtual

Met à jour le statut de synchronisation verticale.

Paramètres

[in] p_enable Le statut.

Réimplémentée dans castor3d::RenderLoopAsync.

Documentation des données membres

◆ m_debugOverlays

std::unique_ptr< DebugOverlays > castor3d::RenderLoop::m_debugOverlays

protected

Les incrustations de débogage.

Référencé par hasDebugOverlays().

◆ m_frameTime

castor::Milliseconds castor3d::RenderLoop::m_frameTime

protected

Le temps voulu pour une frame.

Référencé par getFrameTime().

◆ m_queueUpdater

castor::ThreadPool castor3d::RenderLoop::m_queueUpdater

protected

Le pool de mise à jour des files de rendu.

◆ m_renderSystem

RenderSystem& castor3d::RenderLoop::m_renderSystem

protected

Le RenderSystem courant.

◆ m_wantedFPS

uint32_t castor3d::RenderLoop::m_wantedFPS

protected

Le nombre de FPS souhaité, utilisé en rendu threadé.

Référencé par getWantedFps().

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

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ RenderLoop()

◆ ~RenderLoop()

Documentation des fonctions membres

◆ beginRendering()

◆ cleanup()

◆ createContext()

◆ doCreateContext()

◆ doCreateMainContext()

◆ doRenderFrame()

◆ endRendering()

◆ flushEvents()

◆ getFrameTime()

◆ getWantedFps()

◆ hasDebugOverlays()

◆ pause()

◆ registerTimer()

◆ renderSyncFrame()

◆ resume()

◆ showDebugOverlays()

◆ unregisterTimer()

◆ updateVSync()

Documentation des données membres

◆ m_debugOverlays

◆ m_frameTime

◆ m_queueUpdater

◆ m_renderSystem

◆ m_wantedFPS