Files
ionut matasaru 0ccbd0fcde Added UE_STATS_MEMORY_PROFILER_ENABLED to toggle on/off code related to MemoryProfiler in STATS system. It still requires STATS to be enabled and "-MemoryProfiler" to be specified in cmd line.
This is off by default as MemoryProfiler in STATS system functionality is deprecated in UE 5.3. For memory profiling, use instead Trace/MemoryInsights and/or LLM.

#jira UE-183900
#rb Johan.Berg
#preflight 64428b470206a6e20f579812

[CL 25145603 by ionut matasaru in ue5-main branch]
2023-04-21 10:47:57 -04:00

41 lines
1.2 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "SlateFwd.h"
#include "Modules/ModuleInterface.h"
class FRawStatsMemoryProfiler;
class ISessionManager;
class SWidget;
/**
* Interface for the profiler module.
*/
class IProfilerModule
: public IModuleInterface
{
public:
/**
* Creates the main window for the profiler.
*
* @param InSessionManager The session manager to use.
* @param ConstructUnderMajorTab The tab which will contain the profiler tabs.
*
*/
virtual TSharedRef<SWidget> CreateProfilerWindow(const TSharedRef<ISessionManager>& InSessionManager, const TSharedRef<SDockTab>& ConstructUnderMajorTab) = 0;
/** Implements stats memory dump command. */
UE_DEPRECATED(5.3, "Use Trace/MemoryInsights and/or LLM for memory profiling.")
virtual void StatsMemoryDumpCommand(const TCHAR* Filename) = 0;
/**
* Creates a new instance of the memory profiler based the raw stats.
* When no longer needed must be stopped via RequestStop() and deleted to avoid memory leaks.
*/
UE_DEPRECATED(5.3, "Use Trace/MemoryInsights and/or LLM for memory profiling.")
virtual FRawStatsMemoryProfiler* OpenRawStatsForMemoryProfiling(const TCHAR* Filename) = 0;
};