RHIBreadcrumbs.h File Reference

#include "Misc/Build.h"
#include "Misc/MemStack.h"
#include "HAL/Platform.h"
#include "Templates/SharedPointer.h"
#include "ProfilingDebugging/CpuProfilerTrace.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "GenericPlatform/GenericPlatformCrashContext.h"
#include "GpuProfilerTrace.h"
#include "RHIFwd.h"
#include "RHIPipeline.h"
#include "MultiGPU.h"
#include <array>

Go to the source code of this file.

Macros
#define	WITH_RHI_BREADCRUMBS   (UE_BUILD_DEBUG || UE_BUILD_DEVELOPMENT || WITH_PROFILEGPU || (HAS_GPU_STATS && RHI_NEW_GPU_PROFILER))
#define	WITH_RHI_BREADCRUMBS_FULL   (WITH_RHI_BREADCRUMBS && (UE_BUILD_DEBUG || UE_BUILD_DEVELOPMENT || WITH_PROFILEGPU))
#define	WITH_RHI_BREADCRUMBS_MINIMAL   (WITH_RHI_BREADCRUMBS && (!WITH_RHI_BREADCRUMBS_FULL))
#define	RHI_BREADCRUMBS_EMIT_CPU   (WITH_RHI_BREADCRUMBS_FULL && CPUPROFILERTRACE_ENABLED && 1)
#define	RHI_BREADCRUMBS_EMIT_LOCATION   (WITH_RHI_BREADCRUMBS_FULL && (CPUPROFILERTRACE_ENABLED || GPUPROFILERTRACE_ENABLED) && 1)
#define	RHI_BREADCRUMB_FIELD( ...)
#define	RHI_BREADCRUMB_EVENT( ...)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL( ...)
#define	RHI_BREADCRUMB_EVENT_STAT( ...)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT( ...)
#define	RHI_BREADCRUMB_EVENT_F( ...)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL_F( ...)
#define	RHI_BREADCRUMB_EVENT_STAT_F( ...)
#define	RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT_F( ...)
#define	RHI_BREADCRUMB_EVENT_F_STR_DEPRECATED( ...)
#define	RHI_BREADCRUMB_EVENT_F_CONDITIONAL_STR_DEPRECATED(...)
#define	RHI_BREADCRUMB_LOG( RHICmdList_Or_RHIContext, CategoryName, Verbosity, Format, ...)   UE_LOG( CategoryName, Verbosity, Format, ##__VA_ARGS__)
#define	RHI_BREADCRUMB_CLOG( RHICmdList_Or_RHIContext, Condition, CategoryName, Verbosity, Format, ...)   UE_CLOG(Condition, CategoryName, Verbosity, Format, ##__VA_ARGS__)
#define	RHI_BREADCRUMB_CHECKF(RHICmdList_Or_RHIContext, Condition, Format, ...)   checkf( Condition, Format, ##__VA_ARGS__)
#define	RHI_BREADCRUMB_CHECK_SHIPPINGF(RHICmdList_Or_RHIContext, Condition, Format, ...)   RHI_BREADCRUMB_CLOG(RHICmdList_Or_RHIContext, !(Condition), LogRHI, Error, TEXT("Check '%s' failed. ") Format, TEXT(#Condition), ##__VA_ARGS__)
#define	RHI_BREADCRUMB_CHECK_SHIPPING(RHICmdList_Or_RHIContext, Condition)   RHI_BREADCRUMB_CHECK_SHIPPINGF(RHICmdList_Or_RHIContext, Condition, TEXT(""))
#define	RHI_BREADCRUMB_CHECK( RHICmdList_Or_RHIContext, Condition)   RHI_BREADCRUMB_CHECKF( RHICmdList_Or_RHIContext, Condition, TEXT(""))
#define	RHI_BREADCRUMB_FORCE_STRING_LITERAL

Macro Definition Documentation

RHI_BREADCRUMB_CHECK

#define RHI_BREADCRUMB_CHECK	(		RHICmdList_Or_RHIContext,
			Condition
	)		RHI_BREADCRUMB_CHECKF( RHICmdList_Or_RHIContext, Condition, TEXT(""))

RHI_BREADCRUMB_CHECK_SHIPPING

#define RHI_BREADCRUMB_CHECK_SHIPPING	(		RHICmdList_Or_RHIContext,
			Condition
	)		RHI_BREADCRUMB_CHECK_SHIPPINGF(RHICmdList_Or_RHIContext, Condition, TEXT(""))

