#include <RenderLoop.hpp>

Inheritance diagram for castor3d::RenderLoop:

[legend]

Collaboration diagram for castor3d::RenderLoop:

[legend]

Public Member Functions
C3D_API	RenderLoop (Engine &engine, uint32_t wantedFPS)
	Constructor.

virtual C3D_API	~RenderLoop () noexcept
	Destructor.

C3D_API void	initialise ()
	Initialises the render loop.

C3D_API void	cleanup ()
	Cleans up the render loop.

C3D_API void	showDebugOverlays (bool show)
	Show or hide debug overlays.

virtual C3D_API void	enableVSync (bool enable)
	Updates the V-Sync status.

C3D_API void	flushEvents () const
	Flushs all events of all frame listeners.

C3D_API void	registerTimer (castor::String const &category, FramePassTimer &timer)
	Registers a render pass timer.

C3D_API void	unregisterTimer (castor::String const &category, FramePassTimer &timer)
	Unregisters a render pass timer.

C3D_API void	registerBuffer (ShaderBuffer const &buffer)
	Registers a ShaderBuffer.

C3D_API void	unregisterBuffer (ShaderBuffer const &buffer)
	Unregisters a ShaderBuffer.

C3D_API bool	hasDebugOverlays () const

C3D_API void	dumpFrameTimes (Parameters &params) const
	The average frame time, in nanoseconds.

C3D_API castor::Nanoseconds	getAvgFrameTime () const

virtual C3D_API void	beginRendering ()=0
	Starts threaded render loop.

virtual C3D_API void	renderSyncFrame (castor::Milliseconds tslf=0_ms)=0
	Renders one frame, only if not in render loop.

virtual C3D_API void	pause ()=0
	Pauses the render loop.

virtual C3D_API void	resume ()=0
	Resumes the render loop.

virtual C3D_API void	endRendering ()=0
	Ends the render, cleans up engine.


Getters.
castor::Milliseconds	getFrameTime () const noexcept

uint32_t	getWantedFps () const noexcept

castor::Microseconds	getLastFrameTime () const noexcept

UploadData &	getUploadData () const noexcept

Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept

void	setOwner (Engine &owner) noexcept

Static Public Attributes
static constexpr uint32_t	UnlimitedFPS = 0xFFFFFFFFu

Protected Member Functions
C3D_API void	doRenderFrame (castor::Milliseconds tslf=0_ms)
	Starts threaded render loop.

Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.

Protected Attributes
RenderSystem &	m_renderSystem

uint32_t	m_wantedFPS

castor::Milliseconds	m_frameTime

std::atomic< castor::Microseconds >	m_lastFrameTime

castor::RawUniquePtr< DebugOverlays >	m_debugOverlays

castor::Mutex	m_debugOverlaysMtx

Constructor & Destructor Documentation

◆ RenderLoop()

C3D_API castor3d::RenderLoop::RenderLoop	(	Engine &	engine,
		uint32_t	wantedFPS )

Constructor.

Parameters

[in]	engine	The engine.
[in]	wantedFPS	The wanted FPS count.

◆ ~RenderLoop()

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

virtualnoexcept

Destructor.

Member Function Documentation

◆ beginRendering()

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

pure virtual

Starts threaded render loop.

Implemented in castor3d::RenderLoopAsync, and castor3d::RenderLoopSync.

◆ cleanup()

C3D_API void castor3d::RenderLoop::cleanup ( )

Cleans up the render loop.

◆ doRenderFrame()

C3D_API void castor3d::RenderLoop::doRenderFrame ( castor::Milliseconds tslf = 0_ms )

protected

Starts threaded render loop.

Parameters

[in] tslf The time elapsed since last frame.

◆ dumpFrameTimes()

C3D_API void castor3d::RenderLoop::dumpFrameTimes ( Parameters & params ) const

The average frame time, in nanoseconds.

◆ enableVSync()

virtual C3D_API void castor3d::RenderLoop::enableVSync ( bool enable )

virtual

Updates the V-Sync status.

Parameters

[in] enable The status.

Reimplemented in castor3d::RenderLoopAsync.

◆ endRendering()

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

pure virtual

Ends the render, cleans up engine.

Remarks: Ends the threaded render loop, if any.

Implemented in castor3d::RenderLoopAsync, and castor3d::RenderLoopSync.

◆ flushEvents()

C3D_API void castor3d::RenderLoop::flushEvents ( ) const

Flushs all events of all frame listeners.

◆ getAvgFrameTime()

C3D_API castor::Nanoseconds castor3d::RenderLoop::getAvgFrameTime ( ) const

