Final Platform Layer  0.9.6-beta
Data Structures | Typedefs | Functions
Timing functions

This category contains functions for time comparisons. More...

Data Structures

union  fplWallClock
 A structure storing the wallclock, used for time-measurements only. More...
 

Typedefs

typedef union fplWallClock fplWallClock
 A structure storing the wallclock, used for time-measurements only.
 

Functions

fpl_platform_api uint64_t fplGetTimeInMilliseconds ()
 Gets the current system clock in milliseconds in default precision. More...
 
fpl_platform_api double fplGetTimeInMillisecondsHP ()
 Gets the current system clock in milliseconds in high precision (micro/nanoseconds) More...
 
fpl_platform_api uint64_t fplGetTimeInMillisecondsLP ()
 Gets the current system clock in milliseconds in low precision (milliseconds) More...
 
fpl_platform_api double fplGetTimeInSeconds ()
 Gets the current system clock in seconds in default precision. More...
 
fpl_platform_api double fplGetTimeInSecondsHP ()
 Gets the current system clock in seconds in high precision (micro/nanoseconds). More...
 
fpl_platform_api uint64_t fplGetTimeInSecondsLP ()
 Gets the current system clock in seconds in low precision (seconds). More...
 
fpl_platform_api fplWallClock fplGetWallClock ()
 Gets the current wall clock in high precision (micro/nanoseconds) used for time-measurements only. More...
 
fpl_platform_api double fplGetWallDelta (const fplWallClock start, const fplWallClock finish)
 Gets the delta value from two fplWallClock values as seconds. More...
 

Detailed Description

This category contains functions for time comparisons.

Function Documentation

◆ fplGetTimeInMilliseconds()

fpl_platform_api uint64_t fplGetTimeInMilliseconds ( )

Gets the current system clock in milliseconds in default precision.

Returns
Returns the number of milliseconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetTimeInMillisecondsHP()

fpl_platform_api double fplGetTimeInMillisecondsHP ( )

Gets the current system clock in milliseconds in high precision (micro/nanoseconds)

Returns
Returns the number of milliseconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetTimeInMillisecondsLP()

fpl_platform_api uint64_t fplGetTimeInMillisecondsLP ( )

Gets the current system clock in milliseconds in low precision (milliseconds)

Returns
Returns the number of milliseconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetTimeInSeconds()

fpl_platform_api double fplGetTimeInSeconds ( )

Gets the current system clock in seconds in default precision.

Returns
Returns the number of seconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time. There is no guarantee to get high precision here, use for high precision fplGetTimeInSecondsHP() instead!

◆ fplGetTimeInSecondsHP()

fpl_platform_api double fplGetTimeInSecondsHP ( )

Gets the current system clock in seconds in high precision (micro/nanoseconds).

Returns
Returns the number of seconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetTimeInSecondsLP()

fpl_platform_api uint64_t fplGetTimeInSecondsLP ( )

Gets the current system clock in seconds in low precision (seconds).

Returns
Returns the number of seconds since some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetWallClock()

fpl_platform_api fplWallClock fplGetWallClock ( )

Gets the current wall clock in high precision (micro/nanoseconds) used for time-measurements only.

Returns
Returns a fplWallClock containing some fixed starting point (OS start, System start, etc).
Note
Can only be used to calculate a difference in time!

◆ fplGetWallDelta()

fpl_platform_api double fplGetWallDelta ( const fplWallClock  start,
const fplWallClock  finish 
)

Gets the delta value from two fplWallClock values as seconds.

Returns
Returns the resulting number of seconds.