Fps Profiler - save fps, cpu, gpu data to csv file

Gems/FPSProfiler/Code/Include/FPSProfiler/FPSProfilerBus.h

@@ -52,14 +52,14 @@ namespace FPSProfiler
          * @warning This function is NOT runtime safe. Use @ref SafeChangeSavePath instead.
          * @param newSavePath The new file path where profiling data should be saved.
          */
-        virtual void ChangeSavePath(const AZStd::string& newSavePath) = 0;
+        virtual void ChangeSavePath(const AZ::IO::Path& newSavePath) = 0;
 
         /**
          * @brief Safely changes the save path during runtime.
          * This method stops profiling, saves the current data, and then updates the path.
          * @param newSavePath The new file path where profiling data should be saved.
          */
-        virtual void SafeChangeSavePath(const AZStd::string& newSavePath) = 0;
+        virtual void SafeChangeSavePath(const AZ::IO::Path& newSavePath) = 0;
 
         /**
          * @brief Retrieves the minimum recorded FPS during the profiling session.
@@ -107,7 +107,7 @@ namespace FPSProfiler
          * @param newSavePath The csv file path where the log should be saved.
          * @param useSafeChangePath If true, the function will use @ref SafeChangeSavePath to ensure runtime safety.
          */
-        virtual void SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath) = 0;
+        virtual void SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath) = 0;
 
         /**
          * @brief Enables or disables FPS display on-screen.
@@ -140,25 +140,19 @@ namespace FPSProfiler
          * @brief Called when a new file is created.
          * @param config File Save Settings Configuration.
          */
-        virtual void OnFileCreated(const Configs::FileSaveSettings& config)
-        {
-        }
+        virtual void OnFileCreated(Configs::FileSaveSettings& config) = 0;
 
         /**
          * @brief Called when an existing file is updated.
          * @param config File Save Settings Configuration.
          */
-        virtual void OnFileUpdate(const Configs::FileSaveSettings& config)
-        {
-        }
+        virtual void OnFileUpdate(Configs::FileSaveSettings& config) = 0;
 
         /**
          * @brief Called when a file is successfully saved.
          * @param config File Save Settings Configuration.
          */
-        virtual void OnFileSaved(const Configs::FileSaveSettings& config)
-        {
-        }
+        virtual void OnFileSaved(Configs::FileSaveSettings& config) = 0;
 
         /**
          * @brief Called when the profiling process starts.
@@ -167,20 +161,14 @@ namespace FPSProfiler
          * @param debugConfig The configuration settings used for the debugging.
          */
         virtual void OnProfileStart(
-            const Configs::RecordSettings& recordConfig,
-            const Configs::PrecisionSettings& precisionConfig,
-            const Configs::DebugSettings& debugConfig)
-        {
-        }
+            Configs::RecordSettings& recordConfig, Configs::PrecisionSettings& precisionConfig, Configs::DebugSettings& debugConfig) = 0;
 
         /**
          * @brief Called when the profiling data is reset.
          * @param recordConfig The configuration settings used for the record session.
          * @param precisionConfig The configuration settings used for the precision.
          */
-        virtual void OnProfileReset(const Configs::RecordSettings& recordConfig, const Configs::PrecisionSettings& precisionConfig)
-        {
-        }
+        virtual void OnProfileReset(Configs::RecordSettings& recordConfig, Configs::PrecisionSettings& precisionConfig) = 0;
 
         /**
          * @brief Called when the profiling process stops.
@@ -190,12 +178,10 @@ namespace FPSProfiler
          * @param debugConfig The configuration settings used for the debugging.
          */
         virtual void OnProfileStop(
-            const Configs::FileSaveSettings& saveConfig,
-            const Configs::RecordSettings& recordConfig,
-            const Configs::PrecisionSettings& precisionConfig,
-            const Configs::DebugSettings& debugConfig)
-        {
-        }
+            Configs::FileSaveSettings& saveConfig,
+            Configs::RecordSettings& recordConfig,
+            Configs::PrecisionSettings& precisionConfig,
+            Configs::DebugSettings& debugConfig) = 0;
     };
 
     class FPSProfilerNotificationBusTraits : public AZ::EBusTraits
