Documented Vulkan JSON WriteApiCallToFile()

LunarG · Jun 16, 2023 · 8364d13 · 8364d13
1 parent b152a9e
commit 8364d13
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/framework/decode/vulkan_export_json_consumer_base.h b/framework/decode/vulkan_export_json_consumer_base.h
@@ -218,6 +218,9 @@ class VulkanExportJsonConsumerBase : public VulkanConsumer, public AnnotationHan
 
     nlohmann::ordered_json& WriteApiCallStart(const ApiCallInfo& call_info, const std::string& command_name);
 
+    /// A utility wrapper so that manual output functions can provide a lambda which only needs to output
+    /// the fields unique to their call and this tops and tails with the standard boilerplate, defining it
+    /// once here. Generated functions avoid the indirection through this.
     template <typename ToJsonFunctionType>
     inline void
     WriteApiCallToFile(const ApiCallInfo& call_info, const std::string& command_name, ToJsonFunctionType toJsonFunction)