UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Friends | List of all members
FFrameNumber Struct Reference

#include <FrameNumber.h>

Public Member Functions

constexpr FFrameNumber ()
 
template<typename T , typename U = typename TEnableIf<std::is_same_v<T, int32>>::Type>
constexpr FFrameNumber (T InValue)
 
CORE_API bool Serialize (FArchive &Ar)
 
FFrameNumber & operator+= (FFrameNumber RHS)
 
FFrameNumber & operator-= (FFrameNumber RHS)
 
FFrameNumber & operator%= (FFrameNumber RHS)
 
FFrameNumber & operator++ ()
 
FFrameNumber & operator-- ()
 
FFrameNumber operator++ (int32)
 
FFrameNumber operator-- (int32)
 

Public Attributes

int32 Value
 

Friends

CORE_API FArchive & operator<< (FArchive &Ar, FFrameNumber &FrameNumber)
 
bool operator== (FFrameNumber A, FFrameNumber B)
 
bool operator!= (FFrameNumber A, FFrameNumber B)
 
bool operator< (FFrameNumber A, FFrameNumber B)
 
bool operator> (FFrameNumber A, FFrameNumber B)
 
bool operator<= (FFrameNumber A, FFrameNumber B)
 
bool operator>= (FFrameNumber A, FFrameNumber B)
 
FFrameNumber operator+ (FFrameNumber A, FFrameNumber B)
 
FFrameNumber operator- (FFrameNumber A, FFrameNumber B)
 
FFrameNumber operator% (FFrameNumber A, FFrameNumber B)
 
FFrameNumber operator- (FFrameNumber A)
 
FFrameNumber operator* (FFrameNumber A, float Scalar)
 
FFrameNumber operator/ (FFrameNumber A, float Scalar)
 
uint32 GetTypeHash (FFrameNumber A)
 

Detailed Description

Typesafe 32-bit signed frame number. Defined in this way to prevent erroneous float->int conversions and afford type-safe operator overloading.

Constructor & Destructor Documentation

◆ FFrameNumber() [1/2]

constexpr FFrameNumber::FFrameNumber ( )
inlineconstexpr

◆ FFrameNumber() [2/2]

template<typename T , typename U = typename TEnableIf<std::is_same_v<T, int32>>::Type>
constexpr FFrameNumber::FFrameNumber ( T  InValue)
inlineconstexpr

Implicit construction from a signed integer frame number, whilst disallowing any construction from other types.

Member Function Documentation

◆ operator%=()

FFrameNumber & FFrameNumber::operator%= ( FFrameNumber  RHS)
inline

◆ operator++() [1/2]

FFrameNumber & FFrameNumber::operator++ ( )
inline

◆ operator++() [2/2]

FFrameNumber FFrameNumber::operator++ ( int32  )
inline

◆ operator+=()

FFrameNumber & FFrameNumber::operator+= ( FFrameNumber  RHS)
inline

◆ operator--() [1/2]

FFrameNumber & FFrameNumber::operator-- ( )
inline

◆ operator--() [2/2]

FFrameNumber FFrameNumber::operator-- ( int32  )
inline

◆ operator-=()

FFrameNumber & FFrameNumber::operator-= ( FFrameNumber  RHS)
inline

◆ Serialize()

bool FFrameNumber::Serialize ( FArchive &  Ar)

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( FFrameNumber  A)
friend

◆ operator!=

bool operator!= ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator%

FFrameNumber operator% ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator*

FFrameNumber operator* ( FFrameNumber  A,
float  Scalar 
)
friend

◆ operator+

FFrameNumber operator+ ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator- [1/2]

FFrameNumber operator- ( FFrameNumber  A)
friend

◆ operator- [2/2]

FFrameNumber operator- ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator/

FFrameNumber operator/ ( FFrameNumber  A,
float  Scalar 
)
friend

◆ operator<

bool operator< ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator<<

CORE_API FArchive & operator<< ( FArchive &  Ar,
FFrameNumber &  FrameNumber 
)
friend

Serializes the given FrameNumber from or into the specified archive.

Parameters
ArThe archive to serialize from or into.
FrameNumberThe bound to serialize.
Returns
The archive used for serialization.

◆ operator<=

bool operator<= ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator==

bool operator== ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator>

bool operator> ( FFrameNumber  A,
FFrameNumber  B 
)
friend

◆ operator>=

bool operator>= ( FFrameNumber  A,
FFrameNumber  B 
)
friend

Member Data Documentation

◆ Value

int32 FFrameNumber::Value

The value of the frame number

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