From d874c8e869effff25d6e67028cce008fc79a4662 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sat, 22 Oct 2022 00:17:30 +0200
Subject: [PATCH] Add missing parts of the doxygen documentation
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/ImageConfig.hpp | 3 +++
include/vkcv/VertexData.hpp | 42 ++++++++++++++++++++++++++++++++++++
2 files changed, 45 insertions(+)
diff --git a/include/vkcv/ImageConfig.hpp b/include/vkcv/ImageConfig.hpp
index 21e9f6d0..eca0b8a3 100644
--- a/include/vkcv/ImageConfig.hpp
+++ b/include/vkcv/ImageConfig.hpp
@@ -9,6 +9,9 @@
namespace vkcv {
+ /**
+ * Structure to configure image before its creation
+ */
struct ImageConfig {
private:
uint32_t m_width;
diff --git a/include/vkcv/VertexData.hpp b/include/vkcv/VertexData.hpp
index 4ee015db..845b9fba 100644
--- a/include/vkcv/VertexData.hpp
+++ b/include/vkcv/VertexData.hpp
@@ -32,6 +32,9 @@ namespace vkcv {
Bit32
};
+ /**
+ * @brief Class to store the details of vertex data for rendering
+ */
class VertexData {
private:
VertexBufferBindings m_bindings;
@@ -40,6 +43,12 @@ namespace vkcv {
size_t m_count;
public:
+ /**
+ * @brief Constructor of vertex data by providing an optional vector
+ * of vertex buffer bindings.
+ *
+ * @param[in] bindings Vertex buffer bindings (optional)
+ */
explicit VertexData(const VertexBufferBindings &bindings = {});
VertexData(const VertexData &other) = default;
@@ -50,17 +59,50 @@ namespace vkcv {
VertexData &operator=(const VertexData &other) = default;
VertexData &operator=(VertexData &&other) noexcept = default;
+ /**
+ * @brief Return the used vertex buffer bindings of the vertex data.
+ *
+ * @return Vertex buffer bindings
+ */
[[nodiscard]] const VertexBufferBindings &getVertexBufferBindings() const;
+ /**
+ * @brief Set the optional index buffer and its used index bit count.
+ *
+ * @param[in] indices Index buffer handle
+ * @param[in] indexBitCount Index bit count
+ */
void setIndexBuffer(const BufferHandle &indices,
IndexBitCount indexBitCount = IndexBitCount::Bit16);
+ /**
+ * @brief Return the handle from the used index buffer of the vertex
+ * data.
+ *
+ * @return Index buffer handle
+ */
[[nodiscard]] const BufferHandle &getIndexBuffer() const;
+ /**
+ * @brief Return the index bit count of the indices used in the
+ * vertex data.
+ *
+ * @return Index bit count
+ */
[[nodiscard]] IndexBitCount getIndexBitCount() const;
+ /**
+ * @brief Set the count of elements to use by the vertex data.
+ *
+ * @param count Count of vertex elements
+ */
void setCount(size_t count);
+ /**
+ * @brief Return the count of elements in use by the vertex data.
+ *
+ * @return Count of vertex elements
+ */
[[nodiscard]] size_t getCount() const;
};
--
GitLab