UTimeSynchronizationSource::FindDistanceBetweenFramesWithRolloverModulus

Calculates the distance between two frames.

Windows
MacOS
Linux

References

Module

TimeManagement

Header

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

Include

#include "TimeSynchronizationSource.h"

Syntax

static int32 FindDistanceBetweenFramesWithRolloverModulus
(
    const FFrameTime & StartFrameTime,
    const FFrameTime & EndFrameTime,
    const TOptional< FFrameTime > & RolloverModulus,
    bool & bDidRollover
)

Remarks

Calculates the distance between two frames. This method accounts for rollover (when used), and assumes the frames will always be relatively close together. This is also a convenient method to use to check whether or not a rollover has happened within a range of frames.

Parameters

Parameter

Description

StartFrameTime

The start time in the range.

EndFrameTime

The end time in the range.

RolloverModulus

Rollover frame value. Unset if rollover isn't used.

bDidRollover

[out] Whether or not a rollover occurred in the input range.

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