RealtimeGPUProfiler.h File Reference

#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/StaticArray.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "GpuProfilerTrace.h"
#include "HAL/CriticalSection.h"
#include "MultiGPU.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "ProfilingDebugging/CsvProfilerConfig.h"
#include "RHI.h"
#include "RHICommandList.h"
#include "RHIBreadcrumbs.h"
#include "RenderingThread.h"
#include "Stats/Stats.h"
#include "UObject/NameTypes.h"
#include <tuple>

Go to the source code of this file.

Macros
#define	WANTS_DRAW_MESH_EVENTS   (WITH_PROFILEGPU && WITH_RHI_BREADCRUMBS)
#define	RHI_BREADCRUMB_EVENT_GAMETHREAD(...)   do { } while(0)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(...)   do { } while(0)
#define	RHI_BREADCRUMB_EVENT_GAMETHREAD_F(...)   do { } while(0)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F(...)   do { } while(0)
#define	RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED(...)   do { } while(0)
#define	SCOPED_DRAW_EVENT(RHICmdList, Name)   RHI_BREADCRUMB_EVENT(RHICmdList, #Name);
#define	SCOPED_DRAW_EVENTF(RHICmdList, Name, Format, ...)   RHI_BREADCRUMB_EVENT_F_STR_DEPRECATED(RHICmdList, #Name, Format, ##__VA_ARGS__);
#define	SCOPED_CONDITIONAL_DRAW_EVENT(RHICmdList, Name, Condition)   RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name);
#define	SCOPED_CONDITIONAL_DRAW_EVENTF(RHICmdList, Name, Condition, Format, ...)   RHI_BREADCRUMB_EVENT_F_CONDITIONAL_STR_DEPRECATED(RHICmdList, Condition, #Name, Format, ##__VA_ARGS__);
#define	SCOPED_DRAW_EVENT_GAMETHREAD(Name)   UE_DEPRECATED_MACRO(5.6, "SCOPED_DRAW_EVENT_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(#Name);
#define	SCOPED_DRAW_EVENTF_GAMETHREAD(Name, Format, ...)   UE_DEPRECATED_MACRO(5.6, "SCOPED_DRAW_EVENTF_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD_F instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED(#Name, Format, ##__VA_ARGS__);
#define	SCOPED_CONDITIONAL_DRAW_EVENT_GAMETHREAD(Name, Condition)   UE_DEPRECATED_MACRO(5.6, "SCOPED_CONDITIONAL_DRAW_EVENT_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, #Name);
#define	SCOPED_CONDITIONAL_DRAW_EVENTF_GAMETHREAD(Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.6, "SCOPED_CONDITIONAL_DRAW_EVENTF_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F instead.") RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F(Condition, #Name, Format, ##__VA_ARGS__);
#define	BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbEventManual." )
#define	STOP_DRAW_EVENT(Event)   UE_DEPRECATED_MACRO(5.5, "STOP_DRAW_EVENT has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbEventManual." )
#define	STOP_DRAW_EVENT_GAMETHREAD(...)   UE_DEPRECATED_MACRO(5.5, "STOP_DRAW_EVENT_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread." )
#define	BEGIN_DRAW_EVENTF_GAMETHREAD(...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread." )
#define	BEGIN_DRAW_EVENTF_COLOR_GAMETHREAD(...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread.")
#define	SCOPED_DRAW_EVENT_COLOR(RHICmdList, Color, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)
#define	SCOPED_GPU_EVENT(RHICmdList, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)
#define	SCOPED_GPU_EVENT_COLOR(RHICmdList, Color, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)
#define	SCOPED_COMPUTE_EVENT(RHICmdList, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)
#define	SCOPED_COMPUTE_EVENT_COLOR(RHICmdList, Color, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)
#define	SCOPED_DRAW_EVENTF_COLOR(RHICmdList, Color, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)
#define	SCOPED_GPU_EVENTF(RHICmdList, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)
#define	SCOPED_GPU_EVENTF_COLOR(RHICmdList, Color, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)
#define	SCOPED_COMPUTE_EVENTF(RHICmdList, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)
#define	SCOPED_COMPUTE_EVENTF_COLOR(RHICmdList, Color, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_DRAW_EVENT_COLOR(RHICmdList, Name, Color, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)
#define	SCOPED_CONDITIONAL_GPU_EVENT(RHICmdList, Name, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)
#define	SCOPED_CONDITIONAL_GPU_EVENT_COLOR(RHICmdList, Name, Color, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)
#define	SCOPED_CONDITIONAL_COMPUTE_EVENT(RHICmdList, Name, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)
#define	SCOPED_CONDITIONAL_COMPUTE_EVENT_COLOR(RHICmdList, Name, Color, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)
#define	SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR(RHICmdList, Color, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_GPU_EVENTF(RHICmdList, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_GPU_EVENTF_COLOR(RHICmdList, Color, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_COMPUTE_EVENTF(RHICmdList, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_COMPUTE_EVENTF_COLOR(RHICmdList, Color, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)
#define	BEGIN_DRAW_EVENTF_COLOR(RHICmdList, Color, Name, Event, Format, ...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_COLOR has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)
#define	BEGIN_GPU_EVENTF(RHICmdList, Name, Event, Format, ...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_GPU_EVENTF has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)
#define	BEGIN_GPU_EVENTF_COLOR(RHICmdList, Color, Name, Event, Format, ...)   UE_DEPRECATED_MACRO(5.5, "BEGIN_GPU_EVENTF_COLOR has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)
#define	STOP_GPU_EVENT(Event)   UE_DEPRECATED_MACRO(5.5, "STOP_GPU_EVENT has been deprecated. Use STOP_DRAW_EVENT instead." ) STOP_DRAW_EVENT(Event)
#define	SCOPED_DRAW_EVENT_COLOR_GAMETHREAD(Color, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENT_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(#Name)
#define	SCOPED_DRAW_EVENTF_COLOR_GAMETHREAD(Color, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(Format, ##__VA_ARGS__)
#define	SCOPED_CONDITIONAL_DRAW_EVENT_COLOR_GAMETHREAD(Name, Color, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENT_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, #Name)
#define	SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR_GAMETHREAD(Color, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead.") RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, Format, ##__VA_ARGS__)
#define	SCOPED_RHI_DRAW_EVENT(RHICmdContext, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENT has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_DRAW_EVENTF(RHICmdContext, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENTF has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_CONDITIONAL_DRAW_EVENT(RHICmdContext, Name, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENT has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_CONDITIONAL_DRAW_EVENTF(RHICmdContext, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENTF has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_DRAW_EVENT_COLOR(RHICmdContext, Color, Name)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENT_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_DRAW_EVENTF_COLOR(RHICmdContext, Color, Name, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENTF_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_CONDITIONAL_DRAW_EVENT_COLOR(RHICmdContext, Color, Name, Condition)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENT_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )
#define	SCOPED_RHI_CONDITIONAL_DRAW_EVENTF_COLOR(RHICmdContext, Color, Name, Condition, Format, ...)   UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENTF_COLOR has been deprecated. Use standard RHI breadcrumb events instead.")
#define	DECLARE_GPU_STAT(StatName)
#define	DECLARE_GPU_STAT_NAMED(StatName, NameString)
#define	DECLARE_GPU_DRAWCALL_STAT(StatName)
#define	DECLARE_GPU_DRAWCALL_STAT_NAMED(StatName, NameString)
#define	DECLARE_GPU_DRAWCALL_STAT_EXTERN(StatName)
#define	DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN(StatName, NameString)
#define	DECLARE_GPU_STAT_NAMED_EXTERN(StatName, NameString)
#define	DEFINE_GPU_STAT(StatName)
#define	DEFINE_GPU_DRAWCALL_STAT(StatName)
#define	SCOPED_GPU_STAT_VERBOSE(RHICmdList, StatName, Description)
#define	SCOPED_GPU_STAT(RHICmdList, StatName)
#define	GPU_STATS_BEGINFRAME(RHICmdList)
#define	GPU_STATS_ENDFRAME(RHICmdList)
#define	GPU_STATS_SUSPENDFRAME()

