FGPUProfiler

Encapsulates GPU profiling logic and data.

Windows
MacOS
Linux

Inheritance Hierarchy

FGPUProfiler

FOpenGLGPUProfiler

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/GPUProfiler.h

Include

#include "GPUProfiler.h"

Syntax

struct FGPUProfiler

Remarks

Encapsulates GPU profiling logic and data. There's only one global instance of this struct so it should only contain global data, nothing specific to a frame.

Variables

Name Description

Public variable

bool

 

bLatchedGProfilingGPU

A latched version of GTriggerGPUProfile.

Public variable

bool

 

bLatchedGProfilingGPUHitches

A latched version of GTriggerGPUHitchProfile.

Public variable

bool

 

bOriginalGEmitDrawEvents

Original state of GEmitDrawEvents before it was overridden for profiling.

Public variable

bool

 

bPreviousLatchedGProfilingGPUHitches

The previous latched version of GTriggerGPUHitchProfile.

Public variable

bool

 

bTrackingEvents

Whether we are currently tracking perf events or not.

Public variable

bool

 

bTrackingGPUCrashData

Whether we are currently tracking data for gpucrash debugging or not

Public variable

FGPUProfilerEve...

 

CurrentEventNode

Current perf event node.

Public variable

FGPUProfilerEve...

 

CurrentEventNodeFrame

Current perf event node frame.

Public variable

int32

 

GPUCrashDataDepth

Scope depth to record crash data depth. to limit perf/mem requirements

Public variable

int32

 

GPUHitchDebounce

GPU hitch profile history debounce...after a hitch, we just ignore frames for a while

Public variable

int32

 

StackDepth

Constructors

Name Description

Public function

FGPUProfiler()

Destructors

Name Description

Public function Virtual

~FGPUProfiler()

Functions

Name Description

Public function Virtual

FGPUProfiler...

 

CreateEventNode

(
    const TCHAR* InName,
    FGPUProfilerEventNode* InParen...
)

Public function Virtual

void

 

PopEvent()

Public function Virtual

void

 

PushEvent

(
    const TCHAR* Name,
    FColor Color
)

Public function

void

 

RegisterGPUDispatch

(
    FIntVector GroupCount
)

Public function

void

 

RegisterGPUWork

(
    uint32 NumPrimitives,
    uint32 NumVertices
)

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