UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Trace.h File Reference
#include "Trace/Config.h"
#include "Misc/Launder.h"
#include "Misc/CoreMiscDefines.h"
#include <type_traits>

Go to the source code of this file.

Namespaces

namespace  UE
 
namespace  UE::Trace
 

Macros

#define TRACE_PRIVATE_EXPAND(x)   x
 
#define TRACE_PRIVATE_NOP_CHANNEL(ChannelName, ...)
 
#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM(ChannelName, ChannelClass, ...)
 
#define TRACE_PRIVATE_NOP_CHANNEL_EXTERN(ChannelName, ...)
 
#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_EXTERN(ChannelName, ChannelClass, ...)
 
#define TRACE_PRIVATE_NOP_CHANNEL_DEFINE(ChannelName, ...)
 
#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_DEFINE(ChannelName, ChannelClass, ...)
 
#define TRACE_PRIVATE_NOP_CHANNELEXPR_IS_ENABLED(ChannelsExpr)    false
 
#define TRACE_PRIVATE_NOP_EVENT_DEFINE(LoggerName, EventName)    int8* LoggerName##EventName##DummyPtr = nullptr;
 
#define TRACE_PRIVATE_NOP_EVENT_BEGIN(LoggerName, EventName, ...)    TRACE_PRIVATE_NOP_EVENT_BEGIN_IMPL(LoggerName, EventName)
 
#define TRACE_PRIVATE_NOP_EVENT_BEGIN_EXTERN(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_EVENT_BEGIN_IMPL(LoggerName, EventName)
 
#define TRACE_PRIVATE_NOP_EVENT_FIELD(FieldType, FieldName)    const FTraceDisabled& FieldName;
 
#define TRACE_PRIVATE_NOP_EVENT_REFFIELD(RefLogger, RefEventType, FieldName)    const FTraceDisabled& FieldName;
 
#define TRACE_PRIVATE_NOP_EVENT_END()    };
 
#define TRACE_PRIVATE_NOP_LOG(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_LOG_SCOPED(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_LOG_SCOPED_CONDITIONAL(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_LOG_SCOPED_T(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_LOG_SCOPED_T_CONDITIONAL(LoggerName, EventName, ...)
 
#define TRACE_PRIVATE_NOP_GET_DEFINITION_TYPE_ID(LoggerName, EventName)    0
 
#define TRACE_PRIVATE_NOP_LOG_DEFINITION(LoggerName, EventName, Id, ChannelsExpr, ...)
 

Macro Definition Documentation

◆ TRACE_PRIVATE_EXPAND

#define TRACE_PRIVATE_EXPAND (   x)    x

◆ TRACE_PRIVATE_NOP_CHANNEL

#define TRACE_PRIVATE_NOP_CHANNEL (   ChannelName,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNEL_CUSTOM

#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM (   ChannelName,
  ChannelClass,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_DEFINE

#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_DEFINE (   ChannelName,
  ChannelClass,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_EXTERN

#define TRACE_PRIVATE_NOP_CHANNEL_CUSTOM_EXTERN (   ChannelName,
  ChannelClass,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNEL_DEFINE

#define TRACE_PRIVATE_NOP_CHANNEL_DEFINE (   ChannelName,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNEL_EXTERN

#define TRACE_PRIVATE_NOP_CHANNEL_EXTERN (   ChannelName,
  ... 
)

◆ TRACE_PRIVATE_NOP_CHANNELEXPR_IS_ENABLED

#define TRACE_PRIVATE_NOP_CHANNELEXPR_IS_ENABLED (   ChannelsExpr)     false

◆ TRACE_PRIVATE_NOP_EVENT_BEGIN

#define TRACE_PRIVATE_NOP_EVENT_BEGIN (   LoggerName,
  EventName,
  ... 
)     TRACE_PRIVATE_NOP_EVENT_BEGIN_IMPL(LoggerName, EventName)

◆ TRACE_PRIVATE_NOP_EVENT_BEGIN_EXTERN