Functions
	DECLARE_STATS_GROUP (TEXT("GPU"), STATGROUP_GPU, STATCAT_Advanced)
	CSV_DECLARE_CATEGORY_MODULE_EXTERN (RENDERCORE_API, GPU)
RENDERCORE_API bool	AreGPUStatsEnabled ()

Macro Definition Documentation

BEGIN_DRAW_EVENTF

#define BEGIN_DRAW_EVENTF	(		RHICmdList,
			Name,
			Event,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbEventManual." )

BEGIN_DRAW_EVENTF_COLOR

#define BEGIN_DRAW_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Event,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_COLOR has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)

BEGIN_DRAW_EVENTF_COLOR_GAMETHREAD

#define BEGIN_DRAW_EVENTF_COLOR_GAMETHREAD

(

...

)

UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread.")

BEGIN_DRAW_EVENTF_GAMETHREAD

#define BEGIN_DRAW_EVENTF_GAMETHREAD

(

...

)

UE_DEPRECATED_MACRO(5.5, "BEGIN_DRAW_EVENTF_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread." )

BEGIN_GPU_EVENTF

#define BEGIN_GPU_EVENTF	(		RHICmdList,
			Name,
			Event,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "BEGIN_GPU_EVENTF has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)

BEGIN_GPU_EVENTF_COLOR

