RealtimeGPUProfiler_8h_source.html

// Copyright Epic Games, Inc. All Rights Reserved.


#pragma once


#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>


#define WANTS_DRAW_MESH_EVENTS (WITH_PROFILEGPU && WITH_RHI_BREADCRUMBS)


#if WITH_RHI_BREADCRUMBS


    struct FRHIBreadcrumbScope_GameThread

    {

    private:

        TOptional<FRHIBreadcrumbScope>* Event;


    public:

        template <typename TDesc, typename... TValues>

        FRHIBreadcrumbScope_GameThread(TRHIBreadcrumbInitializer<TDesc, TValues...>&& Args)

            : Event(new TOptional<FRHIBreadcrumbScope>)

        {

            check(IsInGameThread());


            ENQUEUE_RENDER_COMMAND(FRHIBreadcrumbScope_GameThread_Begin)(

            [

                Event = Event,

                Args = MoveTemp(Args)

            ](FRHICommandListImmediate& RHICmdList) mutable

            {

                Event->Emplace(RHICmdList, MoveTemp(Args));

            });

        }


        ~FRHIBreadcrumbScope_GameThread()

        {

            check(IsInGameThread());


            ENQUEUE_RENDER_COMMAND(FRHIBreadcrumbScope_GameThread_End)([Event = Event](FRHICommandListImmediate&)

            {

                delete Event;

            });

        }

    };


    #define RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(Stat, Condition, StaticName, Format, ...)  \

        TOptional<FRHIBreadcrumbScope_GameThread> PREPROCESSOR_JOIN(BreadcrumbScope, __LINE__);     \

        do                                                                                          \

        {                                                                                           \

            if (Condition)                                                                          \

            {                                                                                       \

                PREPROCESSOR_JOIN(BreadcrumbScope, __LINE__).Emplace(                               \

                    RHI_BREADCRUMB_DESC_COPY_VALUES(                                                \

                          StaticName                                                                \

                        , Format                                                                    \

                        , Stat                                                                      \

                    )(__VA_ARGS__)                                                                  \

                );                                                                                  \

            }                                                                                       \

        } while(false)


    // Note, the varargs are deprecated and ignored in these two macros.

    #define RHI_BREADCRUMB_EVENT_GAMETHREAD(                         StaticName,         ...) RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(RHI_GPU_STAT_ARGS_NONE,      true, TEXT(StaticName),      nullptr, ##__VA_ARGS__)

    #define RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD(  Condition, StaticName,         ...) RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(RHI_GPU_STAT_ARGS_NONE, Condition, TEXT(StaticName),      nullptr, ##__VA_ARGS__)


    // Format versions of the breadcrumb macros.

    #define RHI_BREADCRUMB_EVENT_GAMETHREAD_F(                       StaticName, Format, ...) RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(RHI_GPU_STAT_ARGS_NONE,      true, TEXT(StaticName), TEXT(Format), ##__VA_ARGS__)

    #define RHI_BREADCRUMB_EVENT_CONDITIONAL_GAMETHREAD_F(Condition, StaticName, Format, ...) RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(RHI_GPU_STAT_ARGS_NONE, Condition, TEXT(StaticName), TEXT(Format), ##__VA_ARGS__)


    // Used only for back compat with SCOPED_DRAW_EVENTF_GAMETHREAD

    #define RHI_BREADCRUMB_EVENT_GAMETHREAD_STR_DEPRECATED(          StaticName, Format, ...) RHI_BREADCRUMB_EVENT_GAMETHREAD_PRIVATE_IMPL(RHI_GPU_STAT_ARGS_NONE,      true, TEXT(StaticName),      Format , ##__VA_ARGS__)


#else


    #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)


#endif


// Macros to allow for scoping of draw events outside of RHI function implementations

// Render-thread event macros:

#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__);


// Non-render-thread event macros:

#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__);


// Deprecated macros

#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.")


