Navigation
API > API/Runtime > API/Runtime/TimeManagement
Class to control the Engine Timestep from a Genlock signal.
| Name | UGenlockedCustomTimeStep |
| Type | class |
| Header File | /Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h |
| Include Path | #include "GenlockedCustomTimeStep.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UGenlockedCustomTimeStep : public UFixedFrameRateCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UGenlockedCustomTimeStep
Derived Classes
UGenlockedCustomTimeStep derived class hierarchy
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CVarExperimentalFieldFlipFix | TAutoConsoleVariable< int32 > | Experimental fix for interlace field flipping issue. | GenlockedCustomTimeStep.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAutoDetectFormat | bool | Whether this custom time step should autodetect the video format if supported. | GenlockedCustomTimeStep.h | |
| bWaitForBothFields | bool | When using interlace video as a custom time step, enabling this option will force the engine to wait for both fields to be received before ticking. | GenlockedCustomTimeStep.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetExpectedSyncCountDelta() |
Returns how many sync counts are expected between ticks | GenlockedCustomTimeStep.h | |
virtual uint32 GetLastSyncCountDelta() |
Returns how many syncs occurred since the last tick | GenlockedCustomTimeStep.h | |
virtual FFrameRate GetSyncRate() |
Get the sync rate (not always the same as the fixed frame rate) | GenlockedCustomTimeStep.h | |
virtual bool IsLastSyncDataValid() |
Returns true if the Sync related functions will return valid data | GenlockedCustomTimeStep.h | |
virtual bool SupportsFormatAutoDetection() |
Whether automatic format detection is supported. | GenlockedCustomTimeStep.h |
Overridden from UFixedFrameRateCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFrameRate GetFixedFrameRate() |
Get The fixed FrameRate | GenlockedCustomTimeStep.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateAppTimes
(
const double& TimeBeforeSync, |
Update FApp CurrentTime, IdleTime and DeltaTime | GenlockedCustomTimeStep.h | |
virtual bool WaitForSync() |
Blocks until it gets a sync signal. Returns false if unsuccessful | GenlockedCustomTimeStep.h |