@@ -226,39 +212,39 @@ namespace FPSProfiler
             OnProfileReset,
             OnProfileStop);
 
-        void OnFileCreated(const Configs::FileSaveSettings& config) override
+        void OnFileCreated(Configs::FileSaveSettings& config) override
         {
             Call(FN_OnFileCreated, config);
         }
 
-        void OnFileUpdate(const Configs::FileSaveSettings& config) override
+        void OnFileUpdate(Configs::FileSaveSettings& config) override
         {
             Call(FN_OnFileUpdate, config);
         }
 
-        void OnFileSaved(const Configs::FileSaveSettings& config) override
+        void OnFileSaved(Configs::FileSaveSettings& config) override
         {
             Call(FN_OnFileSaved, config);
         }
 
         void OnProfileStart(
-            const Configs::RecordSettings& recordConfig,
-            const Configs::PrecisionSettings& precisionConfig,
-            const Configs::DebugSettings& debugConfig) override
+            Configs::RecordSettings& recordConfig,
+            Configs::PrecisionSettings& precisionConfig,
+            Configs::DebugSettings& debugConfig) override
         {
             Call(FN_OnProfileStart, recordConfig, precisionConfig, debugConfig);
         }
 
-        void OnProfileReset(const Configs::RecordSettings& recordConfig, const Configs::PrecisionSettings& precisionConfig) override
+        void OnProfileReset(Configs::RecordSettings& recordConfig, Configs::PrecisionSettings& precisionConfig) override
         {
             Call(FN_OnProfileReset, recordConfig, precisionConfig);
         }
 
         void OnProfileStop(
-            const Configs::FileSaveSettings& saveConfig,
-            const Configs::RecordSettings& recordConfig,
-            const Configs::PrecisionSettings& precisionConfig,
-            const Configs::DebugSettings& debugConfig) override
+            Configs::FileSaveSettings& saveConfig,
+            Configs::RecordSettings& recordConfig,
+            Configs::PrecisionSettings& precisionConfig,
+            Configs::DebugSettings& debugConfig) override
         {
             Call(FN_OnProfileStop, saveConfig, recordConfig, precisionConfig, debugConfig);
         }

Gems/FPSProfiler/Code/Include/FPSProfiler/FPSProfilerTypeIds.h

@@ -5,7 +5,6 @@ namespace FPSProfiler
 {
     // System Component TypeIds
     inline constexpr const char* FPSProfilerComponentTypeId = "{B11CE88E-E1C5-404F-83D2-0D3850445A13}";
-    inline constexpr const char* FPSProfilerEditorComponentTypeId = "{F4308920-CD0B-4A2E-91DE-2EC1E970F97A}";
 
     // Configs TypeIds
     inline constexpr const char* FPSProfilerConfigFileTypeId = "{68627A89-9426-4640-B460-63E6AA42CFBC}";

Gems/FPSProfiler/Code/Source/Clients/FPSProfilerComponent.cpp

@@ -4,6 +4,7 @@
 #include <Atom/RHI/MemoryStatisticsBuilder.h>
 #include <Atom/RHI/RHISystemInterface.h>
 #include <AzCore/IO/FileIO.h>
+#include <AzCore/Serialization/EditContext.h>
 #include <AzCore/Serialization/SerializeContext.h>
 #include <AzCore/std/numeric.h>
 
@@ -24,6 +25,20 @@ namespace FPSProfiler
                 ->Field("m_configRecord", &FPSProfilerComponent::m_configRecord)
                 ->Field("m_configPrecision", &FPSProfilerComponent::m_configPrecision)
                 ->Field("m_configDebug", &FPSProfilerComponent::m_configDebug);
+
+            if (AZ::EditContext* editContext = serializeContext->GetEditContext())
+            {
+                editContext->Class<FPSProfilerComponent>("FPS Profiler", "Tracks FPS, GPU and CPU performance and saves it into .csv")
+                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
+                    ->Attribute(AZ::Edit::Attributes::Category, "Performance")
+                    ->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC_CE("Level"))
+                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
+
+                    ->DataElement(AZ::Edit::UIHandlers::Default, &FPSProfilerComponent::m_configFile)
+                    ->DataElement(AZ::Edit::UIHandlers::Default, &FPSProfilerComponent::m_configRecord)
+                    ->DataElement(AZ::Edit::UIHandlers::Default, &FPSProfilerComponent::m_configPrecision)
+                    ->DataElement(AZ::Edit::UIHandlers::Default, &FPSProfilerComponent::m_configDebug);
+            }
         }
 
         // EBus Reflect for Lua and Script Canvas
