StatsSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Delegates/DelegateBase.h"
#include "Templates/Atomic.h"
 
namespace UE::Stats
{
    struct FStats
    {
        DECLARE_DELEGATE_ThreeParams(FOnAdvanceRenderingThreadStats, bool /*bDiscardCallstack*/, int64 /*StatsFrame*/, int32 /*PrimaryDisableChangeTagStartFrame*/);
 
        /* Initializes any relevant stat systems, including those that exist when STATS is 0. */
        static CORE_API void Init();
 
        static CORE_API void AdvanceFrame(bool bDiscardCallstack, const FOnAdvanceRenderingThreadStats& AdvanceRenderingThreadStatsDelegate = FOnAdvanceRenderingThreadStats());
 
        static CORE_API void TickCommandletStats();
 
        static CORE_API bool EnabledForCommandlet();
 
        static CORE_API bool HasLoadTimeStatsForCommandletToken();
 
        static CORE_API bool HasLoadTimeFileForCommandletToken();
 
        static CORE_API TAtomic<int32> GameThreadStatsFrame;
 
    #if STATS
        // The engine stats system maintains its own frame counter. We need to propagate this to
        // the end-of-pipe thread so that stat data it submits is attributed to the correct frame.
        // This is done inside AdvanceRenderingThreadStats.
        static CORE_API TOptional<int64> StatsFrameRT;
    #endif
    };
} // namespace UE::Stats
 
UE_DEPRECATED(5.6, "Use UE::Stats::FStats instead.")
typedef UE::Stats::FStats FStats;