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 > FFrameRate

Light Theme

Dark Theme

FFrameRate

A frame rate represented as a fraction comprising 2 integers: a numerator (number of frames), and a denominator (per second)

Windows

MacOS

Linux

Inheritance Hierarchy

FFrameRate

FLiveLinkFrameRate

References

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

Syntax

struct FFrameRate

Remarks

A frame rate represented as a fraction comprising 2 integers: a numerator (number of frames), and a denominator (per second)

Variables

		Name	Description
	int32	Denominator	The denominator of the framerate represented as a number of frames per second (e.g. 1 for 60 fps)
	int32	Numerator	The numerator of the framerate represented as a number of frames per second (e.g. 60 for 60 fps)

Constructors

	Name	Description
	FFrameRate()	Default construction to a frame rate of 60000 frames per second (0.0166 ms)
	FFrameRate ( uint32 InNumerator, uint32 InDenominator )

Functions

	Name	Description
double	AsDecimal()	Get the decimal representation of this framerate
FFrameNumber	AsFrameNumber ( double InTimeSeconds )	Convert the specified time in seconds to a frame number by rounding down to the nearest integer.
FFrameTime	AsFrameTime ( double InTimeSeconds )	Convert the specified time in seconds to a frame number by rounding down to the nearest integer.
double	AsInterval()	Get the decimal representation of this framerate's interval
double	AsSeconds ( FFrameTime FrameNumber )	Convert the specified frame number to a floating-point number of seconds based on this framerate
bool	ComputeGridSpacing ( const float PixelsPerSecond, double& OutMajorInterval, int32& OutMinorDivisions, float MinTickPx, float DesiredMajorTickPx )	Compute a desirable grid spacing for the specified screen units
bool	IsFactorOf ( FFrameRate Other )	Check whether this frame rate is a factor of another
bool	IsMultipleOf ( FFrameRate Other )	Check whether this frame rate is a multiple of another
bool	IsValid()	Verify that this frame rate is valid to use
double	MaxSeconds()	Get the maximum number of seconds representable with this framerate
FFrameRate	Reciprocal()	Get the reciprocal of this frame rate
FFrameTime	Snap ( FFrameTime SourceTime, FFrameRate SourceRate, FFrameRate SnapToRate )	Snap a time specified in one framerate, to another
FText	ToPrettyText()	Convert this frame rate to a prettified text string.
FFrameTime	TransformTime ( FFrameTime SourceTime, FFrameRate SourceRate, FFrameRate DestinationRate )	Convert the specified time from one framerate to another 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