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

#include <GenericPlatformFramePacer.h>

+ Inheritance diagram for FGenericPlatformRHIFramePacer:

Static Public Member Functions

static int32 GetFramePace ()
 
static int32 SetFramePace (int32 FramePace)
 
static APPLICATIONCORE_API bool SupportsFramePace (int32 QueryFramePace)
 

Static Protected Member Functions

static APPLICATIONCORE_API int32 GetFramePaceFromSyncInterval ()
 
static APPLICATIONCORE_API int32 SetFramePaceToSyncInterval (int32 FramePace)
 

Detailed Description

Generic implementation for most platforms

Member Function Documentation

◆ GetFramePace()

static int32 FGenericPlatformRHIFramePacer::GetFramePace ( )
inlinestatic

The pace we are running at (30 = 30fps, 0 = unpaced) The generic implementation returns a result based on rhi.SyncInterval and FPlatformMisc::GetMaxRefreshRate().

◆ GetFramePaceFromSyncInterval()

int32 FGenericPlatformRHIFramePacer::GetFramePaceFromSyncInterval ( )
staticprotected

The generic implementation returns a result based on rhi.SyncInterval and FPlatformMisc::GetMaxRefreshRate().

◆ SetFramePace()

static int32 FGenericPlatformRHIFramePacer::SetFramePace ( int32  FramePace)
inlinestatic

Sets the pace we would like to running at (30 = 30fps, 0 = unpaced). The generic implementation sets the value for rhi.SyncInterval according to FPlatformMisc::GetMaxRefreshRate().

Returns
the pace we will run at.

◆ SetFramePaceToSyncInterval()

int32 FGenericPlatformRHIFramePacer::SetFramePaceToSyncInterval ( int32  FramePace)
staticprotected

The generic implementation sets rhi.SyncInterval based on FPlatformMisc::GetMaxRefreshRate().

Returns
the pace we will run at.

◆ SupportsFramePace()

bool FGenericPlatformRHIFramePacer::SupportsFramePace ( int32  QueryFramePace)
static

Returns whether the hardware is able to frame pace at the specified frame rate

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