[DebugLayer] Refactored command buffer annotations in debug layer (BR…

…EAKING CHANGE).

Most CommandBuffer commands now print a formatted string when time recording is enabled to improve frame traces.
This is a breaking change as the annotation field in "ProfileTimeRecord" has been changed from a C-string to "StringLiteral".

examples/Cpp/ExampleBase/ExampleBase.cpp

@@ -647,7 +647,7 @@ void ExampleBase::MainLoop()
             );
             const double invTicksFreqMS = 1000.0 / LLGL::Timer::Frequency();
             for (const LLGL::ProfileTimeRecord& rec : frameProfile.timeRecords)
-                LLGL::Log::Printf("%s: GPU time: %" PRIu64 " ns\n", rec.annotation, rec.elapsedTime);
+                LLGL::Log::Printf("%s: GPU time: %" PRIu64 " ns\n", rec.annotation.c_str(), rec.elapsedTime);
 
             debuggerObj_->SetTimeRecording(false);
             showTimeRecords_ = false;

examples/Cpp/ExampleBase/FileUtils.cpp

@@ -201,7 +201,7 @@ std::string WriteFrameProfileToJson(const LLGL::FrameProfile& frameProfile)
         s += ", ";
 
         s += "\"ph\": \"X\", \"name\": \"";
-        s += rec.annotation;
+        s += rec.annotation.c_str();
         s += "\", ";
 
         s += "\"args\": { \"Elapsed GPU Time\": ";

include/LLGL/RenderingDebuggerFlags.h

@@ -12,6 +12,7 @@
 #include <LLGL/Export.h>
 #include <LLGL/Deprecated.h>
 #include <LLGL/Container/DynamicVector.h>
+#include <LLGL/Container/StringLiteral.h>
 #include <cstdint>
 
 
@@ -49,7 +50,7 @@ enum class WarningType
 struct ProfileTimeRecord
 {
     //! Time record annotation, e.g. function name that was recorded from the CommandBuffer.
-    const char*     annotation      = "";
+    StringLiteral   annotation;
 
     /**
     \brief CPU ticks at the beginning of the command.

sources/Renderer/DebugLayer/DbgCommandBuffer.h

@@ -207,7 +207,7 @@ class DbgCommandBuffer final : public CommandBuffer
         void ResetRecords();
         void ResetBindingTable(const DbgPipelineLayout* pipelineLayoutDbg);
 
-        void StartTimer(const char* annotation);
+        void StartTimer(StringLiteral annotation);
         void EndTimer();
 
         // Returns true if this command buffer inherits its state from a primary command buffer.

sources/Renderer/DebugLayer/DbgQueryTimerPool.cpp

@@ -56,14 +56,14 @@ void DbgQueryTimerPool::Reset()
     cpuTicksBase_       = Timer::Tick();
 }
 
-void DbgQueryTimerPool::Start(const char* annotation)
+void DbgQueryTimerPool::Start(StringLiteral annotation)
 {
     pendingRecordStack_.push(records_.size());
 
     /* Store annotation only first */
     ProfileTimeRecord record;
     {
-        record.annotation       = annotation;
+        record.annotation       = std::move(annotation);
         record.cpuTicksStart    = Timer::Tick() - cpuTicksBase_;
     }
     records_.push_back(record);

sources/Renderer/DebugLayer/DbgQueryTimerPool.h

@@ -34,7 +34,7 @@ class DbgQueryTimerPool
         void Reset();
 
         // Starts measuring the time with the specified annotation.
-        void Start(const char* annotation);
+        void Start(StringLiteral annotation);
 
         // Stops measing the time and stores the current record.
         void Stop();

wrapper/C99/C99RenderingDebugger.cpp

@@ -7,6 +7,7 @@
 
 #include <LLGL/RenderingDebugger.h>
 #include <LLGL-C/RenderingDebugger.h>
+#include <LLGL/Utils/ForRange.h>
 #include "C99Internal.h"
 #include <cstring>
 
@@ -36,11 +37,20 @@ LLGL_C_EXPORT bool llglGetDebuggerTimeRecording(LLGLRenderingDebugger debugger)
     return LLGL_PTR(RenderingDebugger, debugger)->GetTimeRecording();
 }
 
+static void ConvertC99ProfileTimeRecord(LLGLProfileTimeRecord& dst, const ProfileTimeRecord& src)
+{
+    dst.annotation      = src.annotation.c_str();
+    dst.cpuTicksStart   = src.cpuTicksStart;
+    dst.cpuTicksEnd     = src.cpuTicksEnd;
+    dst.elapsedTime     = src.elapsedTime;
+}
+
 LLGL_C_EXPORT void llglFlushDebuggerProfile(LLGLRenderingDebugger debugger, LLGLFrameProfile* outFrameProfile)
 {
     LLGL_ASSERT_PTR(outFrameProfile);
 
     static thread_local FrameProfile internalFrameProfile;
+    static thread_local std::vector<LLGLProfileTimeRecord> internalProfileTimeRecords;
     LLGL_PTR(RenderingDebugger, debugger)->FlushProfile(&internalFrameProfile);
 
     static_assert(
@@ -55,12 +65,12 @@ LLGL_C_EXPORT void llglFlushDebuggerProfile(LLGLRenderingDebugger debugger, LLGL
     );
     std::memcpy(&(outFrameProfile->commandBufferRecord), &(internalFrameProfile.commandBufferRecord), sizeof(LLGLProfileCommandBufferRecord));
 
-    static_assert(
-        sizeof(LLGLProfileTimeRecord) == sizeof(ProfileTimeRecord),
-        "LLGLProfileTimeRecord and LLGL::ProfileTimeRecord expected to be the same size"
-    );
-    outFrameProfile->numTimeRecords = internalFrameProfile.timeRecords.size();
-    outFrameProfile->timeRecords = reinterpret_cast<const LLGLProfileTimeRecord*>(internalFrameProfile.timeRecords.data());
+    internalProfileTimeRecords.resize(internalFrameProfile.timeRecords.size());
+    for_range(i, internalFrameProfile.timeRecords.size())
+        ConvertC99ProfileTimeRecord(internalProfileTimeRecords[i], internalFrameProfile.timeRecords[i]);
+
+    outFrameProfile->numTimeRecords = internalProfileTimeRecords.size();
+    outFrameProfile->timeRecords = internalProfileTimeRecords.data();
 }
 
 

wrapper/C99/C99TypeAssertions.cpp

@@ -1139,12 +1139,6 @@ LLGL_STATIC_ASSERT_OFFSET(ProfileCommandBufferRecord, renderConditionSections);
 LLGL_STATIC_ASSERT_OFFSET(ProfileCommandBufferRecord, drawCommands);
 LLGL_STATIC_ASSERT_OFFSET(ProfileCommandBufferRecord, dispatchCommands);
 
-LLGL_STATIC_ASSERT_SIZE(ProfileTimeRecord);
-LLGL_STATIC_ASSERT_OFFSET(ProfileTimeRecord, annotation);
-LLGL_STATIC_ASSERT_OFFSET(ProfileTimeRecord, cpuTicksStart);
-LLGL_STATIC_ASSERT_OFFSET(ProfileTimeRecord, cpuTicksEnd);
-LLGL_STATIC_ASSERT_OFFSET(ProfileTimeRecord, elapsedTime);
-
 LLGL_STATIC_ASSERT_SIZE(ColorCodes);
 LLGL_STATIC_ASSERT_OFFSET(ColorCodes, textFlags);
 LLGL_STATIC_ASSERT_OFFSET(ColorCodes, backgroundFlags);