openTRI 0.1
Timer

Data Structures

struct  triTimer
 A timer struct. More...

Functions

triTimertriTimerCreate ()
 Create a timer.
triVoid triTimerUpdate (triTimer *timer)
 Update a timer.
triFloat triTimerGetDeltaTime (triTimer *timer)
 Get the delta time of a timer.
triFloat triTimerPeekDeltaTime (triTimer *timer)
 Get the delta time of a timer without changing its status.
triVoid triTimerFree (triTimer *timer)
 Free a timer.

Detailed Description

Function Documentation

◆ triTimerCreate()

triTimer * triTimerCreate ( )

Create a timer.

Returns
A pointer to a triTimer struct.

◆ triTimerUpdate()

triVoid triTimerUpdate ( triTimer * timer)

Update a timer.

Should be called once at the start of each iteration of the loop

Parameters
timer- A pointer to a valid triTimer struct

◆ triTimerGetDeltaTime()

triFloat triTimerGetDeltaTime ( triTimer * timer)

Get the delta time of a timer.

Parameters
timer- A pointer to a valid triTimer struct
Returns
The delta time member of the timer

◆ triTimerPeekDeltaTime()

triFloat triTimerPeekDeltaTime ( triTimer * timer)

Get the delta time of a timer without changing its status.

Parameters
timer- A pointer to a valid triTimer struct
Returns
The delta time member of the timer

◆ triTimerFree()

triVoid triTimerFree ( triTimer * timer)

Free a timer.

Parameters
timer- A pointer to a valid triTimer struct