Hymn to Beauty
C++ 3D Engine
Engine Class Reference

An instance of the engine. More...

#include <Engine.hpp>

Classes

struct  Configuration
 Engine configuration. More...
 

Public Member Functions

bool Start ()
 Start the engine based on the Configuration. More...
 
Utility::WindowGetWindow ()
 Get the window. More...
 
bool ShouldClose () const
 Get whether the application should close. More...
 
void Update ()
 Update the engine. More...
 
double GetDeltaTime () const
 Get time between frames. More...
 
void Render ()
 Render a frame. More...
 
void Present ()
 Swap buffers and wait for next frame. More...
 
void Shutdown ()
 Shut down the engine. More...
 

Public Attributes

struct Engine::Configuration configuration
 

Detailed Description

An instance of the engine.

Member Function Documentation

◆ GetDeltaTime()

double Engine::GetDeltaTime ( ) const

Get time between frames.

Returns
The time in seconds since last frame.

◆ GetWindow()

Utility::Window * Engine::GetWindow ( )

Get the window.

Returns
The window.

◆ Present()

void Engine::Present ( )

Swap buffers and wait for next frame.

Todo:
Make limiting FPS optional.

◆ Render()

void Engine::Render ( )

Render a frame.

◆ ShouldClose()

bool Engine::ShouldClose ( ) const

Get whether the application should close.

Returns
Whether the application should close.

◆ Shutdown()

void Engine::Shutdown ( )

Shut down the engine.

◆ Start()

bool Engine::Start ( )

Start the engine based on the Configuration.

Sets up libraries, creates a window and starts managers.

Returns
Whether startup was successful.

◆ Update()

void Engine::Update ( )

Update the engine.

Updates the moving parts of the engine.

Member Data Documentation

◆ configuration

struct Engine::Configuration Engine::configuration

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