#define TRACE_PRIVATE_NOP_EVENT_BEGIN_EXTERN (   LoggerName,
  EventName,
  ... 
)
Value:
extern int8* LoggerName##EventName##DummyPtr; \
FPlatformTypes::int8 int8
An 8-bit signed integer.
Definition Platform.h:1121
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ TRACE_PRIVATE_NOP_EVENT_BEGIN_IMPL

#define TRACE_PRIVATE_NOP_EVENT_BEGIN_IMPL (   LoggerName,
  EventName 
)
Value:
struct F##LoggerName##EventName##Dummy \
{ \
enum \
{ \
NoSync, \
}; \
struct FTraceDisabled \
{ \
const FTraceDisabled& operator () (...) const { return *this; } \
}; \
const F##LoggerName##EventName##Dummy& operator << (const FTraceDisabled&) const \
{ \
return *this; \
} \
explicit operator bool () const { return false; }
FArchive & operator<<(FArchive &Ar, FEnvQueryDebugProfileData::FStep &Data)
Definition EnvQueryTypes.cpp:489
const bool
Definition NetworkReplayStreaming.h:178

◆ TRACE_PRIVATE_NOP_EVENT_DEFINE

#define TRACE_PRIVATE_NOP_EVENT_DEFINE (   LoggerName,
  EventName 
)     int8* LoggerName##EventName##DummyPtr = nullptr;

◆ TRACE_PRIVATE_NOP_EVENT_END

#define TRACE_PRIVATE_NOP_EVENT_END ( )     };

◆ TRACE_PRIVATE_NOP_EVENT_FIELD

#define TRACE_PRIVATE_NOP_EVENT_FIELD (   FieldType,
  FieldName 
)     const FTraceDisabled& FieldName;

◆ TRACE_PRIVATE_NOP_EVENT_REFFIELD

#define TRACE_PRIVATE_NOP_EVENT_REFFIELD (   RefLogger,
  RefEventType,
  FieldName 
)     const FTraceDisabled& FieldName;

◆ TRACE_PRIVATE_NOP_GET_DEFINITION_TYPE_ID

#define TRACE_PRIVATE_NOP_GET_DEFINITION_TYPE_ID (   LoggerName,
  EventName 
)     0

◆ TRACE_PRIVATE_NOP_LOG

#define TRACE_PRIVATE_NOP_LOG (   LoggerName,
  EventName,
  ... 
)
Value:
if (const auto& EventName = *(F##LoggerName##EventName##Dummy*)1) \
EventName

◆ TRACE_PRIVATE_NOP_LOG_DEFINITION

#define TRACE_PRIVATE_NOP_LOG_DEFINITION (   LoggerName,
  EventName,
  Id,
  ChannelsExpr,
  ... 
)
Value:
TEventRef< IdType > MakeEventRef(IdType InId, uint32 InTypeId)
Definition Trace.h:92

◆ TRACE_PRIVATE_NOP_LOG_SCOPED

#define TRACE_PRIVATE_NOP_LOG_SCOPED (   LoggerName,
  EventName,
  ... 
)
Value:
if (const auto& EventName = *(F##LoggerName##EventName##Dummy*)1) \
EventName

◆ TRACE_PRIVATE_NOP_LOG_SCOPED_CONDITIONAL

#define TRACE_PRIVATE_NOP_LOG_SCOPED_CONDITIONAL (   LoggerName,
  EventName,
  ... 
)
Value:
if (const auto& EventName = *(F##LoggerName##EventName##Dummy*)1) \
EventName

◆ TRACE_PRIVATE_NOP_LOG_SCOPED_T

#define TRACE_PRIVATE_NOP_LOG_SCOPED_T (   LoggerName,
  EventName,
  ... 
)
Value:
if (const auto& EventName = *(F##LoggerName##EventName##Dummy*)1) \
EventName

◆ TRACE_PRIVATE_NOP_LOG_SCOPED_T_CONDITIONAL

#define TRACE_PRIVATE_NOP_LOG_SCOPED_T_CONDITIONAL (   LoggerName,
  EventName,
  ... 
)
Value:
if (const auto& EventName = *(F##LoggerName##EventName##Dummy*)1) \
EventName