diff --git a/include/vkcv/DrawcallRecording.hpp b/include/vkcv/DrawcallRecording.hpp index 750685f0da15225a811643334bee933fbcd63b40..abcd8d6f95c417289935a5850b850758b4fea38d 100644 --- a/include/vkcv/DrawcallRecording.hpp +++ b/include/vkcv/DrawcallRecording.hpp @@ -31,7 +31,10 @@ namespace vkcv { Bit16, Bit32 }; - + + /** + * @brief Structure to configure a descriptor set usage. + */ struct DescriptorSetUsage { inline DescriptorSetUsage(uint32_t setLocation, DescriptorSetHandle descriptorSet, const std::vector<uint32_t>& dynamicOffsets = {}) noexcept : @@ -43,7 +46,10 @@ namespace vkcv { const DescriptorSetHandle descriptorSet; const std::vector<uint32_t> dynamicOffsets; }; - + + /** + * @brief Structure to store details of a mesh to draw. + */ struct Mesh { inline Mesh() {} @@ -62,7 +68,10 @@ namespace vkcv { IndexBitCount indexBitCount; }; - + + /** + * @brief Structure to store details for a drawcall. + */ struct DrawcallInfo { inline DrawcallInfo(const Mesh& mesh, const std::vector<DescriptorSetUsage>& descriptorSets, @@ -78,6 +87,9 @@ namespace vkcv { void InitMeshShaderDrawFunctions(vk::Device device); + /** + * @brief Structure to store details for a mesh shader drawcall. + */ struct MeshShaderDrawcall { std::vector<DescriptorSetUsage> descriptorSets; uint32_t taskCount; diff --git a/include/vkcv/QueueManager.hpp b/include/vkcv/QueueManager.hpp index 163021e6fc9d4fb8c57a82378ec1fa3f76a0a951..04a5d8a0a59b2655673d073a7a36467df0ab8a17 100644 --- a/include/vkcv/QueueManager.hpp +++ b/include/vkcv/QueueManager.hpp @@ -10,7 +10,7 @@ namespace vkcv { /** - * Enum class to represent types of queues. + * @brief Enum class to represent types of queues. */ enum class QueueType { Compute, @@ -20,7 +20,7 @@ namespace vkcv { }; /** - * Struct to represent a queue, provide its family and its index. + * @brief Structure to represent a queue and its details. */ struct Queue { int familyIndex; @@ -30,7 +30,7 @@ namespace vkcv { }; /** - * Class to manage queues of a device. + * @brief Class to manage queues of a device. */ class QueueManager { public: