className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
ITimedDataInput::GetChannels
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get a list of the channel this input has.
TimeManagement
[TArray](API\Runtime\Core\Containers\TArray)< [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * > GetChannels() const
[]
ITimedDataInput::GetDataBufferSize
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
If the input does supported it, get the size of the buffer used by the input.
TimeManagement
virtual int32 GetDataBufferSize() const
[]
ITimedDataInput::GetDisplayIcon
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the icon that represent the input.
TimeManagement
const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetDisplayIcon() const
[]
ITimedDataInput::GetEvaluationOffsetInSeconds
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the offset in seconds used at evaluation.
TimeManagement
double GetEvaluationOffsetInSeconds() const
[]
ITimedDataInput::GetDisplayName
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the name used when displayed.
TimeManagement
[FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
ITimedDataInput::GetEvaluationType
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get how the input is evaluated.
TimeManagement
ETimedDataInputEvaluationType GetEvaluationType() const
[]
ITimedDataInput::GetFrameRate
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the frame rate at which the samples are produced.
TimeManagement
[FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFrameRate() const
[]
ITimedDataInput::IsDataBufferSizeControlledByInput
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Does channel from this input support a different buffer size than it's input.
TimeManagement
bool IsDataBufferSizeControlledByInput() const
[]
ITimedDataInput::RemoveChannel
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Remove channel from the input
TimeManagement
void RemoveChannel ( [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * Channel )
[]
ITimedDataInput::SetDataBufferSize
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
If the input does supported it, set the size of the buffer used by the input.
TimeManagement
virtual void SetDataBufferSize ( int32 BufferSize )
[]
ITimedDataInput::SetEvaluationOffsetInSeconds
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Set the offset in seconds used at evaluation.
TimeManagement
void SetEvaluationOffsetInSeconds ( double Offset )
[]
ITimedDataInput::SetEvaluationType
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Set how the input is evaluated.
TimeManagement
void SetEvaluationType ( ETimedDataInputEvaluationType Evaluation )
[]
ITimedDataInput::SupportsSubFrames
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Whether this input supports sub frames.
TimeManagement
virtual bool SupportsSubFrames() const
[]
UnknownFrameRate
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
TimeManagement
static [FFrameRate](API\Runtime\Core\Misc\FFrameRate) UnknownFrameRate = FFrameRate(-1, -1);
[]
ITimedDataInput::~ITimedDataInput
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
TimeManagement
virtual ~ITimedDataInput()
[]
ITimedDataInput
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Interface for data sources that can be synchronized with time
TimeManagement
class ITimedDataInput
[]
ITimedDataInputChannel::GetBufferOverflowStat
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Return buffer overflow count detected by this input
TimeManagement
int32 GetBufferOverflowStat() const
[]
ITimedDataInputChannel::GetBufferUnderflowStat
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Return buffer underflow count detected by this input
TimeManagement
int32 GetBufferUnderflowStat() const
[]
ITimedDataInputChannel::GetDataBufferSize
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
If the channel does support it, get the current maximum sample count of channel.
TimeManagement
virtual int32 GetDataBufferSize() const
[]
ITimedDataInputChannel::GetDataTimes
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the time of all the data samples available.
TimeManagement
[TArray](API\Runtime\Core\Containers\TArray)< [FTimedDataChannelSampleTime](API\Runtime\TimeManagement\FTimedDataChannelSampleTime) > GetDataTimes() const
[]
ITimedDataInputChannel::GetFrameDroppedStat
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Return frame dropped count detected by this input
TimeManagement
int32 GetFrameDroppedStat() const
[]
ITimedDataInputChannel::GetDisplayName
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the channel's display name.
TimeManagement
[FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
ITimedDataInputChannel::GetLastEvaluationData
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get data about last evaluation. Samples used, expected, number of samples.
TimeManagement
void GetLastEvaluationData ( [FTimedDataInputEvaluationData](API\Runtime\TimeManagement\FTimedDataInputEvaluationData) & OutEvaluationData ) const
[]
ITimedDataInputChannel::GetNewestDataTime
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the time of the newest data sample available.
TimeManagement
[FTimedDataChannelSampleTime](API\Runtime\TimeManagement\FTimedDataChannelSampleTime) GetNewestDataTime() const
[]
ITimedDataInputChannel::GetNumberOfSamples
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the number of data samples available.
TimeManagement
int32 GetNumberOfSamples() const
[]
ITimedDataInputChannel::GetOldestDataTime
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the time of the oldest data sample available.
TimeManagement
[FTimedDataChannelSampleTime](API\Runtime\TimeManagement\FTimedDataChannelSampleTime) GetOldestDataTime() const
[]
ITimedDataInputChannel::GetState
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Get the current state of the channel.
TimeManagement
ETimedDataInputState GetState() const
[]
ITimedDataInputChannel::IsBufferStatsEnabled
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Is tracking of stats enabled for this input
TimeManagement
bool IsBufferStatsEnabled() const
[]
ITimedDataInputChannel::ResetBufferStats
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Resets internal stat counters
TimeManagement
void ResetBufferStats()
[]
ITimedDataInputChannel::SetBufferStatsEnabled
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Enables or disables stats tracking for this input
TimeManagement
void SetBufferStatsEnabled ( bool bEnable )
[]
ITimedDataInputChannel::SetDataBufferSize
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
If the channel does support it, set the maximum sample count of the channel.
TimeManagement
virtual void SetDataBufferSize ( int32 BufferSize )
[]
ITimedDataInputChannel
/Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
Interface for data tracked produced by an input.
TimeManagement
class ITimedDataInputChannel
[]
ITimeManagementModule::CreateFrameRatePicker
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
Returns a widget allowing for the user to pick a specific frame rate
TimeManagement
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SFrameRatePicker](API\Runtime\TimeManagement\Widgets\SFrameRatePicker) > CreateFrameRatePicker ( [SFrameRatePicker::FArguments](API\Runtime\TimeManagement\Widgets\SFrameRatePicker\FArguments) Arguments )
[]
ITimeManagementModule::Get
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
Singleton-like access toITimeManagementModuleReturnsITimeManagementModulesingleton instance, loading the module on demand if needed
TimeManagement
static [ITimeManagementModule](API\Runtime\TimeManagement\ITimeManagementModule) & Get()
[]
ITimeManagementModule::GetAllCommonFrameRates
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
Returns all stored common frame rates
TimeManagement
[TArrayView](API\Runtime\Core\Containers\TArrayView)< const struct [FCommonFrameRateInfo](API\Runtime\TimeManagement\FCommonFrameRateInfo) > GetAllCommonFrameRates()
[]
ITimeManagementModule::GetTimedDataInputCollection
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
Get the collection of theITimedDataInputand ITimedDataInputGroups.
TimeManagement
[FTimedDataInputCollection](API\Runtime\TimeManagement\FTimedDataInputCollection) & GetTimedDataInputCollection()
[]
ITimeManagementModule::IsAvailable
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true. True if the module is loaded and ready to use
TimeManagement
static bool IsAvailable()
[]
ITimeManagementModule
/Engine/Source/Runtime/TimeManagement/Public/ITimeManagementModule.h
TimeManagement
class ITimeManagementModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
TGetExpressionNodeTypeId< ExpressionParser::FBracketStart >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FDropcodeDelimiter >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FBracketStart >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FBracketStart > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FDropcodeDelimiter >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FDropcodeDelimiter > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FMillisecond >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FMillisecond >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FMillisecond > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FTimecodeDelimiter >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FTimecodeDelimiter >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FTimecodeDelimiter > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FBracketEnd >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FBracketEnd >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FBracketEnd > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FFrames >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FFrames >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FFrames > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FHour >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FSecond >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FHour >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FHour > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FMinute >::GetTypeId
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
static const FGuid & GetTypeId&40;&41;
[]
TGetExpressionNodeTypeId< ExpressionParser::FMinute >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FMinute > }
[]
TGetExpressionNodeTypeId< ExpressionParser::FSecond >
/Engine/Source/Runtime/TimeManagement/Public/FrameNumberTimeEvaluator.h
TimeManagement
namespace TGetExpressionNodeTypeId< ExpressionParser { template<> struct TGetExpressionNodeTypeId< ExpressionParser::FSecond > }
[]
UFixedFrameRateCustomTimeStep::GetFixedFrameRate
/Engine/Source/Runtime/TimeManagement/Public/FixedFrameRateCustomTimeStep.h
Get The fixed FrameRate
TimeManagement
virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const
[]
UFixedFrameRateCustomTimeStep::WaitForFixedFrameRate
/Engine/Source/Runtime/TimeManagement/Public/FixedFrameRateCustomTimeStep.h
Default behavior of the engine. Used FixedFrameRate
TimeManagement
void WaitForFixedFrameRate() const
[]
UFixedFrameRateCustomTimeStep::UFixedFrameRateCustomTimeStep
/Engine/Source/Runtime/TimeManagement/Public/FixedFrameRateCustomTimeStep.h
TimeManagement
UFixedFrameRateCustomTimeStep ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UFixedFrameRateCustomTimeStep
/Engine/Source/Runtime/TimeManagement/Public/FixedFrameRateCustomTimeStep.h
Class to control the Engine TimeStep via a FixedFrameRate
TimeManagement
class UFixedFrameRateCustomTimeStep : public [UEngineCustomTimeStep](API\Runtime\Engine\Engine\UEngineCustomTimeStep)
[]
CVarExperimentalFieldFlipFix
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Experimental fix for interlace field flipping issue.
TimeManagement
static [TAutoConsoleVariable](API\Runtime\Core\HAL\TAutoConsoleVariable)< int32 > CVarExperimentalFieldFlipFix;
[]
UGenlockedCustomTimeStep::GetExpectedSyncCountDelta
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Returns how many sync counts are expected between ticks
TimeManagement
virtual uint32 GetExpectedSyncCountDelta() const
[]
UGenlockedCustomTimeStep::GetFixedFrameRate
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Get The fixed FrameRate
TimeManagement
virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const
[]
UGenlockedCustomTimeStep::GetLastSyncCountDelta
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Returns how many syncs occurred since the last tick
TimeManagement
virtual uint32 GetLastSyncCountDelta() const
[]
UGenlockedCustomTimeStep::GetSyncRate
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Get the sync rate (not always the same as the fixed frame rate)
TimeManagement
virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetSyncRate() const
[]
UGenlockedCustomTimeStep::IsLastSyncDataValid
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Returns true if the Sync related functions will return valid data
TimeManagement
virtual bool IsLastSyncDataValid() const
[]
UGenlockedCustomTimeStep::SupportsFormatAutoDetection
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Whether automatic format detection is supported.
TimeManagement
virtual bool SupportsFormatAutoDetection() const
[]
UGenlockedCustomTimeStep::UpdateAppTimes
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
UpdateFAppCurrentTime, IdleTime and DeltaTime
TimeManagement
void UpdateAppTimes ( const double & TimeBeforeSync, const double & TimeAfterSync ) const
[]
UGenlockedCustomTimeStep::WaitForSync
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Blocks until it gets a sync signal. Returns false if unsuccessful
TimeManagement
virtual bool WaitForSync()
[]
UGenlockedCustomTimeStep
/Engine/Source/Runtime/TimeManagement/Public/GenlockedCustomTimeStep.h
Class to control the Engine Timestep from a Genlock signal.
TimeManagement
class UGenlockedCustomTimeStep : public [UFixedFrameRateCustomTimeStep](API\Runtime\TimeManagement\UFixedFrameRateCustomTimeStep)
[ { "type": "bool", "name": "bAutoDetectFormat", "description": "Whether this custom time step should autodetect the video format if supported." } ]
UGenlockedFixedRateCustomTimeStep::GetFixedFrameRate
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Get The fixed FrameRate
TimeManagement
virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const
[]
UGenlockedFixedRateCustomTimeStep::GetSynchronizationState
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
The state of the CustomTimeStep.
TimeManagement
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() const
[]
UGenlockedFixedRateCustomTimeStep::GetLastSyncCountDelta
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Returns how many syncs occurred since the last tick
TimeManagement
virtual uint32 GetLastSyncCountDelta() const
[]
UGenlockedFixedRateCustomTimeStep::Initialize
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
This CustomTimeStep became the Engine's CustomTimeStep.
TimeManagement
virtual bool Initialize ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )
[]
UGenlockedFixedRateCustomTimeStep::IsLastSyncDataValid
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Returns true if the Sync related functions will return valid data
TimeManagement
virtual bool IsLastSyncDataValid() const
[]
UGenlockedFixedRateCustomTimeStep::Shutdown
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
This CustomTimeStep stop being the Engine's CustomTimeStep.
TimeManagement
virtual void Shutdown ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )
[]
UGenlockedFixedRateCustomTimeStep::UpdateTimeStep
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Update FApp::CurrentTime/FApp::DeltaTime and optionally wait until the end of the frame. true if the Engine's TimeStep should also be performed; false otherwise.
TimeManagement
virtual bool UpdateTimeStep ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )
[]
UGenlockedFixedRateCustomTimeStep::WaitForSync
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Blocks until it gets a sync signal. Returns false if unsuccessful
TimeManagement
virtual bool WaitForSync()
[]
UGenlockedFixedRateCustomTimeStep::UGenlockedFixedRateCustomTimeStep
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
TimeManagement
UGenlockedFixedRateCustomTimeStep ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UGenlockedTimecodeProvider::CorrectFromGenlock
/Engine/Source/Runtime/TimeManagement/Public/GenlockedTimecodeProvider.h
Corrects given timecode with Genlock provider
TimeManagement
virtual [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) CorrectFromGenlock ( [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & InFrameTime, const [UGenlockedCustomTimeStep](API\Runtime\TimeManagement\UGenlockedCustomTimeStep) * Genlock )
[]
UGenlockedFixedRateCustomTimeStep
/Engine/Source/Runtime/TimeManagement/Public/GenlockedFixedRateCustomTimeStep.h
Philosophy:
TimeManagement
class UGenlockedFixedRateCustomTimeStep : public [UGenlockedCustomTimeStep](API\Runtime\TimeManagement\UGenlockedCustomTimeStep)
[ { "type": "bool", "name": "bForceSingleFrameDeltaTime", "description": "When true, delta time will always be 1/FrameRate, regardless of how much real time has elapsed" }, { "type": "bool", "name": "bShouldBlock", "description": "Indicates that this custom time step should block to enforce the specified frame rate." }, { "type": "FFrameRate", "name": "FrameRate", "description": "Desired frame rate" } ]
UGenlockedTimecodeProvider::FetchAndUpdate
/Engine/Source/Runtime/TimeManagement/Public/GenlockedTimecodeProvider.h
Update the state of the provider. Call it to ensure timecode and state are updated. It is suggested to fetch timecode from its source and cache it for the getters.
TimeManagement
virtual void FetchAndUpdate()
[]
UGenlockedTimecodeProvider::GetQualifiedFrameTime
/Engine/Source/Runtime/TimeManagement/Public/GenlockedTimecodeProvider.h
Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.
TimeManagement
virtual [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) GetQualifiedFrameTime() const
[]
UGenlockedTimecodeProvider
/Engine/Source/Runtime/TimeManagement/Public/GenlockedTimecodeProvider.h
This timecode provider base class will try to use the engine genlock sync to adjust its count.
TimeManagement
class UGenlockedTimecodeProvider : public [UTimecodeProvider](API\Runtime\Engine\Engine\UTimecodeProvider)
[ { "type": "bool", "name": "bUseGenlockToCount", "description": "Use Genlock Sync to update Timecode count" }, { "type": "FQualifiedFrame...", "name": "LastFetchedFrameTime", "description": "Cache last fetched frame time (raw from hardware)" }, { "type": "FQualifiedFrame...", "name": "LastFrameTime", "description": "Cache current frame time" } ]
UTimeManagementBlueprintLibrary::Add_FrameNumberFrameNumber
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Addition (FrameNumber A + FrameNumber B)
TimeManagement
static [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) Add_FrameNumberFrameNumber ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) A, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) B )
[]
UTimeManagementBlueprintLibrary::Add_FrameNumberInteger
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Addition (FrameNumber A + int B)
TimeManagement
static [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) Add_FrameNumberInteger ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) A, int32 B )
[]
UTimeManagementBlueprintLibrary::Conv_FrameNumberToInteger
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Converts a FrameNumber to an int32 for use in functions that take int32 frame counts for convenience.
TimeManagement
static int32 Conv_FrameNumberToInteger ( const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) & InFrameNumber )
[]
UTimeManagementBlueprintLibrary::Conv_FrameRateToSeconds
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Converts an FrameRate to a float ie: 1/30 returns 0.0333333
TimeManagement
static float Conv_FrameRateToSeconds ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate )
[]
UTimeManagementBlueprintLibrary::Conv_FrameRateToInterval
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Converts a FrameRate to an interval float representing the frame time in seconds ie: 1/30 returns 0.0333333
TimeManagement
static float Conv_FrameRateToInterval ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) InFrameRate )
[]
UTimeManagementBlueprintLibrary::Conv_QualifiedFrameTimeToSeconds
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Converts an QualifiedFrameTime to seconds.
TimeManagement
static float Conv_QualifiedFrameTimeToSeconds ( const [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & InFrameTime )
[]
UTimeManagementBlueprintLibrary::Conv_TimecodeToString
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Converts an Timecode to a string (hh:mm:ss:ff). If bForceSignDisplay then the number sign will always be prepended instead of just when expressing a negative time.
TimeManagement
static [FString](API\Runtime\Core\Containers\FString) Conv_TimecodeToString ( const [FTimecode](API\Runtime\Core\Misc\FTimecode) & InTimecode, bool bForceSignDisplay )
[]
UTimeManagementBlueprintLibrary::GetTimecode
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Get the current timecode of the engine.
TimeManagement
static [FTimecode](API\Runtime\Core\Misc\FTimecode) GetTimecode()
[]
UTimeManagementBlueprintLibrary::Divide_FrameNumberInteger
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Divide (FrameNumber A / B)
TimeManagement
static [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) Divide_FrameNumberInteger ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) A, int32 B )
[]
UTimeManagementBlueprintLibrary::GetTimecodeFrameRate
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Gets the current timecode frame rate.
TimeManagement
static [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetTimecodeFrameRate()
[]
UTimeManagementBlueprintLibrary::IsValid_Framerate
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Verifies that this is a valid framerate with a non-zero denominator.
TimeManagement
static bool IsValid_Framerate ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate )
[]
UTimeManagementBlueprintLibrary::IsValid_MultipleOf
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Checks if this framerate is an even multiple of another framerate, ie: 60 is a multiple of 30, but 59.94 is not.
TimeManagement
static bool IsValid_MultipleOf ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & OtherFramerate )
[]
UTimeManagementBlueprintLibrary::Multiply_FrameNumberInteger
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Multiply (FrameNumber A * B)
TimeManagement
static [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) Multiply_FrameNumberInteger ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) A, int32 B )
[]
UTimeManagementBlueprintLibrary::Multiply_SecondsFrameRate
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Multiplies a value in seconds against a FrameRate to get a new FrameTime.
TimeManagement
static [FFrameTime](API\Runtime\Core\Misc\FFrameTime) Multiply_SecondsFrameRate ( float TimeInSeconds, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & FrameRate )
[]
UTimeManagementBlueprintLibrary::SnapFrameTimeToRate
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Snaps the given SourceTime to the nearest frame in the specified Destination Framerate. Useful for determining the nearest frame for another resolution. Returns the frame time in the destination frame rate.
TimeManagement
static [FFrameTime](API\Runtime\Core\Misc\FFrameTime) SnapFrameTimeToRate ( const [FFrameTime](API\Runtime\Core\Misc\FFrameTime) & SourceTime, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & SourceRate, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & SnapToRate )
[]
UTimeManagementBlueprintLibrary::Subtract_FrameNumberFrameNumber
/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Subtraction (FrameNumber A - FrameNumber B)
TimeManagement
static [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) Subtract_FrameNumberFrameNumber ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) A, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) B )
[]