@@ -309,7 +324,7 @@ namespace FPSProfiler
         return m_configRecord.m_RecordStats != Configs::RecordStatistics::None;
     }
 
-    void FPSProfilerComponent::ChangeSavePath(const AZStd::string& newSavePath)
+    void FPSProfilerComponent::ChangeSavePath(const AZ::IO::Path& newSavePath)
     {
         if (!IsPathValid(newSavePath))
         {
@@ -320,7 +335,7 @@ namespace FPSProfiler
         AZ_Warning("FPS Profiler", !m_configDebug.m_PrintDebugInfo && !m_isProfiling, "Path changed during activated profiling.");
     }
 
-    void FPSProfilerComponent::SafeChangeSavePath(const AZStd::string& newSavePath)
+    void FPSProfilerComponent::SafeChangeSavePath(const AZ::IO::Path& newSavePath)
     {
         // If profiling is enabled, save current opened file and stop profiling.
         StopProfiling();
@@ -378,7 +393,7 @@ namespace FPSProfiler
         WriteDataToFile();
     }
 
-    void FPSProfilerComponent::SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath)
+    void FPSProfilerComponent::SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath)
     {
         if (useSafeChangePath)
         {
@@ -470,10 +485,9 @@ namespace FPSProfiler
             char timestamp[20];
             strftime(timestamp, sizeof(timestamp), "%Y%m%d_%H%M%S", &timeInfo);
 
-            AZ::IO::Path logFilePath(m_configFile.m_OutputFilename);
-            logFilePath.ReplaceFilename((logFilePath.Stem().String() + "_" + timestamp + logFilePath.Extension().String()).data());
-
-            m_configFile.m_OutputFilename = logFilePath.c_str();
+            m_configFile.m_OutputFilename.ReplaceFilename(
+                (m_configFile.m_OutputFilename.Stem().String() + "_" + timestamp + m_configFile.m_OutputFilename.Extension().String())
+                    .data());
         }
 
         // Write profiling headers to file
@@ -516,19 +530,17 @@ namespace FPSProfiler
         return static_cast<float>(bytes) / (1024.0f * 1024.0f);
     }
 
