Navigation
API > API/Runtime > API/Runtime/TimeManagement
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UEngineCustomTimeStep
- UFixedFrameRateCustomTimeStep
- UGenlockedCustomTimeStep
- UGenlockedFixedRateCustomTimeStep
References
| Module | TimeManagement |
| Header | /Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h |
| Include | #include "GenlockedFixedRateCustomTimeStep.h" |
Syntax
class UGenlockedFixedRateCustomTimeStep : public UGenlockedCustomTimeStep
Remarks
Control the Engine TimeStep via a fixed frame rate.
Philosophy:
- Quantized increments but keeping up with platform time.
- FApp::GetDeltaTime
- Forced to a multiple of the desired FrameTime.
- FApp::GetCurrentTime
- Incremented in multiples of the desired FrameTime.
- Corresponds to platform time minus any fractional FrameTime.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bForceSingleFrameDeltaTime | When true, delta time will always be 1/FrameRate, regardless of how much real time has elapsed | |
| bool | bShouldBlock | Indicates that this custom time step should block to enforce the specified frame rate. | |
| FFrameRate | FrameRate | Desired frame rate |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UGenlockedFixedRateCustomTimeStep
(
const FObjectInitializer& ObjectInitializer |
Overridden from UGenlockedCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
| uint32 | Returns how many syncs occurred since the last tick | ||
| bool | Returns true if the Sync related functions will return valid data | ||
| bool | WaitForSync () |
Blocks until it gets a sync signal. Returns false if unsuccessful |
Overridden from UFixedFrameRateCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
| FFrameRate | Get The fixed FrameRate |
Overridden from UEngineCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
| ECustomTimeStepSynchronizationState | The state of the CustomTimeStep. | ||
| bool | Initialize
(
UEngine* InEngine |
This CustomTimeStep became the Engine's CustomTimeStep. | |
| void | This CustomTimeStep stop being the Engine's CustomTimeStep. | ||
| bool | UpdateTimeStep
(
UEngine* InEngine |
Update FApp::CurrentTime/FApp::DeltaTime and optionally wait until the end of the frame. |