PlatformMisc.h File Reference

#include "CoreTypes.h"
#include "GenericPlatform/GenericPlatformMisc.h"
#include "ProfilingDebugging/CpuProfilerTrace.h"

Go to the source code of this file.

Classes
class	FScopedNamedEventConditional
class	FScopedNamedEvent
class	FScopedNamedEventStatic
class	FScopedNamedEventConditionalStatic
class	FScopedEnterBackgroundEvent

Macros
#define	PLATFORM_LIMIT_PROFILER_UNIQUE_NAMED_EVENTS   0
#define	PLATFORM_EMPTY_BASES
#define	ALLOW_NAMED_EVENTS_IN_TEST   1
#define	ENABLE_NAMED_EVENTS   (!UE_BUILD_SHIPPING && (!UE_BUILD_TEST || ALLOW_NAMED_EVENTS_IN_TEST))
#define	NAMED_EVENT_STR(x)   TEXT(x)
#define	SCOPED_NAMED_EVENT(Name, Color)
#define	SCOPED_NAMED_EVENT_FSTRING(Text, Color)
#define	SCOPED_NAMED_EVENT_TCHAR(Text, Color)
#define	SCOPED_NAMED_EVENT_TEXT(Text, Color)
#define	SCOPED_NAMED_EVENT_F(Format, Color, ...)
#define	SCOPED_NAMED_EVENT_TCHAR_CONDITIONAL(Text, Color, bCondition)
#define	SCOPED_PROFILER_COLOR(...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_PROFILER_COLOR is deprecated and there is no replacement.")
#define	SCOPED_ENTER_BACKGROUND_EVENT(Name)
#define	IWYU_MARKUP_IMPLICIT_CAST(From, To)

Macro Definition Documentation

ALLOW_NAMED_EVENTS_IN_TEST

#define ALLOW_NAMED_EVENTS_IN_TEST   1

ENABLE_NAMED_EVENTS

#define ENABLE_NAMED_EVENTS   (!UE_BUILD_SHIPPING && (!UE_BUILD_TEST || ALLOW_NAMED_EVENTS_IN_TEST))

IWYU_MARKUP_IMPLICIT_CAST

#define IWYU_MARKUP_IMPLICIT_CAST	(		From,
			To
	)

NAMED_EVENT_STR

#define NAMED_EVENT_STR

(

x

)

TEXT(x)

PLATFORM_EMPTY_BASES

#define PLATFORM_EMPTY_BASES

PLATFORM_LIMIT_PROFILER_UNIQUE_NAMED_EVENTS

#define PLATFORM_LIMIT_PROFILER_UNIQUE_NAMED_EVENTS   0

SCOPED_ENTER_BACKGROUND_EVENT

#define SCOPED_ENTER_BACKGROUND_EVENT

(

Name

)

Value:

    FScopedEnterBackgroundEvent EnterBackgroundEvent_##Name##_(TEXT(#Name)); \
	QUICK_SCOPE_CYCLE_COUNTER(Name);

SCOPED_NAMED_EVENT

#define SCOPED_NAMED_EVENT	(		Name,
			Color
	)

Value:

    FScopedNamedEventStatic ANONYMOUS_VARIABLE(NamedEvent_##Name##_)(Color, NAMED_EVENT_STR(#Name));\
	TRACE_CPUPROFILER_EVENT_SCOPE(Name);

SCOPED_NAMED_EVENT_F

#define SCOPED_NAMED_EVENT_F	(		Format,
			Color,
			...
	)

Value:

    FScopedNamedEvent ANONYMOUS_VARIABLE(NamedEvent_)(Color, *FString::Printf(Format, __VA_ARGS__));\
	TRACE_CPUPROFILER_EVENT_SCOPE_TEXT(*FString::Printf(Format, __VA_ARGS__));

SCOPED_NAMED_EVENT_FSTRING

#define SCOPED_NAMED_EVENT_FSTRING	(		Text,
			Color
	)

Value:

    FScopedNamedEvent ANONYMOUS_VARIABLE(NamedEvent_)(Color, *Text);\
	TRACE_CPUPROFILER_EVENT_SCOPE_TEXT(*Text);

SCOPED_NAMED_EVENT_TCHAR

#define SCOPED_NAMED_EVENT_TCHAR	(		Text,
			Color
	)

Value:

    FScopedNamedEvent ANONYMOUS_VARIABLE(NamedEvent_)(Color, Text);\
	TRACE_CPUPROFILER_EVENT_SCOPE_TEXT(Text);

SCOPED_NAMED_EVENT_TCHAR_CONDITIONAL

#define SCOPED_NAMED_EVENT_TCHAR_CONDITIONAL	(		Text,
			Color,
			bCondition
	)

Value:

    FScopedNamedEventConditional ANONYMOUS_VARIABLE(NamedEvent_)(Color, Text, (bCondition));\
	TRACE_CPUPROFILER_EVENT_SCOPE_TEXT_CONDITIONAL(Text, (bCondition));

SCOPED_NAMED_EVENT_TEXT

#define SCOPED_NAMED_EVENT_TEXT	(		Text,
			Color
	)

Value:

    FScopedNamedEventStatic ANONYMOUS_VARIABLE(NamedEvent_)(Color, NAMED_EVENT_STR(Text));\
	TRACE_CPUPROFILER_EVENT_SCOPE_STR(Text);

SCOPED_PROFILER_COLOR

#define SCOPED_PROFILER_COLOR

(

...

)

UE_DEPRECATED_MACRO(5.5, "SCOPED_PROFILER_COLOR is deprecated and there is no replacement.")