Navigation
API > API/Runtime > API/Runtime/TimeManagement
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.
| Name | UGenlockedFixedRateCustomTimeStep |
| Type | class |
| Header File | /Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h |
| Include Path | #include "GenlockedFixedRateCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew, Meta=(DisplayName="Genlocked Fixed Rate"), MinimalAPI)
class UGenlockedFixedRateCustomTimeStep : public UGenlockedCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UGenlockedCustomTimeStep → UGenlockedFixedRateCustomTimeStep
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UGenlockedFixedRateCustomTimeStep
(
const FObjectInitializer& ObjectInitializer |
GenlockedFixedRateCustomTimeStep.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bForceSingleFrameDeltaTime | bool | When true, delta time will always be 1/FrameRate, regardless of how much real time has elapsed | GenlockedFixedRateCustomTimeStep.h |
|
| bShouldBlock | bool | Indicates that this custom time step should block to enforce the specified frame rate. | GenlockedFixedRateCustomTimeStep.h |
|
| FrameRate | FFrameRate | Desired frame rate | GenlockedFixedRateCustomTimeStep.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastIdleTime | double | GenlockedFixedRateCustomTimeStep.h | ||
| LastSyncCountDelta | uint32 | GenlockedFixedRateCustomTimeStep.h | ||
| QuantizedCurrentTime | double | GenlockedFixedRateCustomTimeStep.h |
Functions
Public
Overridden from UGenlockedCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetLastSyncCountDelta() |
Returns how many syncs occurred since the last tick | GenlockedFixedRateCustomTimeStep.h | |
virtual bool IsLastSyncDataValid() |
Returns true if the Sync related functions will return valid data | GenlockedFixedRateCustomTimeStep.h | |
virtual bool WaitForSync() |
Blocks until it gets a sync signal. Returns false if unsuccessful | GenlockedFixedRateCustomTimeStep.h |
Overridden from UFixedFrameRateCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFrameRate GetFixedFrameRate() |
Get The fixed FrameRate | GenlockedFixedRateCustomTimeStep.h |
Overridden from UEngineCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() |
GenlockedFixedRateCustomTimeStep.h | ||
virtual bool Initialize
(
UEngine* InEngine |
GenlockedFixedRateCustomTimeStep.h | ||
virtual void Shutdown
(
UEngine* InEngine |
GenlockedFixedRateCustomTimeStep.h | ||
virtual bool UpdateTimeStep
(
UEngine* InEngine |
GenlockedFixedRateCustomTimeStep.h |