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

#include <PlatformEvents.h>

Public Types

enum class  EEventType { None = 0x00 , ContextSwitch = 0x01 , StackSampling = 0x02 }
 

Static Public Member Functions

static CORE_API EEventType GetEvent (const FString &Name)
 
static void Init (uint32 SamplingIntervalUsec)
 
static void PostInit ()
 
static void Enable (EEventType Event)
 
static void Disable (EEventType Event)
 
static void Stop ()
 
static void OnTraceChannelUpdated (const FString &ChannelName, bool bIsEnabled)
 
static void OutputContextSwitch (uint64 StartTime, uint64 EndTime, uint32 ThreadId, uint8 CoreNumber)
 
static void OutputStackSample (uint64 Time, uint32 ThreadId, const uint64 *Addresses, uint32 AddressCount)
 
static void OutputThreadName (uint32 ThreadId, uint32 ProcessId, const TCHAR *Name, uint32 NameLen)
 

Member Enumeration Documentation

◆ EEventType

Enumerator
None 
ContextSwitch 
StackSampling 

Member Function Documentation

◆ Disable()

static void FPlatformEventsTrace::Disable ( EEventType  Event)
inlinestatic

◆ Enable()

static void FPlatformEventsTrace::Enable ( EEventType  Event)
inlinestatic

◆ GetEvent()

static CORE_API EEventType FPlatformEventsTrace::GetEvent ( const FString &  Name)
static

◆ Init()

static void FPlatformEventsTrace::Init ( uint32  SamplingIntervalUsec)
inlinestatic

◆ OnTraceChannelUpdated()

static void FPlatformEventsTrace::OnTraceChannelUpdated ( const FString &  ChannelName,
bool  bIsEnabled 
)
inlinestatic

◆ OutputContextSwitch()

static void FPlatformEventsTrace::OutputContextSwitch ( uint64  StartTime,
uint64  EndTime,
uint32  ThreadId,
uint8  CoreNumber 
)
inlinestatic

◆ OutputStackSample()

static void FPlatformEventsTrace::OutputStackSample ( uint64  Time,
uint32  ThreadId,
const uint64 Addresses,
uint32  AddressCount 
)
inlinestatic

◆ OutputThreadName()

static void FPlatformEventsTrace::OutputThreadName ( uint32  ThreadId,
uint32  ProcessId,
const TCHAR Name,
uint32  NameLen 
)
inlinestatic

◆ PostInit()

static void FPlatformEventsTrace::PostInit ( )
inlinestatic

◆ Stop()

static void FPlatformEventsTrace::Stop ( )
inlinestatic

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