RHI_BREADCRUMB_CHECK_SHIPPINGF

#define RHI_BREADCRUMB_CHECK_SHIPPINGF	(		RHICmdList_Or_RHIContext,
			Condition,
			Format,
			...
	)		RHI_BREADCRUMB_CLOG(RHICmdList_Or_RHIContext, !(Condition), LogRHI, Error, TEXT("Check '%s' failed. ") Format, TEXT(#Condition), ##__VA_ARGS__)

RHI_BREADCRUMB_CHECKF

#define RHI_BREADCRUMB_CHECKF	(		RHICmdList_Or_RHIContext,
			Condition,
			Format,
			...
	)		checkf( Condition, Format, ##__VA_ARGS__)

RHI_BREADCRUMB_CLOG

#define RHI_BREADCRUMB_CLOG	(		RHICmdList_Or_RHIContext,
			Condition,
			CategoryName,
			Verbosity,
			Format,
			...
	)		UE_CLOG(Condition, CategoryName, Verbosity, Format, ##__VA_ARGS__)

RHI_BREADCRUMB_EVENT

#define RHI_BREADCRUMB_EVENT

(

...

)

RHI_BREADCRUMB_EVENT_CONDITIONAL

#define RHI_BREADCRUMB_EVENT_CONDITIONAL

(

...

)

RHI_BREADCRUMB_EVENT_CONDITIONAL_F

#define RHI_BREADCRUMB_EVENT_CONDITIONAL_F

(

...

)

RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT

#define RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT

(

...

)

RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT_F

#define RHI_BREADCRUMB_EVENT_CONDITIONAL_STAT_F

(

...

)

RHI_BREADCRUMB_EVENT_F

#define RHI_BREADCRUMB_EVENT_F

(

...

)

RHI_BREADCRUMB_EVENT_F_CONDITIONAL_STR_DEPRECATED

#define RHI_BREADCRUMB_EVENT_F_CONDITIONAL_STR_DEPRECATED

(

...

)

RHI_BREADCRUMB_EVENT_F_STR_DEPRECATED

#define RHI_BREADCRUMB_EVENT_F_STR_DEPRECATED

(

...

)

RHI_BREADCRUMB_EVENT_STAT

#define RHI_BREADCRUMB_EVENT_STAT

(

...

)

RHI_BREADCRUMB_EVENT_STAT_F

#define RHI_BREADCRUMB_EVENT_STAT_F

(

...

)

RHI_BREADCRUMB_FIELD

#define RHI_BREADCRUMB_FIELD

(

...

)

RHI_BREADCRUMB_FORCE_STRING_LITERAL

#define RHI_BREADCRUMB_FORCE_STRING_LITERAL

Value:

    [](auto&& TCharPointer) -> TCHAR const(&)[1]\
    {                                                                                   \
        return *reinterpret_cast<TCHAR const(*)[1]>(TCharPointer);                      \
    }

RHI_BREADCRUMB_LOG

#define RHI_BREADCRUMB_LOG	(		RHICmdList_Or_RHIContext,
			CategoryName,
			Verbosity,
			Format,
			...
	)		UE_LOG( CategoryName, Verbosity, Format, ##__VA_ARGS__)

RHI_BREADCRUMBS_EMIT_CPU

#define RHI_BREADCRUMBS_EMIT_CPU   (WITH_RHI_BREADCRUMBS_FULL && CPUPROFILERTRACE_ENABLED && 1)

RHI_BREADCRUMBS_EMIT_LOCATION

#define RHI_BREADCRUMBS_EMIT_LOCATION   (WITH_RHI_BREADCRUMBS_FULL && (CPUPROFILERTRACE_ENABLED || GPUPROFILERTRACE_ENABLED) && 1)

WITH_RHI_BREADCRUMBS

#define WITH_RHI_BREADCRUMBS   (UE_BUILD_DEBUG || UE_BUILD_DEVELOPMENT || WITH_PROFILEGPU || (HAS_GPU_STATS && RHI_NEW_GPU_PROFILER))

WITH_RHI_BREADCRUMBS_FULL

#define WITH_RHI_BREADCRUMBS_FULL   (WITH_RHI_BREADCRUMBS && (UE_BUILD_DEBUG || UE_BUILD_DEVELOPMENT || WITH_PROFILEGPU))

WITH_RHI_BREADCRUMBS_MINIMAL

#define WITH_RHI_BREADCRUMBS_MINIMAL   (WITH_RHI_BREADCRUMBS && (!WITH_RHI_BREADCRUMBS_FULL))