Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FFrameTime

Light Theme

Dark Theme

FFrameTime

Structure representing a time by a context-free frame number, plus a sub frame value in the range [0:1) Conversion to and from time in seconds is achieved in combination with [FFrameRate](API\Runtime\Core\Misc\FFrameRate).

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/FrameTime.h
Include	#include "Misc/FrameTime.h"

Syntax

struct FFrameTime

Remarks

Structure representing a time by a context-free frame number, plus a sub frame value in the range [0:1) Conversion to and from time in seconds is achieved in combination with FFrameRate. Only the frame number part of this representation can be negative, sub frames are always a positive value between the frame number and its next logical frame

Variables

		Name	Description
	FFrameNumber	FrameNumber

Constructors

	Name	Description
	FFrameTime()	Default constructor initializing to zero
	FFrameTime ( T InFrameNumber )	Implicit construction from a single integer, while disallowing implicit conversion from any other numeric type
	FFrameTime ( FFrameNumber InFrameNumber )	Implicit construction from a type-safe frame number
	FFrameTime ( FFrameNumber InFrameNumber, float InSubFrame )	Construction from a frame number and a sub frame

Functions

	Name	Description
double	AsDecimal()	Retrieve a decimal representation of this frame time Sub frames are always added to the current frame number, so for negative frame times, a time of -10 [sub frame 0.25] will yield a decimal value of -9.75.
FFrameNumber	CeilToFrame()	Return the next frame number greater than or equal to this frame time
FFrameNumber	FloorToFrame()	Return the first frame number less than or equal to this frame time
FFrameTime	FromDecimal ( double InDecimalFrame )	Convert a decimal representation to a frame time
FFrameNumber	GetFrame()	Access this time's frame number
float	GetSubFrame()	Access this time's sub frame
FFrameNumber	RoundToFrame()	Round to the nearest frame number

Operators

		Name	Description
	FFrameTime &	operator= ( FFrameNumber InFrameNumber )	Assignment from a type-safe frame number

Constants

Name	Description
MaxSubframe