#if RHI_NEW_GPU_PROFILER


    #if HAS_GPU_STATS


        #define DECLARE_GPU_STAT_NAME_TYPE(StatName, NameString) \

            struct TRHIGPUStatNameProvider_##StatName            \

            {                                                    \

                static constexpr TCHAR const* GetDisplayName()   \

                {                                                \

                    return NameString;                           \

                }                                                \

                static constexpr TCHAR const* GetStatName()      \

                {                                                \

                    return TEXT(#StatName);                      \

                }                                                \

            }


        // Extern GPU stats are needed where a stat is used in multiple CPPs. Use the DECLARE_GPU_STAT_NAMED_EXTERN in the header and DEFINE_GPU_STAT in the CPPs

        #define DECLARE_GPU_STAT_NAMED(                StatName, NameString) DECLARE_GPU_STAT_NAME_TYPE(StatName, NameString); static UE::RHI::GPUProfiler::TGPUStat                    <TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName

        #define DECLARE_GPU_STAT_NAMED_EXTERN(         StatName, NameString) DECLARE_GPU_STAT_NAME_TYPE(StatName, NameString); extern UE::RHI::GPUProfiler::TGPUStat                    <TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName

        #define DECLARE_GPU_DRAWCALL_STAT_NAMED(       StatName, NameString) DECLARE_GPU_STAT_NAME_TYPE(StatName, NameString); static UE::RHI::GPUProfiler::TGPUStatWithDrawcallCategory<TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName

        #define DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN(StatName, NameString) DECLARE_GPU_STAT_NAME_TYPE(StatName, NameString); extern UE::RHI::GPUProfiler::TGPUStatWithDrawcallCategory<TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName


        #define DECLARE_GPU_STAT(                StatName) DECLARE_GPU_STAT_NAMED(                StatName, TEXT(#StatName))

        #define DECLARE_GPU_STAT_EXTERN(         StatName) DECLARE_GPU_STAT_NAMED_EXTERN(         StatName, TEXT(#StatName))

        #define DECLARE_GPU_DRAWCALL_STAT(       StatName) DECLARE_GPU_DRAWCALL_STAT_NAMED(       StatName, TEXT(#StatName))

        #define DECLARE_GPU_DRAWCALL_STAT_EXTERN(StatName) DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN(StatName, TEXT(#StatName))


        #define DEFINE_GPU_STAT(         StatName) UE::RHI::GPUProfiler::TGPUStat                    <TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName

        #define DEFINE_GPU_DRAWCALL_STAT(StatName) UE::RHI::GPUProfiler::TGPUStatWithDrawcallCategory<TRHIGPUStatNameProvider_##StatName> GPUStat_##StatName


    #else


        #define DECLARE_GPU_STAT_NAMED(...)

        #define DECLARE_GPU_STAT_NAMED_EXTERN(...)

        #define DECLARE_GPU_DRAWCALL_STAT_NAMED(...)

        #define DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN(...)


        #define DECLARE_GPU_STAT(...)

        #define DECLARE_GPU_STAT_EXTERN(...)

        #define DECLARE_GPU_DRAWCALL_STAT(...)

        #define DECLARE_GPU_DRAWCALL_STAT_EXTERN(...)


        #define DEFINE_GPU_STAT(...)

        #define DEFINE_GPU_DRAWCALL_STAT(...)


    #endif


    // Empty when using the new RHI GPU profiler. GPU stats are handled via RHI_BREADCRUMB_EVENT_STAT etc.

    // @todo deprecate

    #define SCOPED_GPU_STAT_VERBOSE(...)

    #define SCOPED_GPU_STAT(...)

    #define GPU_STATS_BEGINFRAME(...)

    #define GPU_STATS_ENDFRAME(...)

    #define GPU_STATS_SUSPENDFRAME(...)


#else


class FRealtimeGPUProfiler;

class FRealtimeGPUProfilerEvent;

class FRealtimeGPUProfilerFrame;


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

CSV_DECLARE_CATEGORY_MODULE_EXTERN(RENDERCORE_API, GPU);


#if HAS_GPU_STATS


    // The DECLARE_GPU_STAT macros both declare and define a stat (for use in a single CPP)

    #define DECLARE_GPU_STAT(StatName)                                   DECLARE_FLOAT_COUNTER_STAT(TEXT(#StatName)       , Stat_GPU_##StatName, STATGROUP_GPU  ); CSV_DEFINE_STAT(GPU,StatName);         static FRHIDrawStatsCategory DrawcallCountCategory_##StatName;

    #define DECLARE_GPU_STAT_NAMED(StatName, NameString)                 DECLARE_FLOAT_COUNTER_STAT(NameString            , Stat_GPU_##StatName, STATGROUP_GPU  ); CSV_DEFINE_STAT(GPU,StatName);         static FRHIDrawStatsCategory DrawcallCountCategory_##StatName;

    #define DECLARE_GPU_DRAWCALL_STAT(StatName)                          DECLARE_FLOAT_COUNTER_STAT(TEXT(#StatName)       , Stat_GPU_##StatName, STATGROUP_GPU  ); CSV_DEFINE_STAT(GPU,StatName);         static FRHIDrawStatsCategory DrawcallCountCategory_##StatName((TCHAR*)TEXT(#StatName));

    #define DECLARE_GPU_DRAWCALL_STAT_NAMED(StatName, NameString)        DECLARE_FLOAT_COUNTER_STAT(NameString            , Stat_GPU_##StatName, STATGROUP_GPU  ); CSV_DEFINE_STAT(GPU,StatName);         static FRHIDrawStatsCategory DrawcallCountCategory_##StatName((TCHAR*)TEXT(#StatName));

    #define DECLARE_GPU_DRAWCALL_STAT_EXTERN(StatName)                   DECLARE_FLOAT_COUNTER_STAT_EXTERN(TEXT(#StatName), Stat_GPU_##StatName, STATGROUP_GPU, ); CSV_DECLARE_STAT_EXTERN(GPU,StatName); extern FRHIDrawStatsCategory DrawcallCountCategory_##StatName;

    #define DECLARE_GPU_DRAWCALL_STAT_NAMED_EXTERN(StatName, NameString) DECLARE_FLOAT_COUNTER_STAT_EXTERN(NameString     , Stat_GPU_##StatName, STATGROUP_GPU, ); CSV_DECLARE_STAT_EXTERN(GPU,StatName); extern FRHIDrawStatsCategory DrawcallCountCategory_##StatName;


    // Extern GPU stats are needed where a stat is used in multiple CPPs. Use the DECLARE_GPU_STAT_NAMED_EXTERN in the header and DEFINE_GPU_STAT in the CPPs

    #define DECLARE_GPU_STAT_NAMED_EXTERN(StatName, NameString) DECLARE_FLOAT_COUNTER_STAT_EXTERN(NameString, Stat_GPU_##StatName, STATGROUP_GPU, ); CSV_DECLARE_STAT_EXTERN(GPU,StatName); extern FRHIDrawStatsCategory DrawcallCountCategory_##StatName;

    #define DEFINE_GPU_STAT(StatName)                           DEFINE_STAT(Stat_GPU_##StatName);                                                    CSV_DEFINE_STAT(GPU,StatName);                FRHIDrawStatsCategory DrawcallCountCategory_##StatName;

    #define DEFINE_GPU_DRAWCALL_STAT(StatName)                  DEFINE_STAT(Stat_GPU_##StatName);                                                    CSV_DEFINE_STAT(GPU,StatName);                FRHIDrawStatsCategory DrawcallCountCategory_##StatName((TCHAR*)TEXT(#StatName));


    #define SCOPED_GPU_STAT_VERBOSE(RHICmdList, StatName, Description)                 \

        FScopedGPUStatEvent PREPROCESSOR_JOIN(GPUStatEvent_##StatName,__LINE__)(       \

              RHICmdList                                                               \

            , CSV_STAT_FNAME(StatName)                                                 \

            , GET_STATID(Stat_GPU_##StatName)                                          \

            , Description                                                              \

        );                                                                             \

        FScopedDrawStatCategory PREPROCESSOR_JOIN(DrawCallScope_##StatName, __LINE__)( \

            RHICmdList, DrawcallCountCategory_##StatName                               \

        );


    #define SCOPED_GPU_STAT(RHICmdList, StatName) SCOPED_GPU_STAT_VERBOSE(RHICmdList, StatName, nullptr)


    #define GPU_STATS_BEGINFRAME(RHICmdList) FRealtimeGPUProfiler::Get()->BeginFrame(RHICmdList);

    #define GPU_STATS_ENDFRAME(RHICmdList)   FRealtimeGPUProfiler::Get()->EndFrame(RHICmdList);

    #define GPU_STATS_SUSPENDFRAME()         FRealtimeGPUProfiler::Get()->SuspendFrame();


#else


    #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()


#endif


RENDERCORE_API bool AreGPUStatsEnabled();


#if HAS_GPU_STATS


class FRealtimeGPUProfilerQuery

{

public:

    FRealtimeGPUProfilerQuery() = default;

    FRealtimeGPUProfilerQuery(FRHIGPUMask InGPUMask, FRHIRenderQuery* InQuery, FRealtimeGPUProfilerEvent* Parent)

        : GPUMask(InGPUMask)

        , Query(InQuery)

        , Parent(Parent)

    {}


    RENDERCORE_API void Submit(FRHICommandList& RHICmdList, bool bBegin) const;


    // RDG might create profiler events that are never submitted due to pass culling etc.

    // This is called when FRDGScope_GPU instances are destructed, and will mark this query as discarded if it was never submitted.

    RENDERCORE_API void Discard(bool bBegin);


    operator bool() const { return Query != nullptr; }


private:

    FRHIGPUMask GPUMask;

    FRHIRenderQuery* Query{};

    FRealtimeGPUProfilerEvent* Parent{};

};


#if GPUPROFILERTRACE_ENABLED

struct FRealtimeGPUProfilerHistoryItem

{

    FRealtimeGPUProfilerHistoryItem();


    static const uint64 HistoryCount = 64;


    // Constructor memsets everything to zero, assuming structure is Plain Old Data.  If any dynamic structures are

    // added, you'll need a more generalized constructor that zeroes out all the uninitialized data.

    bool UpdatedThisFrame;

    FRHIGPUMask LastGPUMask;

    uint64 NextWriteIndex;

    uint64 AccumulatedTime;             // Accumulated time could be computed, but may also be useful to inspect in the debugger

    TStaticArray<uint64, HistoryCount> Times;

};


struct FRealtimeGPUProfilerHistoryByDescription

{

    TMap<FString, FRealtimeGPUProfilerHistoryItem> History;

    mutable FRWLock Mutex;

};


struct FRealtimeGPUProfilerDescriptionResult

{

    // Times are in microseconds

    FString Description;

    FRHIGPUMask GPUMask;

    uint64 AverageTime;

    uint64 MinTime;

    uint64 MaxTime;

};

#endif  // GPUPROFILERTRACE_ENABLED


class FRealtimeGPUProfiler

{

    static FRealtimeGPUProfiler* Instance;

public:

    // Singleton interface

    static RENDERCORE_API FRealtimeGPUProfiler* Get();


    static RENDERCORE_API void SafeRelease();


    RENDERCORE_API void BeginFrame(FRHICommandListImmediate& RHICmdList);

    RENDERCORE_API void EndFrame(FRHICommandListImmediate& RHICmdList);

    RENDERCORE_API void SuspendFrame();


    RENDERCORE_API FRealtimeGPUProfilerQuery PushEvent(FRHIGPUMask GPUMask, const FName& Name, const TStatId& Stat, const TCHAR* Description);

    RENDERCORE_API FRealtimeGPUProfilerQuery PopEvent();


    RENDERCORE_API void PushStat(FRHICommandListImmediate& RHICmdList, const FName& Name, const TStatId& Stat, const TCHAR* Description);

    RENDERCORE_API void PopStat(FRHICommandListImmediate& RHICmdList);


#if GPUPROFILERTRACE_ENABLED

    RENDERCORE_API void FetchPerfByDescription(TArray<FRealtimeGPUProfilerDescriptionResult> & OutResults) const;

#endif


private:

    FRealtimeGPUProfiler();


    void Cleanup();


    UE::Tasks::FTask CleanUpTask;


    TUniquePtr<FRealtimeGPUProfilerFrame> ActiveFrame;

    TQueue<TUniquePtr<FRealtimeGPUProfilerFrame>> PendingFrames;


    FRenderQueryPoolRHIRef RenderQueryPool;

    bool bLocked = false;


#if GPUPROFILERTRACE_ENABLED

    FRealtimeGPUProfilerHistoryByDescription HistoryByDescription;

#endif

};


class FScopedGPUStatEvent

{

    FRHICommandListBase* RHICmdList = nullptr;


public:

    RENDERCORE_API FScopedGPUStatEvent(FRHICommandListBase& InRHICmdList, const FName& Name, const TStatId& StatId, const TCHAR* Description);

    RENDERCORE_API ~FScopedGPUStatEvent();

};


class FScopedDrawStatCategory

{

    FRHICommandListBase* const RHICmdList = nullptr;

    TOptional<FRHIDrawStatsCategory const*> Previous {};


public:

    RENDERCORE_API FScopedDrawStatCategory(FRHICommandListBase& RHICmdList, FRHIDrawStatsCategory const& Category);

    RENDERCORE_API ~FScopedDrawStatCategory();

};


#endif // HAS_GPU_STATS


#endif // (RHI_NEW_GPU_PROFILER == 0)

check
#define check(expr)
Definition AssertionMacros.h:314

EBTBranchAction::Cleanup
@ Cleanup

ETransformConstraintType::Parent
@ Parent

CoreMinimal.h

CoreTypes.h

TEXT
#define TEXT(x)
Definition Platform.h:1272

TCHAR
FPlatformTypes::TCHAR TCHAR
Either ANSICHAR or WIDECHAR, depending on whether the platform supports wide characters or the requir...
Definition Platform.h:1135

uint64
FPlatformTypes::uint64 uint64
A 64-bit unsigned integer.
Definition Platform.h:1117

Stats.h

DECLARE_STATS_GROUP
#define DECLARE_STATS_GROUP(GroupDesc, GroupId, GroupCat)
Definition Stats.h:689

StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

CriticalSection.h

CsvProfilerConfig.h

CsvProfiler.h

CSV_DECLARE_CATEGORY_MODULE_EXTERN
#define CSV_DECLARE_CATEGORY_MODULE_EXTERN(Module_API, CategoryName)
Definition CsvProfiler.h:80

ED3D12Access::Discard
@ Discard

EDynamicResolutionStateEvent::EndFrame
@ EndFrame

EDynamicResolutionStateEvent::BeginFrame
@ BeginFrame

GpuProfilerTrace.h

ELocalFileChunkType::Event
@ Event

MultiGPU.h

NameTypes.h

bool
const bool
Definition NetworkReplayStreaming.h:178

RHIBreadcrumbs.h

RHICommandList.h

RHI.h

AreGPUStatsEnabled
RENDERCORE_API bool AreGPUStatsEnabled()

ERDGScopeFlags::Stat
@ Stat

RenderingThread.h

ENQUEUE_RENDER_COMMAND
#define ENQUEUE_RENDER_COMMAND(Type)
Definition RenderingThread.h:1167

EUINavigation::Previous
@ Previous

StaticArray.h

ETextureAvailability::GPU
@ GPU

ReadyMask::Query
@ Query

IsInGameThread
CORE_API bool IsInGameThread()
Definition ThreadingBase.cpp:185

ETypeContainerScope::Instance
@ Instance

UnrealString.h

MoveTemp
UE_INTRINSIC_CAST UE_REWRITE constexpr std::remove_reference_t< T > && MoveTemp(T &&Obj) noexcept
Definition UnrealTemplate.h:520

EVariantTypes::Name
@ Name

FName
Definition NameTypes.h:617

FRHICommandListBase
Definition RHICommandList.h:455

FRHICommandListImmediate
Definition RHICommandList.h:4626

FRHICommandList
Definition RHICommandList.h:3819

FRHIRenderQuery
Definition RHIResources.h:2444

TArray
Definition Array.h:670

TMap
Definition UnrealString.h.inl:34

TQueue
Definition Queue.h:48

TRefCountPtr< FRHIRenderQueryPool >

TStaticArray
Definition StaticArray.h:26

TUniquePtr
Definition UniquePtr.h:107

UE::FPlatformRWLock
Definition CriticalSection.h:14

UE::Tasks::Private::FTaskHandle
Definition Task.h:30

EPathFollowingDebugTokens::Description
@ Description
Definition PathFollowingComponent.h:177

MeshPaintVirtualTexture::Mutex
UE::FRecursiveMutex Mutex
Definition MeshPaintVirtualTexture.cpp:164

ObjectPtr_Private::Get
FORCEINLINE T * Get(const FObjectPtr &ObjectPtr)
Definition ObjectPtr.h:426

FRHIDrawStatsCategory
Definition RHIStats.h:110

FRHIGPUMask
Definition MultiGPU.h:33

TOptional
Definition Optional.h:131

TStatId
Definition LightweightStats.h:416