Main System. More...

Inheritance diagram for Castor3D::RenderLoopAsync:

Collaboration diagram for Castor3D::RenderLoopAsync:

Public Member Functions
C3D_API	RenderLoopAsync (Engine &p_engine, RenderSystem *p_renderSystem, uint32_t p_wantedFPS=100)
	Constructor. More...

C3D_API	~RenderLoopAsync ()
	Destructor. More...

C3D_API bool	IsCreated () const
	Retrieves the context creation status. More...

C3D_API bool	IsRendering () const
	Retrieves the render start status. More...

C3D_API bool	IsPaused () const
	Retrieves the render paused status. More...

C3D_API bool	IsInterrupted () const
	Thread-safe. More...

C3D_API bool	IsEnded () const
	Retrieves the render loop end status. More...

virtual C3D_API void	UpdateVSync (bool p_enable)
	Updates the V-Sync status. More...

Public Member Functions inherited from Castor3D::RenderLoop
C3D_API	RenderLoop (Engine &p_engine, RenderSystem *p_renderSystem, uint32_t p_wantedFPS)
	Constructor. More...

virtual C3D_API	~RenderLoop ()
	Destructor. More...

C3D_API void	Cleanup ()
	Cleans up the render loop. More...

C3D_API void	StartRendering ()
	Starts render loop. More...

C3D_API void	RenderSyncFrame ()
	Renders one frame. More...

C3D_API void	Pause ()
	Pauses the render loop. More...

C3D_API void	Resume ()
	Resumes the render loop. More...

C3D_API void	EndRendering ()
	Ends the render. More...

C3D_API uint32_t	GetFrameTime ()
	Retrieves the wanted frame time. More...

C3D_API uint32_t	GetWantedFps ()

C3D_API void	CreateContext (RenderWindow &p_window)
	Creates a render context. More...

C3D_API void	ShowDebugOverlays (bool p_show)
	Show or hide debug overlays. More...

Additional Inherited Members
Protected Member Functions inherited from Castor3D::RenderLoop
C3D_API ContextSPtr	DoCreateContext (RenderWindow &p_window)
	Asks for render context creation. More...

C3D_API void	DoRenderFrame ()
	Starts threaded render loop. More...

Protected Attributes inherited from Castor3D::RenderLoop
RenderSystem *	m_renderSystem
	The current RenderSystem. More...

uint32_t	m_wantedFPS
	The wanted FPS, used in threaded render mode. More...

uint32_t	m_frameTime
	The wanted time for a frame. More...

std::unique_ptr< DebugOverlays >	m_debugOverlays
	The debug overlays. More...

Detailed Description

Main System.

Author: Sylvain DOREMUS

Date: 09/02/2010

Version: 0.1

Remarks: Holds the render windows, the plug-ins, the render drivers...

Constructor & Destructor Documentation

◆ RenderLoopAsync()

C3D_API Castor3D::RenderLoopAsync::RenderLoopAsync	(	Engine &	p_engine,
		RenderSystem *	p_renderSystem,
		uint32_t	p_wantedFPS = `100`
	)

Constructor.

Parameters

[in]	p_engine	The engine.
[in]	p_renderSystem	The render system.
[in]	p_wantedFPS	The wanted FPS count.

◆ ~RenderLoopAsync()

C3D_API Castor3D::RenderLoopAsync::~RenderLoopAsync ( )

Destructor.

Member Function Documentation

◆ IsCreated()

C3D_API bool Castor3D::RenderLoopAsync::IsCreated ( ) const

Retrieves the context creation status.

Remarks: Thread-safe.

Returns: true if created.

◆ IsEnded()

C3D_API bool Castor3D::RenderLoopAsync::IsEnded ( ) const

Retrieves the render loop end status.

Remarks: Thread-safe.

Returns: true if created.

◆ IsInterrupted()

C3D_API bool Castor3D::RenderLoopAsync::IsInterrupted ( ) const

Thread-safe.

Returns: true if the render loop is interrupted.

◆ IsPaused()

C3D_API bool Castor3D::RenderLoopAsync::IsPaused ( ) const

Retrieves the render paused status.

Remarks: Thread-safe.

Returns: true if paused.

◆ IsRendering()

C3D_API bool Castor3D::RenderLoopAsync::IsRendering ( ) const

Retrieves the render start status.

Remarks: Thread-safe.

Returns: true if started.

◆ UpdateVSync()

virtual C3D_API void Castor3D::RenderLoopAsync::UpdateVSync ( bool p_enable )

virtual

Updates the V-Sync status.