Timing functions

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

Data Structures
union	fplTimestamp
	Stores a timestamp, used for delta measurements only. More...

Macros
#define	FPL_TIMEOUT_INFINITE
	Infinite timeout constant.

Typedefs
typedef uint64_t	fplMilliseconds
	A type definition for milliseconds (64-bit).
typedef double	fplSeconds
	A type definition for seconds (64-bit).
typedef uint32_t	fplTimeoutValue
	A type definition for a timeout value in milliseconds.
typedef union fplTimestamp	fplTimestamp

Functions
fpl_platform_api fplMilliseconds	fplMillisecondsQuery (void)
	Gets the current system clock in milliseconds, since some fixed starting point (OS start, System start, etc.), used for time delta measurements only.
fpl_platform_api fplSeconds	fplTimestampElapsed (const fplTimestamp start, const fplTimestamp finish)
	Gets the delta value from two fplTimestamp values in seconds.
fpl_platform_api fplTimestamp	fplTimestampQuery (void)
	Gets the current fplTimestamp with most precision, used for time delta measurements only.

Detailed Description

This category contains functions for time comparisons.

Macro Definition Documentation

FPL_TIMEOUT_INFINITE

#define FPL_TIMEOUT_INFINITE

Infinite timeout constant.

Definition at line 5621 of file final_platform_layer.h.

Typedef Documentation

fplMilliseconds

typedef uint64_t fplMilliseconds

A type definition for milliseconds (64-bit).

Definition at line 5633 of file final_platform_layer.h.

fplSeconds

typedef double fplSeconds

A type definition for seconds (64-bit).

Definition at line 5627 of file final_platform_layer.h.

fplTimeoutValue

typedef uint32_t fplTimeoutValue

A type definition for a timeout value in milliseconds.

Definition at line 5615 of file final_platform_layer.h.

Function Documentation

fplMillisecondsQuery()

fpl_platform_api fplMilliseconds fplMillisecondsQuery

(

void

)

Gets the current system clock in milliseconds, since some fixed starting point (OS start, System start, etc.), used for time delta measurements only.

Returns

Returns the number of milliseconds as fplMilliseconds.

fplTimestampElapsed()

fpl_platform_api fplSeconds fplTimestampElapsed	(	const fplTimestamp	start,
		const fplTimestamp	finish )

Gets the delta value from two fplTimestamp values in seconds.

Parameters

[in]	start	The starting fplTimestamp.
[in]	finish	The ending fplTimestamp.

Returns

Returns the resulting elapsed time in seconds as fplSeconds.

fplTimestampQuery()

fpl_platform_api fplTimestamp fplTimestampQuery

(

void

)

Gets the current fplTimestamp with most precision, used for time delta measurements only.

Returns

Returns the resulting fplTimestamp.

Note

Use fplTimestampElapsed() to get the elapsed time.