Returns: The average frame time, in nanoseconds.

◆ getFrameTime()

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

inlinenoexcept

References m_frameTime.

◆ getLastFrameTime()

castor::Microseconds castor3d::RenderLoop::getLastFrameTime ( ) const

inlinenoexcept

References m_lastFrameTime.

◆ getUploadData()

UploadData & castor3d::RenderLoop::getUploadData ( ) const

inlinenoexcept

◆ getWantedFps()

uint32_t castor3d::RenderLoop::getWantedFps ( ) const

inlinenoexcept

References m_wantedFPS.

◆ hasDebugOverlays()

C3D_API bool castor3d::RenderLoop::hasDebugOverlays ( ) const

Returns: The debug overlays shown status.

◆ initialise()

C3D_API void castor3d::RenderLoop::initialise ( )

Initialises the render loop.

◆ pause()

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

pure virtual

Pauses the render loop.

Implemented in castor3d::RenderLoopAsync, and castor3d::RenderLoopSync.

◆ registerBuffer()

C3D_API void castor3d::RenderLoop::registerBuffer ( ShaderBuffer const & buffer )

Registers a ShaderBuffer.

Parameters

[in] buffer The ShaderBuffer.

◆ registerTimer()

C3D_API void castor3d::RenderLoop::registerTimer	(	castor::String const &	category,
		FramePassTimer &	timer )

Registers a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to register.

◆ renderSyncFrame()

virtual C3D_API void castor3d::RenderLoop::renderSyncFrame ( castor::Milliseconds tslf = 0_ms )

pure virtual

Renders one frame, only if not in render loop.

Parameters

[in] tslf The time elapsed since last frame.

Implemented in castor3d::RenderLoopAsync, and castor3d::RenderLoopSync.

◆ resume()

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

pure virtual

Resumes the render loop.

Implemented in castor3d::RenderLoopAsync, and castor3d::RenderLoopSync.

◆ showDebugOverlays()

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

Show or hide debug overlays.

Parameters

[in] show The status.

◆ unregisterBuffer()

C3D_API void castor3d::RenderLoop::unregisterBuffer ( ShaderBuffer const & buffer )

Unregisters a ShaderBuffer.

Parameters

[in] buffer The ShaderBuffer.

◆ unregisterTimer()

C3D_API void castor3d::RenderLoop::unregisterTimer	(	castor::String const &	category,
		FramePassTimer &	timer )

Unregisters a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to unregister.

Member Data Documentation

◆ m_debugOverlays

castor::RawUniquePtr< DebugOverlays > castor3d::RenderLoop::m_debugOverlays

protected

The debug overlays.

◆ m_debugOverlaysMtx

castor::Mutex castor3d::RenderLoop::m_debugOverlaysMtx

protected

◆ m_frameTime

castor::Milliseconds castor3d::RenderLoop::m_frameTime

protected

The wanted time for a frame.

Referenced by getFrameTime().

◆ m_lastFrameTime

std::atomic< castor::Microseconds > castor3d::RenderLoop::m_lastFrameTime

protected

The elapsed time for the last frame.

Referenced by getLastFrameTime().

◆ m_renderSystem

RenderSystem& castor3d::RenderLoop::m_renderSystem

protected

The current RenderSystem.

◆ m_wantedFPS

uint32_t castor3d::RenderLoop::m_wantedFPS

protected

The wanted FPS, used in threaded render mode.

Referenced by getWantedFps().

◆ UnlimitedFPS

constexpr uint32_t castor3d::RenderLoop::UnlimitedFPS = 0xFFFFFFFFu

staticconstexpr

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

Castor3D/Render/RenderLoop.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ RenderLoop()

◆ ~RenderLoop()

Member Function Documentation

◆ beginRendering()

◆ cleanup()

◆ doRenderFrame()

◆ dumpFrameTimes()

◆ enableVSync()

◆ endRendering()

◆ flushEvents()

◆ getAvgFrameTime()

◆ getFrameTime()

◆ getLastFrameTime()

◆ getUploadData()

◆ getWantedFps()

◆ hasDebugOverlays()

◆ initialise()

◆ pause()

◆ registerBuffer()

◆ registerTimer()

◆ renderSyncFrame()

◆ resume()

◆ showDebugOverlays()

◆ unregisterBuffer()

◆ unregisterTimer()

Member Data Documentation

◆ m_debugOverlays

◆ m_debugOverlaysMtx

◆ m_frameTime

◆ m_lastFrameTime

◆ m_renderSystem

◆ m_wantedFPS

◆ UnlimitedFPS