-    bool FPSProfilerComponent::IsPathValid(const AZStd::string& path) const
+    bool FPSProfilerComponent::IsPathValid(const AZ::IO::Path& path) const
     {
         AZ::IO::FileIOBase* fileIO = AZ::IO::FileIOBase::GetInstance();
-        AZ::IO::Path pathToValidate(path.c_str());
 
-        if (pathToValidate.empty() || !pathToValidate.HasFilename() || !pathToValidate.HasExtension() || !fileIO ||
-            !fileIO->ResolvePath(pathToValidate))
+        if (path.empty() || !path.HasFilename() || !path.HasExtension() || !fileIO || !fileIO->ResolvePath(path))
         {
-            const char* reason = pathToValidate.empty() ? "Path cannot be empty."
-                : !pathToValidate.HasFilename()         ? "Path must have a file at the end."
-                : !pathToValidate.HasExtension()        ? "Path must have a *.csv extension."
-                : !fileIO                               ? "Could not get a FileIO object. Try again."
-                                                        : "Path is not registered or recognizable by O3DE FileIO System.";
+            const char* reason = path.empty() ? "Path cannot be empty."
+                : !path.HasFilename()         ? "Path must have a file at the end."
+                : !path.HasExtension()        ? "Path must have a *.csv extension."
+                : !fileIO                     ? "Could not get a FileIO object. Try again."
+                                              : "Path is not registered or recognizable by O3DE FileIO System.";
 
             AZ_Warning("FPSProfiler::IsPathValid", !m_configDebug.m_PrintDebugInfo, "%s", reason);
             return false;
@@ -551,7 +563,7 @@ namespace FPSProfiler
         debugDisplay->SetColor(AZ::Colors::Red);
         debugDisplay->SetAlpha(1.0f);
 
-        AZStd::string debugText = AZStd::string::format("Profiler | FPS: %.2f", m_currentFps);
-        debugDisplay->Draw2dTextLabel(10, 10, 1.0f, debugText.c_str(), true);
+        AZStd::string debugText = AZStd::string::format("FPS: %.2f", m_currentFps);
+        debugDisplay->Draw2dTextLabel(100, 50, 1.0f, debugText.c_str(), true);
     }
 } // namespace FPSProfiler

Gems/FPSProfiler/Code/Source/Clients/FPSProfilerComponent.h

@@ -45,26 +45,37 @@ namespace FPSProfiler
         void ResetProfilingData() override;
         [[nodiscard]] bool IsProfiling() const override;
         [[nodiscard]] bool IsAnySaveOptionEnabled() const override;
-        void ChangeSavePath(const AZStd::string& newSavePath) override;
-        void SafeChangeSavePath(const AZStd::string& newSavePath) override;
+        void ChangeSavePath(const AZ::IO::Path& newSavePath) override;
+        void SafeChangeSavePath(const AZ::IO::Path& newSavePath) override;
         [[nodiscard]] float GetMinFps() const override;
         [[nodiscard]] float GetMaxFps() const override;
         [[nodiscard]] float GetAvgFps() const override;
         [[nodiscard]] float GetCurrentFps() const override;
         [[nodiscard]] AZStd::pair<AZStd::size_t, AZStd::size_t> GetCpuMemoryUsed() const override;
         [[nodiscard]] AZStd::pair<AZStd::size_t, AZStd::size_t> GetGpuMemoryUsed() const override;
         void SaveLogToFile() override;
-        void SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath) override;
+        void SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath) override;
         void ShowFpsOnScreen(bool enable) override;
 
-    public:
+    private:
+        // File Operations
+        void CreateLogFile();
+        void WriteDataToFile();
+
+        // Utility Functions
+        void CalculateFpsData(const float& deltaTime);
+        static float BytesToMB(AZStd::size_t bytes);
+        [[nodiscard]] bool IsPathValid(const AZ::IO::Path& path) const;
+
+        // Debug Display
+        void ShowFps() const;
+
         // Profiler Configurations
         Configs::FileSaveSettings m_configFile; //!< Stores editor settings for the profiler
         Configs::RecordSettings m_configRecord; //!< Stores editor settings for the profiler
         Configs::PrecisionSettings m_configPrecision; //!< Stores editor settings for the profiler
         Configs::DebugSettings m_configDebug; //!< Stores editor settings for the profiler
 
-    private:
         // FPS Tracking Data
         bool m_isProfiling = false; //!< Flag to indicate if profiling is active
         float m_minFps = 0.0f; //!< Lowest FPS value recorded
