Skip to content
Snippets Groups Projects
Verified Commit 6dd52585 authored by Tobias Frisch's avatar Tobias Frisch
Browse files

Adjusting a few pieces of doxygen comments

parent 07eda6f6
No related branches found
No related tags found
1 merge request!97Resolve "Dokumentation vervollständigen"
......@@ -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;
......
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment