Navigation
API > API/Runtime > API/Runtime/Core
A frame rate represented as a fraction comprising 2 integers: a numerator (number of frames), and a denominator (per second)
| Name | FFrameRate |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/FrameRate.h |
| Include Path | #include "Misc/FrameRate.h" |
Syntax
struct FFrameRate
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameRate () |
Default construction to a frame rate of 60000 frames per second (0.0166 ms) | Misc/FrameRate.h | |
FFrameRate
(
uint32 InNumerator, |
Misc/FrameRate.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Denominator | int32 | The denominator of the framerate represented as a number of frames per second (e.g. 1 for 60 fps) | Misc/FrameRate.h | |
| Numerator | int32 | IMPORTANT: If you change the struct data, ensure that you also update the version in NoExportTypes.h | Misc/FrameRate.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
double AsDecimal() |
Get the decimal representation of this framerate | Misc/FrameRate.h | |
FFrameNumber AsFrameNumber
(
double InTimeSeconds |
Convert the specified time in seconds to a frame number by rounding down to the nearest integer. | Misc/FrameRate.h | |
FFrameTime AsFrameTime
(
double InTimeSeconds |
Convert the specified time in seconds to a frame number by rounding down to the nearest integer. | Misc/FrameRate.h | |
double AsInterval() |
Get the decimal representation of this framerate's interval | Misc/FrameRate.h | |
double AsSeconds
(
FFrameTime FrameNumber |
Convert the specified frame number to a floating-point number of seconds based on this framerate | Misc/FrameRate.h | |
bool ComputeGridSpacing
(
const float PixelsPerSecond, |
Compute a desirable grid spacing for the specified screen units | Misc/FrameRate.h | |
bool IsFactorOf
(
FFrameRate Other |
Check whether this frame rate is a factor of another | Misc/FrameRate.h | |
bool IsMultipleOf
(
FFrameRate Other |
Check whether this frame rate is a multiple of another | Misc/FrameRate.h | |
bool IsValid() |
Verify that this frame rate is valid to use | Misc/FrameRate.h | |
double MaxSeconds() |
Get the maximum number of seconds representable with this framerate | Misc/FrameRate.h | |
FFrameRate Reciprocal() |
Get the reciprocal of this frame rate | Misc/FrameRate.h | |
bool Serialize
(
FArchive& Ar |
Misc/FrameRate.h | ||
| Convert this frame rate to a prettified text string. | Misc/FrameRate.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FFrameTime Snap
(
FFrameTime SourceTime, |
Snap a time specified in one framerate, to another | Misc/FrameRate.h | |
static FFrameTime TransformTime
(
FFrameTime SourceTime, |
Convert the specified time from one framerate to another framerate | Misc/FrameRate.h |