#define BEGIN_GPU_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Event,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "BEGIN_GPU_EVENTF_COLOR has been deprecated. Use BEGIN_DRAW_EVENTF instead." ) BEGIN_DRAW_EVENTF(RHICmdList, Name, Event, Format, ##__VA_ARGS__)

DECLARE_GPU_DRAWCALL_STAT

#define DECLARE_GPU_DRAWCALL_STAT

(

StatName

)

DECLARE_GPU_DRAWCALL_STAT_EXTERN

#define DECLARE_GPU_DRAWCALL_STAT_EXTERN

(

StatName

)

DECLARE_GPU_DRAWCALL_STAT_NAMED

#define DECLARE_GPU_DRAWCALL_STAT_NAMED	(		StatName,
			NameString
	)

DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN

#define DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN	(		StatName,
			NameString
	)

DECLARE_GPU_STAT

#define DECLARE_GPU_STAT

(

StatName

)

DECLARE_GPU_STAT_NAMED

#define DECLARE_GPU_STAT_NAMED	(		StatName,
			NameString
	)

DECLARE_GPU_STAT_NAMED_EXTERN

#define DECLARE_GPU_STAT_NAMED_EXTERN	(		StatName,
			NameString
	)

DEFINE_GPU_DRAWCALL_STAT

#define DEFINE_GPU_DRAWCALL_STAT

(

StatName

)

DEFINE_GPU_STAT

#define DEFINE_GPU_STAT

(

StatName

)

GPU_STATS_BEGINFRAME

#define GPU_STATS_BEGINFRAME

(

RHICmdList

)

GPU_STATS_ENDFRAME

#define GPU_STATS_ENDFRAME

(

RHICmdList

)

GPU_STATS_SUSPENDFRAME

#define GPU_STATS_SUSPENDFRAME

(

)

RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD

#define RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD

(

...

)

do { } while(0)

RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F

#define RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F

(

...

)

do { } while(0)

RHI_BREADCRUMB_EVENT_GAMETHREAD

#define RHI_BREADCRUMB_EVENT_GAMETHREAD

(

...

)

do { } while(0)

RHI_BREADCRUMB_EVENT_GAMETHREAD_F

#define RHI_BREADCRUMB_EVENT_GAMETHREAD_F

(

...

)

do { } while(0)

RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED

#define RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED

(

...

)

do { } while(0)

SCOPED_COMPUTE_EVENT

#define SCOPED_COMPUTE_EVENT	(		RHICmdList,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)

SCOPED_COMPUTE_EVENT_COLOR

#define SCOPED_COMPUTE_EVENT_COLOR	(		RHICmdList,
			Color,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)

SCOPED_COMPUTE_EVENTF

#define SCOPED_COMPUTE_EVENTF	(		RHICmdList,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)

SCOPED_COMPUTE_EVENTF_COLOR

#define SCOPED_COMPUTE_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_COMPUTE_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_COMPUTE_EVENT

#define SCOPED_CONDITIONAL_COMPUTE_EVENT	(		RHICmdList,
			Name,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)

SCOPED_CONDITIONAL_COMPUTE_EVENT_COLOR

#define SCOPED_CONDITIONAL_COMPUTE_EVENT_COLOR	(		RHICmdList,
			Name,
			Color,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)

SCOPED_CONDITIONAL_COMPUTE_EVENTF

#define SCOPED_CONDITIONAL_COMPUTE_EVENTF	(		RHICmdList,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_COMPUTE_EVENTF_COLOR

#define SCOPED_CONDITIONAL_COMPUTE_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_COMPUTE_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_DRAW_EVENT

