FGenericPlatformRHIFramePacer

Generic implementation for most platforms, these tend to be unused and unimplemented

Windows
MacOS
Linux

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformFramePacer.h

Include

#include "GenericPlatform/GenericPlatformFramePacer.h"

Syntax

struct FGenericPlatformRHIFramePacer

Remarks

Generic implementation for most platforms, these tend to be unused and unimplemented

Functions

Name Description

Public function Static

void

 

Destroy()

Teardown the Frame Pacer.

Public function Static

int32

 

GetFramePace()

The pace we are running at (30 = 30fps, 0 = unpaced) The generic implementation returns a result based on rhi.SyncInterval assuming a 60Hz native refresh rate.

Protected function Static

int32

 

GetFramePaceFromSyncInterval()

The generic implementation returns a result based on rhi.SyncInterval assuming a 60Hz native refresh rate.

Public function

bool

 

IsEnabled()

Should the Frame Pacer be enabled?

Public function Static

int32

 

SetFramePace

(
    int32 FramePace
)

Sets the pace we would like to running at (30 = 30fps, 0 = unpaced).

Protected function Static

int32

 

SetFramePaceToSyncInterval

(
    int32 FramePace
)

The generic sets rhi.SyncInterval assuming a 60Hz native refresh rate.

Public function Static

bool

 

SupportsFramePace

(
    int32 QueryFramePace
)

Rethers whether the hardware is able to frame pace at the specificed frame rate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss