Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc
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
| Type | 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 | IMPORTANT: If you change the struct data, ensure that you also update the version in NoExportTypes.h |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FFrameRate () |
Default construction to a frame rate of 60000 frames per second (0.0166 ms) | |
 |
FFrameRate
(
uint32 InNumerator, |
Functions
| Type | 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, |
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 |
 |
bool | ||
  |
FFrameTime | Snap
(
FFrameTime SourceTime, |
Snap a time specified in one framerate, to another |
  |
FText | ToPrettyText () |
Convert this frame rate to a prettified text string. |
  |
FFrameTime | TransformTime
(
FFrameTime SourceTime, |
Convert the specified time from one framerate to another framerate |