@@ -80,17 +91,5 @@ namespace FPSProfiler
         AZStd::vector<char> m_logBuffer; //!< Buffer for log entries, cleared periodically if auto save enabled.
         static constexpr AZStd::size_t MAX_LOG_BUFFER_SIZE = 1024 * 128; //!< Max log buffer size
         static constexpr AZStd::size_t MAX_LOG_BUFFER_LINE_SIZE = 128; //!< Max length per log line
-
-        // File Operations
-        void CreateLogFile();
-        void WriteDataToFile();
-
-        // Utility Functions
-        void CalculateFpsData(const float& deltaTime);
-        static float BytesToMB(AZStd::size_t bytes);
-        [[nodiscard]] bool IsPathValid(const AZStd::string& path) const;
-
-        // Debug Display
-        void ShowFps() const;
     };
 } // namespace FPSProfiler

Gems/FPSProfiler/Code/Source/Configurations/FPSProfilerConfig.cpp

@@ -9,11 +9,6 @@ namespace FPSProfiler::Configs
     {
         if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
         {
-            if (serializeContext->FindClassData(azrtti_typeid<FileSaveSettings>())) // Prevent duplicate registration
-            {
-                return;
-            }
-
             serializeContext->Class<FileSaveSettings>()
                 ->Version(0)
                 ->Field("m_OutputFilename", &FileSaveSettings::m_OutputFilename)
@@ -86,11 +81,6 @@ namespace FPSProfiler::Configs
     {
         if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
         {
-            if (serializeContext->FindClassData(azrtti_typeid<RecordSettings>())) // Prevent duplicate registration
-            {
-                return;
-            }
-
             serializeContext->Class<RecordSettings>()
                 ->Version(0)
                 ->Field("m_recordType", &RecordSettings::m_recordType)
@@ -152,11 +142,6 @@ namespace FPSProfiler::Configs
 
         if (auto behaviorContext = azrtti_cast<AZ::BehaviorContext*>(context))
         {
-            if (behaviorContext->m_classes.contains("RecordSettings"))
-            {
-                return;
-            }
-
             behaviorContext->Class<RecordSettings>("RecordSettings")
                 ->Attribute(AZ::Script::Attributes::Category, "FPSProfiler")
                 ->Constructor<>()
@@ -171,11 +156,6 @@ namespace FPSProfiler::Configs
     {
         if (auto* serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
         {
-            if (serializeContext->FindClassData(azrtti_typeid<PrecisionSettings>())) // Prevent duplicate registration
-            {
-                return;
-            }
-
             serializeContext->Class<PrecisionSettings>()
                 ->Version(0)
                 ->Field("m_NearZeroPrecision", &PrecisionSettings::m_NearZeroPrecision)
@@ -249,11 +229,6 @@ namespace FPSProfiler::Configs
     {
         if (auto* serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
         {
-            if (serializeContext->FindClassData(azrtti_typeid<DebugSettings>())) // Prevent duplicate registration
-            {
-                return;
-            }
-
             serializeContext->Class<DebugSettings>()
                 ->Version(0)
                 ->Field("m_PrintDebugInfo", &DebugSettings::m_PrintDebugInfo)
@@ -301,4 +276,4 @@ namespace FPSProfiler::Configs
                 ->Property("m_Color", BehaviorValueProperty(&DebugSettings::m_Color));
         }
     }
-} // namespace FPSProfiler::Configs
+} // namespace FPSProfiler::Configs

Gems/FPSProfiler/Code/Source/Configurations/FPSProfilerConfig.h

@@ -40,7 +40,7 @@ namespace FPSProfiler::Configs
         AZ_TYPE_INFO(FileSaveSettings, FPSProfilerConfigFileTypeId);
         static void Reflect(AZ::ReflectContext* context);
 
-        AZStd::string m_OutputFilename = "@user@/fps_log.csv";
+        AZ::IO::Path m_OutputFilename = "@user@/fps_log.csv";
         bool m_AutoSave = true;
         int m_AutoSaveAtFrame = 100;
         bool m_SaveWithTimestamp = true;