Data Structures | Functions | Variables
Time.h File Reference
#include <SFML/System/Export.h>

Go to the source code of this file.

Data Structures

struct  sfTime
 Represents a time value. More...
 

Functions

CSFML_SYSTEM_API float sfTime_asSeconds (sfTime time)
 Return a time value as a number of seconds. More...
 
CSFML_SYSTEM_API sfInt32 sfTime_asMilliseconds (sfTime time)
 Return a time value as a number of milliseconds. More...
 
CSFML_SYSTEM_API sfInt64 sfTime_asMicroseconds (sfTime time)
 Return a time value as a number of microseconds. More...
 
CSFML_SYSTEM_API sfTime sfSeconds (float amount)
 Construct a time value from a number of seconds. More...
 
CSFML_SYSTEM_API sfTime sfMilliseconds (sfInt32 amount)
 Construct a time value from a number of milliseconds. More...
 
CSFML_SYSTEM_API sfTime sfMicroseconds (sfInt64 amount)
 Construct a time value from a number of microseconds. More...
 

Variables

CSFML_SYSTEM_API sfTime sfTime_Zero
 Predefined "zero" time value. More...
 

Function Documentation

◆ sfMicroseconds()

CSFML_SYSTEM_API sfTime sfMicroseconds ( sfInt64  amount)

Construct a time value from a number of microseconds.

Parameters
amountNumber of microseconds
Returns
Time value constructed from the amount of microseconds

◆ sfMilliseconds()

CSFML_SYSTEM_API sfTime sfMilliseconds ( sfInt32  amount)

Construct a time value from a number of milliseconds.

Parameters
amountNumber of milliseconds
Returns
Time value constructed from the amount of milliseconds

◆ sfSeconds()

CSFML_SYSTEM_API sfTime sfSeconds ( float  amount)

Construct a time value from a number of seconds.

Parameters
amountNumber of seconds
Returns
Time value constructed from the amount of seconds

◆ sfTime_asMicroseconds()

CSFML_SYSTEM_API sfInt64 sfTime_asMicroseconds ( sfTime  time)

Return a time value as a number of microseconds.

Parameters
timeTime value
Returns
Time in microseconds

◆ sfTime_asMilliseconds()

CSFML_SYSTEM_API sfInt32 sfTime_asMilliseconds ( sfTime  time)

Return a time value as a number of milliseconds.

Parameters
timeTime value
Returns
Time in milliseconds

◆ sfTime_asSeconds()

CSFML_SYSTEM_API float sfTime_asSeconds ( sfTime  time)

Return a time value as a number of seconds.

Parameters
timeTime value
Returns
Time in seconds

Variable Documentation

◆ sfTime_Zero

CSFML_SYSTEM_API sfTime sfTime_Zero

Predefined "zero" time value.

Definition at line 47 of file Time.h.