OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Package Functions | Properties | List of all members
OmegaEngine.EnginePerformance Class Reference

Tracks the performance/speed of the Engine. More...

Public Member Functions

void LogFrame (string path, FrameLog logMode=FrameLog.CpuGpu)
 Logs a complete frame for performance profiling. More...
 

Package Functions

 EnginePerformance (Device device, Action renderPure)
 
void Reset ()
 
void OnNewFrame ()
 To be called at the start of a new frame. Keeps track of the frame rate. More...
 
void BeforeRender ()
 To be called before rendering begins. More...
 
void AfterRender ()
 To be called after rendering ends. More...
 

Properties

float Fps [get, set]
 Frames per second; auto-calculated by the engine. More...
 
float FrameMs [get, set]
 Average milliseconds per frame - auto-calculated by the engine. More...
 
long TotalFrames [get, set]
 How many frames the engine has rendered since it was started. More...
 
double LastFrameTime [get, set]
 How many seconds of time have elapsed since the last frame started drawing. More...
 

Detailed Description

Tracks the performance/speed of the Engine.

Member Function Documentation

void OmegaEngine.EnginePerformance.AfterRender ( )
inlinepackage

To be called after rendering ends.

void OmegaEngine.EnginePerformance.BeforeRender ( )
inlinepackage

To be called before rendering begins.

void OmegaEngine.EnginePerformance.LogFrame ( string  path,
FrameLog  logMode = FrameLog.CpuGpu 
)
inline

Logs a complete frame for performance profiling.

Parameters
pathThe path of the file to store the log in.
logModeControls how the frame log is captured.
void OmegaEngine.EnginePerformance.OnNewFrame ( )
inlinepackage

To be called at the start of a new frame. Keeps track of the frame rate.

Property Documentation

float OmegaEngine.EnginePerformance.Fps
getset

Frames per second; auto-calculated by the engine.

float OmegaEngine.EnginePerformance.FrameMs
getset

Average milliseconds per frame - auto-calculated by the engine.

double OmegaEngine.EnginePerformance.LastFrameTime
getsetpackage

How many seconds of time have elapsed since the last frame started drawing.

long OmegaEngine.EnginePerformance.TotalFrames
getset

How many frames the engine has rendered since it was started.


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