Alpha Engine: AEFrameRateController.h File Reference

AlphaEngine

AEFrameRateController.h File Reference

Header file for the frame rate controller. More...

Go to the source code of this file.

Functions

void AEFrameRateControllerInit (u32 FrameRateMax)
 Initialize the frame rate controller. More...
 
void AEFrameRateControllerReset ()
 Reset the frame rate controller. More...
 
void AEFrameRateControllerStart ()
 Tell the frame rate controller that a new frame is starting. More...
 
void AEFrameRateControllerEnd ()
 Tell the frame rate controller that the current frame is ending. More...
 
f64 AEFrameRateControllerGetFrameTime ()
 Get the time for the previous frame, in seconds. More...
 
u32 AEFrameRateControllerGetFrameCount ()
 Get the total number of frames elapsed. More...
 

Detailed Description

Header file for the frame rate controller.

Project: Alpha Engine
Author
Sun Tjen Fam
Date
April 26, 2007
Copyright
Copyright (C) 2013 DigiPen Institute of Technology. Reproduction or disclosure of this file or its contents without the prior written consent of DigiPen Institute of Technology is prohibited.

Definition in file AEFrameRateController.h.

Function Documentation

void AEFrameRateControllerEnd ( )

Tell the frame rate controller that the current frame is ending.

Warning
This function is already called in AESysFrameEnd.
Return values
voidNo return
u32 AEFrameRateControllerGetFrameCount ( )

Get the total number of frames elapsed.

Return values
f64Return the total number of frames elapsed.
f64 AEFrameRateControllerGetFrameTime ( )

Get the time for the previous frame, in seconds.

Return values
f64Return the time for the previous frame, in seconds.
bool AEFrameRateControllerInit ( u32  FrameRateMax)

Initialize the frame rate controller.

Warning
This function is already called in AESysInit.
Parameters
[in]FrameRateMaxThe maximum number of frames per second.
Return values
boolReturns true
void AEFrameRateControllerReset ( )

Reset the frame rate controller.

Warning
This function is already called in AESysReset.
Return values
voidNo return
void AEFrameRateControllerStart ( )

Tell the frame rate controller that a new frame is starting.

Warning
This function is already called in AESysFrameStart.
Return values
voidNo return
Generated on Sat Jan 4 2014 02:06:22 for Alpha Engine by   doxygen 1.8.5