#define SCOPED_CONDITIONAL_DRAW_EVENT	(		RHICmdList,
			Name,
			Condition
	)		RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name);

SCOPED_CONDITIONAL_DRAW_EVENT_COLOR

#define SCOPED_CONDITIONAL_DRAW_EVENT_COLOR	(		RHICmdList,
			Name,
			Color,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)

SCOPED_CONDITIONAL_DRAW_EVENT_COLOR_GAMETHREAD

#define SCOPED_CONDITIONAL_DRAW_EVENT_COLOR_GAMETHREAD	(		Name,
			Color,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENT_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, #Name)

SCOPED_CONDITIONAL_DRAW_EVENT_GAMETHREAD

#define SCOPED_CONDITIONAL_DRAW_EVENT_GAMETHREAD	(		Name,
			Condition
	)		UE_DEPRECATED_MACRO(5.6, "SCOPED_CONDITIONAL_DRAW_EVENT_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, #Name);

SCOPED_CONDITIONAL_DRAW_EVENTF

#define SCOPED_CONDITIONAL_DRAW_EVENTF	(		RHICmdList,
			Name,
			Condition,
			Format,
			...
	)		RHI_BREADCRUMB_EVENT_F_CONDITIONAL_STR_DEPRECATED(RHICmdList, Condition, #Name, Format, ##__VA_ARGS__);

SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR

#define SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR_GAMETHREAD

#define SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR_GAMETHREAD	(		Color,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD instead.") RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(Condition, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_DRAW_EVENTF_GAMETHREAD

#define SCOPED_CONDITIONAL_DRAW_EVENTF_GAMETHREAD	(		Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.6, "SCOPED_CONDITIONAL_DRAW_EVENTF_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F instead.") RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F(Condition, #Name, Format, ##__VA_ARGS__);

SCOPED_CONDITIONAL_GPU_EVENT

#define SCOPED_CONDITIONAL_GPU_EVENT	(		RHICmdList,
			Name,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)

SCOPED_CONDITIONAL_GPU_EVENT_COLOR

#define SCOPED_CONDITIONAL_GPU_EVENT_COLOR	(		RHICmdList,
			Name,
			Color,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, #Name)

SCOPED_CONDITIONAL_GPU_EVENTF

#define SCOPED_CONDITIONAL_GPU_EVENTF	(		RHICmdList,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)

SCOPED_CONDITIONAL_GPU_EVENTF_COLOR

#define SCOPED_CONDITIONAL_GPU_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_CONDITIONAL_GPU_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT_CONDITIONAL instead." ) RHI_BREADCRUMB_EVENT_CONDITIONAL(RHICmdList, Condition, Format, ##__VA_ARGS__)

SCOPED_DRAW_EVENT

#define SCOPED_DRAW_EVENT	(		RHICmdList,
			Name
	)		RHI_BREADCRUMB_EVENT(RHICmdList, #Name);

SCOPED_DRAW_EVENT_COLOR

#define SCOPED_DRAW_EVENT_COLOR	(		RHICmdList,
			Color,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)

SCOPED_DRAW_EVENT_COLOR_GAMETHREAD

#define SCOPED_DRAW_EVENT_COLOR_GAMETHREAD	(		Color,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENT_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(#Name)

SCOPED_DRAW_EVENT_GAMETHREAD

#define SCOPED_DRAW_EVENT_GAMETHREAD

(

Name

)

UE_DEPRECATED_MACRO(5.6, "SCOPED_DRAW_EVENT_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(#Name);

SCOPED_DRAW_EVENTF

#define SCOPED_DRAW_EVENTF	(		RHICmdList,
			Name,
			Format,
			...
	)		RHI_BREADCRUMB_EVENT_F_STR_DEPRECATED(RHICmdList, #Name, Format, ##__VA_ARGS__);

SCOPED_DRAW_EVENTF_COLOR

#define SCOPED_DRAW_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)

SCOPED_DRAW_EVENTF_COLOR_GAMETHREAD

#define SCOPED_DRAW_EVENTF_COLOR_GAMETHREAD	(		Color,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_DRAW_EVENTF_COLOR_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD(Format, ##__VA_ARGS__)

SCOPED_DRAW_EVENTF_GAMETHREAD

#define SCOPED_DRAW_EVENTF_GAMETHREAD	(		Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.6, "SCOPED_DRAW_EVENTF_GAMETHREAD has been deprecated. Use RHI_BREADCRUMB_EVENT_GAMETHREAD_F instead." ) RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED(#Name, Format, ##__VA_ARGS__);

SCOPED_GPU_EVENT

#define SCOPED_GPU_EVENT	(		RHICmdList,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENT has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)

SCOPED_GPU_EVENT_COLOR

#define SCOPED_GPU_EVENT_COLOR	(		RHICmdList,
			Color,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENT_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, #Name)

SCOPED_GPU_EVENTF

#define SCOPED_GPU_EVENTF	(		RHICmdList,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENTF has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)

SCOPED_GPU_EVENTF_COLOR

#define SCOPED_GPU_EVENTF_COLOR	(		RHICmdList,
			Color,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_GPU_EVENTF_COLOR has been deprecated. Use RHI_BREADCRUMB_EVENT instead." ) RHI_BREADCRUMB_EVENT(RHICmdList, Format, ##__VA_ARGS__)

SCOPED_GPU_STAT

#define SCOPED_GPU_STAT	(		RHICmdList,
			StatName
	)

