UGenlockedCustomTimeStep

Class to control the Engine Timestep from a Genlock signal.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

TimeManagement

Header

/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h

Include

#include "GenlockedCustomTimeStep.h"

Syntax

class UGenlockedCustomTimeStep : public UFixedFrameRateCustomTimeStep

Remarks

Class to control the Engine Timestep from a Genlock signal.

Functions

Name Description

Public function Virtual Const

uint32

 

GetExpectedSyncCountDelta()

Returns how many sync counts are expected between ticks

Public function Virtual Const

uint32

 

GetLastSyncCountDelta()

Returns how many syncs occurred since the last tick

Public function Virtual Const

FFrameRate

 

GetSyncRate()

Get the sync rate (not always the same as the fixed frame rate)

Public function Virtual Const

bool

 

IsLastSyncDataValid()

Returns true if the Sync related functions will return valid data

Protected function Const

void

 

UpdateAppTimes

(
    const double& TimeBeforeSync,
    const double& TimeAfterSync
)

Update FApp CurrentTime, IdleTime and DeltaTime

Protected function Virtual

bool

 

WaitForSync()

Blocks until it gets a sync signal. Returns false if unsuccessful

Overridden from UFixedFrameRateCustomTimeStep

Name Description

Public function Virtual Const

FFrameRate

 

GetFixedFrameRate()

Get The fixed FrameRate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss