Navigation
API > API/Runtime > API/Runtime/Engine
A CustomTimeStep control the Engine Framerate/Timestep. This will update the FApp::CurrentTime/FAppDeltaTime. This is useful when you want the engine to be synchronized with an external clock (genlock).
| Name | UEngineCustomTimeStep |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/EngineCustomTimeStep.h |
| Include Path | #include "Engine/EngineCustomTimeStep.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UEngineCustomTimeStep : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetDisplayName () |
Get the display name of the custom time step. | Engine/EngineCustomTimeStep.h | |
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() |
The state of the CustomTimeStep. | Engine/EngineCustomTimeStep.h | |
virtual bool Initialize
(
UEngine* InEngine |
This CustomTimeStep became the Engine's CustomTimeStep. | Engine/EngineCustomTimeStep.h | |
virtual void Shutdown
(
UEngine* InEngine |
This CustomTimeStep stop being the Engine's CustomTimeStep. | Engine/EngineCustomTimeStep.h | |
virtual bool UpdateTimeStep
(
UEngine* InEngine |
Update FApp::CurrentTime/FAppDeltaTime and optionally wait until the end of the frame. | Engine/EngineCustomTimeStep.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void UpdateApplicationLastTime() |
Default behaviour of the engine. Update FApp::LastTime | Engine/EngineCustomTimeStep.h |