SCOPED_GPU_STAT_VERBOSE

#define SCOPED_GPU_STAT_VERBOSE	(		RHICmdList,
			StatName,
			Description
	)

SCOPED_RHI_CONDITIONAL_DRAW_EVENT

#define SCOPED_RHI_CONDITIONAL_DRAW_EVENT	(		RHICmdContext,
			Name,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENT has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_CONDITIONAL_DRAW_EVENT_COLOR

#define SCOPED_RHI_CONDITIONAL_DRAW_EVENT_COLOR	(		RHICmdContext,
			Color,
			Name,
			Condition
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENT_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_CONDITIONAL_DRAW_EVENTF

#define SCOPED_RHI_CONDITIONAL_DRAW_EVENTF	(		RHICmdContext,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENTF has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_CONDITIONAL_DRAW_EVENTF_COLOR

#define SCOPED_RHI_CONDITIONAL_DRAW_EVENTF_COLOR	(		RHICmdContext,
			Color,
			Name,
			Condition,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_CONDITIONAL_DRAW_EVENTF_COLOR has been deprecated. Use standard RHI breadcrumb events instead.")

SCOPED_RHI_DRAW_EVENT

#define SCOPED_RHI_DRAW_EVENT	(		RHICmdContext,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENT has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_DRAW_EVENT_COLOR

#define SCOPED_RHI_DRAW_EVENT_COLOR	(		RHICmdContext,
			Color,
			Name
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENT_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_DRAW_EVENTF

#define SCOPED_RHI_DRAW_EVENTF	(		RHICmdContext,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENTF has been deprecated. Use standard RHI breadcrumb events instead." )

SCOPED_RHI_DRAW_EVENTF_COLOR

#define SCOPED_RHI_DRAW_EVENTF_COLOR	(		RHICmdContext,
			Color,
			Name,
			Format,
			...
	)		UE_DEPRECATED_MACRO(5.5, "SCOPED_RHI_DRAW_EVENTF_COLOR has been deprecated. Use standard RHI breadcrumb events instead." )

STOP_DRAW_EVENT

#define STOP_DRAW_EVENT

(

Event

)

UE_DEPRECATED_MACRO(5.5, "STOP_DRAW_EVENT has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbEventManual." )

STOP_DRAW_EVENT_GAMETHREAD

#define STOP_DRAW_EVENT_GAMETHREAD

(

...

)

UE_DEPRECATED_MACRO(5.5, "STOP_DRAW_EVENT_GAMETHREAD has been deprecated. Equivalent functionality can be implemented by constructing / destructing an instance of FRHIBreadcrumbScope_GameThread." )

STOP_GPU_EVENT

#define STOP_GPU_EVENT

(

Event

)

UE_DEPRECATED_MACRO(5.5, "STOP_GPU_EVENT has been deprecated. Use STOP_DRAW_EVENT instead." ) STOP_DRAW_EVENT(Event)

WANTS_DRAW_MESH_EVENTS

#define WANTS_DRAW_MESH_EVENTS   (WITH_PROFILEGPU && WITH_RHI_BREADCRUMBS)

Function Documentation

AreGPUStatsEnabled()

RENDERCORE_API bool AreGPUStatsEnabled

(

)

CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN	(	RENDERCORE_API	,
		GPU
	)

DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP	(	TEXT("GPU")	,
		STATGROUP_GPU	,
		STATCAT_Advanced
	)