UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMetalProfiler Class Reference

#include <MetalProfiler.h>

+ Inheritance diagram for FMetalProfiler:

Public Member Functions

 FMetalProfiler (FMetalRHICommandContext &InContext)
 
 ~FMetalProfiler ()
 
void BeginCapture (int InNumFramesToCapture=-1)
 
void EndCapture ()
 
bool TracingEnabled () const
 
void BeginFrame ()
 
void EndFrame ()
 
void AddDisplayVBlank (uint32 DisplayID, double OutputSeconds, double OutputDuration)
 
void EncodeDraw (FMetalCommandBufferStats *CmdBufStats, char const *DrawCall, uint32 RHIPrimitives, uint32 RHIVertices, uint32 RHIInstances)
 
void EncodeBlit (FMetalCommandBufferStats *CmdBufStats, char const *DrawCall)
 
void EncodeBlit (FMetalCommandBufferStats *CmdBufStats, FString DrawCall)
 
void EncodeDispatch (FMetalCommandBufferStats *CmdBufStats, char const *DrawCall)
 
FMetalCPUStatsAddCPUStat (FString const &Name)
 
FMetalCommandBufferStatsAllocateCommandBuffer (MTL::CommandBuffer *CommandBuffer, uint64 GPUThreadIndex)
 
void AddCommandBuffer (FMetalCommandBufferStats *CommandBuffer)
 
virtual void PushEvent (const TCHAR *Name, FColor Color) final override
 
virtual void PopEvent () final override
 
void SaveTrace ()
 
- Public Member Functions inherited from FMetalGPUProfiler
 FMetalGPUProfiler (FMetalRHICommandContext &InContext)
 
virtual ~FMetalGPUProfiler ()
 
virtual FGPUProfilerEventNode * CreateEventNode (const TCHAR *InName, FGPUProfilerEventNode *InParent) override
 
void Cleanup ()
 
void BeginFrame ()
 
void EndFrame ()
 

Static Public Member Functions

static FMetalProfilerCreateProfiler (FMetalRHICommandContext &InContext)
 
static FMetalProfilerGetProfiler ()
 
static void DestroyProfiler ()
 

Additional Inherited Members

- Public Attributes inherited from FMetalGPUProfiler
TIndirectArray< FMetalEventNodeFrameGPUHitchEventNodeFrames
 
FMetalGPUTiming TimingSupport
 
FMetalRHICommandContextContext
 

Constructor & Destructor Documentation

◆ FMetalProfiler()

FMetalProfiler::FMetalProfiler ( FMetalRHICommandContext InContext)

◆ ~FMetalProfiler()

FMetalProfiler::~FMetalProfiler ( )

Member Function Documentation

◆ AddCommandBuffer()

void FMetalProfiler::AddCommandBuffer ( FMetalCommandBufferStats CommandBuffer)

◆ AddCPUStat()

FMetalCPUStats * FMetalProfiler::AddCPUStat ( FString const &  Name)

◆ AddDisplayVBlank()

void FMetalProfiler::AddDisplayVBlank ( uint32  DisplayID,
double  OutputSeconds,
double  OutputDuration 
)

◆ AllocateCommandBuffer()

FMetalCommandBufferStats * FMetalProfiler::AllocateCommandBuffer ( MTL::CommandBuffer *  CommandBuffer,
uint64  GPUThreadIndex 
)

◆ BeginCapture()

void FMetalProfiler::BeginCapture ( int  InNumFramesToCapture = -1)

◆ BeginFrame()

void FMetalProfiler::BeginFrame ( )

◆ CreateProfiler()

FMetalProfiler * FMetalProfiler::CreateProfiler ( FMetalRHICommandContext InContext)
static

◆ DestroyProfiler()

void FMetalProfiler::DestroyProfiler ( )
static

◆ EncodeBlit() [1/2]

void FMetalProfiler::EncodeBlit ( FMetalCommandBufferStats CmdBufStats,
char const *  DrawCall 
)

◆ EncodeBlit() [2/2]

void FMetalProfiler::EncodeBlit ( FMetalCommandBufferStats CmdBufStats,
FString  DrawCall 
)

◆ EncodeDispatch()

void FMetalProfiler::EncodeDispatch ( FMetalCommandBufferStats CmdBufStats,
char const *  DrawCall 
)

◆ EncodeDraw()

void FMetalProfiler::EncodeDraw ( FMetalCommandBufferStats CmdBufStats,
char const *  DrawCall,
uint32  RHIPrimitives,
uint32  RHIVertices,
uint32  RHIInstances 
)

◆ EndCapture()

void FMetalProfiler::EndCapture ( )

◆ EndFrame()

void FMetalProfiler::EndFrame ( )

◆ GetProfiler()

FMetalProfiler * FMetalProfiler::GetProfiler ( )
static

◆ PopEvent()

void FMetalProfiler::PopEvent ( )
finaloverridevirtual

Reimplemented from FMetalGPUProfiler.

◆ PushEvent()

void FMetalProfiler::PushEvent ( const TCHAR Name,
FColor  Color 
)
finaloverridevirtual

Reimplemented from FMetalGPUProfiler.

◆ SaveTrace()

void FMetalProfiler::SaveTrace ( )

◆ TracingEnabled()

bool FMetalProfiler::TracingEnabled ( ) const

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