Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Static Public Member Functions | Static Protected Attributes | List of all members
FGenericPlatformTime Struct Reference

#include <GenericPlatformTime.h>

+ Inheritance diagram for FGenericPlatformTime:

Static Public Member Functions

static TCHAR * StrDate (TCHAR *Dest, SIZE_T DestSize)
 
static TCHAR * StrTime (TCHAR *Dest, SIZE_T DestSize)
 
static const TCHAR * StrTimestamp ()
 
static FString PrettyTime (double Seconds)
 
static bool UpdateCPUTime (float DeltaTime)
 
static bool UpdateThreadCPUTime (float=0.0)
 
static void AutoUpdateGameThreadCPUTime (double UpdateInterval)
 
static FCPUTime GetCPUTime ()
 
static FCPUTime GetThreadCPUTime ()
 
static double GetLastIntervalCPUTimeInSeconds ()
 
static double GetLastIntervalThreadCPUTimeInSeconds ()
 
static double GetSecondsPerCycle ()
 
static float ToMilliseconds (const uint32 Cycles)
 
static float ToSeconds (const uint32 Cycles)
 
static double GetSecondsPerCycle64 ()
 
static double ToMilliseconds64 (const uint64 Cycles)
 
static double ToSeconds64 (const uint64 Cycles)
 

Static Protected Attributes

static double SecondsPerCycle
 
static double SecondsPerCycle64
 
static double LastIntervalCPUTimeInSeconds
 

Detailed Description

Generic implementation for most platforms

Definition at line 42 of file GenericPlatformTime.h.

Member Function Documentation

◆ AutoUpdateGameThreadCPUTime()

static void FGenericPlatformTime::AutoUpdateGameThreadCPUTime ( double UpdateInterval)
inlinestatic

Registers automatic updates of Game Thread CPU utilization

Definition at line 128 of file GenericPlatformTime.h.

◆ GetCPUTime()

static FCPUTime FGenericPlatformTime::GetCPUTime ( )
inlinestatic
Returns
structure that contains CPU utilization data.

Definition at line 135 of file GenericPlatformTime.h.

+ Here is the call graph for this function:

◆ GetLastIntervalCPUTimeInSeconds()

static double FGenericPlatformTime::GetLastIntervalCPUTimeInSeconds ( )
inlinestatic
Returns
the cpu processing time (kernel + user time of all threads) from the last update

Definition at line 153 of file GenericPlatformTime.h.

◆ GetLastIntervalThreadCPUTimeInSeconds()

static double FGenericPlatformTime::GetLastIntervalThreadCPUTimeInSeconds ( )
inlinestatic

Gets the per-thread CPU processing time (kernel + user) from the last update

Returns
The per-thread CPU processing time from the last update

Definition at line 163 of file GenericPlatformTime.h.

◆ GetSecondsPerCycle()

static double FGenericPlatformTime::GetSecondsPerCycle ( )
inlinestatic
Returns
seconds per cycle.

Definition at line 171 of file GenericPlatformTime.h.

+ Here is the caller graph for this function:

◆ GetSecondsPerCycle64()

static double FGenericPlatformTime::GetSecondsPerCycle64 ( )
static
Returns
seconds per cycle.
+ Here is the caller graph for this function:

◆ GetThreadCPUTime()

static FCPUTime FGenericPlatformTime::GetThreadCPUTime ( )
inlinestatic

Gets current threads CPU Utilization

Returns
Current threads CPU Utilization

Definition at line 145 of file GenericPlatformTime.h.

+ Here is the call graph for this function:

◆ PrettyTime()

static FString FGenericPlatformTime::PrettyTime ( double Seconds)
static

Returns a pretty-string for a time given in seconds. (I.e. "4:31 min", "2:16:30 hours", etc)

Parameters
SecondsTime in seconds
Returns
Time in a pretty formatted string

◆ StrDate()

static TCHAR * FGenericPlatformTime::StrDate ( TCHAR * Dest,
SIZE_T DestSize )
static

Get the system date

Parameters
DestDestination buffer to copy to
DestSizeSize of destination buffer in characters
Returns
Date string

◆ StrTime()

static TCHAR * FGenericPlatformTime::StrTime ( TCHAR * Dest,
SIZE_T DestSize )
static

Get the system time

Parameters
DestDestination buffer to copy to
DestSizeSize of destination buffer in characters
Returns
Time string

◆ StrTimestamp()

static const TCHAR * FGenericPlatformTime::StrTimestamp ( )
static

Returns a timestamp string built from the current date and time. NOTE: Only one return value is valid at a time!

Returns
timestamp string

◆ ToMilliseconds()

static float FGenericPlatformTime::ToMilliseconds ( const uint32 Cycles)
inlinestatic

Converts cycles to milliseconds.

Definition at line 176 of file GenericPlatformTime.h.

◆ ToMilliseconds64()

static double FGenericPlatformTime::ToMilliseconds64 ( const uint64 Cycles)
inlinestatic

Converts cycles to milliseconds.

Definition at line 191 of file GenericPlatformTime.h.

+ Here is the call graph for this function:

◆ ToSeconds()

static float FGenericPlatformTime::ToSeconds ( const uint32 Cycles)
inlinestatic

Converts cycles to seconds.

Definition at line 182 of file GenericPlatformTime.h.

◆ ToSeconds64()

static double FGenericPlatformTime::ToSeconds64 ( const uint64 Cycles)
inlinestatic

Converts cycles to seconds.

Definition at line 197 of file GenericPlatformTime.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ UpdateCPUTime()

static bool FGenericPlatformTime::UpdateCPUTime ( float DeltaTime)
inlinestatic

Updates CPU utilization, called through a delegate from the Core ticker.

Definition at line 116 of file GenericPlatformTime.h.

◆ UpdateThreadCPUTime()

static bool FGenericPlatformTime::UpdateThreadCPUTime ( float = 0.0)
inlinestatic

Updates current thread CPU utilization, calling is user defined per-thread (unused float parameter, is for FTicker compatibility).

Definition at line 122 of file GenericPlatformTime.h.

Member Data Documentation

◆ LastIntervalCPUTimeInSeconds

double FGenericPlatformTime::LastIntervalCPUTimeInSeconds
staticprotected

Definition at line 206 of file GenericPlatformTime.h.

◆ SecondsPerCycle

double FGenericPlatformTime::SecondsPerCycle
staticprotected

Definition at line 204 of file GenericPlatformTime.h.

◆ SecondsPerCycle64

double FGenericPlatformTime::SecondsPerCycle64
staticprotected

Definition at line 205 of file GenericPlatformTime.h.

The documentation for this struct was generated from the following file: