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

Add missing parts of the doxygen documentation

parent 053a89cd
Branches
Tags
No related merge requests found
......@@ -9,6 +9,9 @@
namespace vkcv {
/**
* Structure to configure image before its creation
*/
struct ImageConfig {
private:
uint32_t m_width;
......
......@@ -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;
};
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment