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

#include <IOSPlatformFramePacer.h>

+ Inheritance diagram for FIOSPlatformRHIFramePacer:

Static Public Member Functions

static bool IsEnabled ()
 
static void Destroy ()
 
static int32 SetFramePace (int32 FramePace)
 
static int32 GetFramePace ()
 
static bool SupportsFramePace (int32 QueryFramePace)
 
static void InitWithEvent (class FEvent *TriggeredEvent)
 
static void AddHandler (FIOSFramePacerHandler Handler)
 
static void RemoveHandler (FIOSFramePacerHandler Handler)
 
static uint32 GetMaxRefreshRate ()
 
static void Suspend ()
 
static void Resume ()
 
- Static Public Member Functions inherited from FGenericPlatformRHIFramePacer
static int32 GetFramePace ()
 
static int32 SetFramePace (int32 FramePace)
 
static APPLICATIONCORE_API bool SupportsFramePace (int32 QueryFramePace)
 

Static Public Attributes

static FIOSFramePacerFramePacer = nil
 
static uint32 FrameInterval = 1
 
static uint32 MinFrameInterval = 1
 
static uint32 Pace = 0
 

Additional Inherited Members

- Static Protected Member Functions inherited from FGenericPlatformRHIFramePacer
static APPLICATIONCORE_API int32 GetFramePaceFromSyncInterval ()
 
static APPLICATIONCORE_API int32 SetFramePaceToSyncInterval (int32 FramePace)
 

Detailed Description

iOS implementation of FGenericPlatformRHIFramePacer

Member Function Documentation

◆ AddHandler()

void FIOSPlatformRHIFramePacer::AddHandler ( FIOSFramePacerHandler  Handler)
static

◆ Destroy()

void FIOSPlatformRHIFramePacer::Destroy ( )
static

◆ GetFramePace()

int32 FIOSPlatformRHIFramePacer::GetFramePace ( )
static

◆ GetMaxRefreshRate()

uint32 FIOSPlatformRHIFramePacer::GetMaxRefreshRate ( )
static

◆ InitWithEvent()

void FIOSPlatformRHIFramePacer::InitWithEvent ( class FEvent TriggeredEvent)
static

◆ IsEnabled()

bool FIOSPlatformRHIFramePacer::IsEnabled ( )
static

◆ RemoveHandler()

void FIOSPlatformRHIFramePacer::RemoveHandler ( FIOSFramePacerHandler  Handler)
static

◆ Resume()

void FIOSPlatformRHIFramePacer::Resume ( )
static

Resume the frame pacer so we can enter the foreground state

◆ SetFramePace()

int32 FIOSPlatformRHIFramePacer::SetFramePace ( int32  FramePace)
static

◆ SupportsFramePace()

bool FIOSPlatformRHIFramePacer::SupportsFramePace ( int32  QueryFramePace)
static

◆ Suspend()

void FIOSPlatformRHIFramePacer::Suspend ( )
static

Suspend the frame pacer so we can enter the background state

Member Data Documentation

◆ FrameInterval

uint32 FIOSPlatformRHIFramePacer::FrameInterval = 1
static

Number of frames before the CADisplayLink triggers it's readied callback

◆ FramePacer

FIOSFramePacer * FIOSPlatformRHIFramePacer::FramePacer = nil
static

Access to the IOS Frame Pacer: CADisplayLink

◆ MinFrameInterval

uint32 FIOSPlatformRHIFramePacer::MinFrameInterval = 1
static

The minimum frame interval dictated by project settings on startup

◆ Pace

uint32 FIOSPlatformRHIFramePacer::Pace = 0
static

Frame rate we are pacing to


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