Castor3D  ..
Public Member Functions | List of all members
Castor3D::RenderLoopSync Class Reference

Synchronous render loop. More...

+ Inheritance diagram for Castor3D::RenderLoopSync:
+ Collaboration diagram for Castor3D::RenderLoopSync:

Public Member Functions

C3D_API RenderLoopSync (Engine &p_engine, RenderSystem *p_renderSystem, uint32_t p_wantedFPS=100)
 Constructor. More...
 
C3D_API ~RenderLoopSync ()
 Destructor. 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...
 
virtual C3D_API void UpdateVSync (bool p_enable)
 Updates the V-Sync status. 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
RenderSystemm_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< DebugOverlaysm_debugOverlays
 The debug overlays. More...
 

Detailed Description

Synchronous render loop.

Author
Sylvain DOREMUS
Date
14/10/2015
Version
0.8.0

Constructor & Destructor Documentation

◆ RenderLoopSync()

C3D_API Castor3D::RenderLoopSync::RenderLoopSync ( Engine p_engine,
RenderSystem p_renderSystem,
uint32_t  p_wantedFPS = 100 
)

Constructor.

Parameters
[in]p_engineThe engine.
[in]p_renderSystemThe render system.
[in]p_wantedFPSThe wanted FPS count.

◆ ~RenderLoopSync()

C3D_API Castor3D::RenderLoopSync::~RenderLoopSync ( )

Destructor.


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