UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCommonFrameRates Struct Reference

#include <CommonFrameRates.h>

Public Member Functions

typedef __underlying_type (ECommonFrameRate) NumericType
 

Static Public Member Functions

static FFrameRate FPS_12 ()
 
static FFrameRate FPS_15 ()
 
static FFrameRate FPS_24 ()
 
static FFrameRate FPS_25 ()
 
static FFrameRate FPS_30 ()
 
static FFrameRate FPS_48 ()
 
static FFrameRate FPS_50 ()
 
static FFrameRate FPS_60 ()
 
static FFrameRate FPS_100 ()
 
static FFrameRate FPS_120 ()
 
static FFrameRate FPS_240 ()
 
static FFrameRate NTSC_24 ()
 
static FFrameRate NTSC_30 ()
 
static FFrameRate NTSC_60 ()
 
static TIMEMANAGEMENT_API TArrayView< const FCommonFrameRateInfoGetAll ()
 
static bool Contains (FFrameRate FrameRateToCheck)
 
static TIMEMANAGEMENT_API const FCommonFrameRateInfoFind (FFrameRate InFrameRate)
 
static TIMEMANAGEMENT_API const FCommonFrameRateInfoFind (const double InFrameRateAsDecimal, const double Tolerance=UE_DOUBLE_KINDA_SMALL_NUMBER)
 

Member Function Documentation

◆ __underlying_type()

typedef FCommonFrameRates::__underlying_type ( ECommonFrameRate  )

◆ Contains()

static bool FCommonFrameRates::Contains ( FFrameRate  FrameRateToCheck)
inlinestatic

◆ Find() [1/2]

const FCommonFrameRateInfo * FCommonFrameRates::Find ( const double  InFrameRateAsDecimal,
const double  Tolerance = UE_DOUBLE_KINDA_SMALL_NUMBER 
)
static

Find a common frame rate that matches the given frame rate as a decimal number of frames per second.

Parameters
InFrameRateAsDecimalFrame rate (in frames per second) to search for.
ToleranceNumerical tolerance to use when searching for a frame rate match.
Returns
: a pointer to the matching common frame rate if a match was found, or nullptr otherwise.

◆ Find() [2/2]

const FCommonFrameRateInfo * FCommonFrameRates::Find ( FFrameRate  InFrameRate)
static

◆ FPS_100()

static FFrameRate FCommonFrameRates::FPS_100 ( )
inlinestatic

◆ FPS_12()

static FFrameRate FCommonFrameRates::FPS_12 ( )
inlinestatic

◆ FPS_120()

static FFrameRate FCommonFrameRates::FPS_120 ( )
inlinestatic

◆ FPS_15()

static FFrameRate FCommonFrameRates::FPS_15 ( )
inlinestatic

◆ FPS_24()

static FFrameRate FCommonFrameRates::FPS_24 ( )
inlinestatic

◆ FPS_240()

static FFrameRate FCommonFrameRates::FPS_240 ( )
inlinestatic

◆ FPS_25()

static FFrameRate FCommonFrameRates::FPS_25 ( )
inlinestatic

◆ FPS_30()

static FFrameRate FCommonFrameRates::FPS_30 ( )
inlinestatic

◆ FPS_48()

static FFrameRate FCommonFrameRates::FPS_48 ( )
inlinestatic

◆ FPS_50()

static FFrameRate FCommonFrameRates::FPS_50 ( )
inlinestatic

◆ FPS_60()

static FFrameRate FCommonFrameRates::FPS_60 ( )
inlinestatic

◆ GetAll()

TArrayView< const FCommonFrameRateInfo > FCommonFrameRates::GetAll ( )
static

◆ NTSC_24()

static FFrameRate FCommonFrameRates::NTSC_24 ( )
inlinestatic

◆ NTSC_30()

static FFrameRate FCommonFrameRates::NTSC_30 ( )
inlinestatic

◆ NTSC_60()

static FFrameRate FCommonFrameRates::NTSC_60 ( )
inlinestatic

The documentation for this struct was generated from the following files: