From 63c009c53050a328f823522a1ee106d2eb7998e7 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sat, 10 Dec 2022 01:14:16 +0100
Subject: [PATCH] Add doxygen group comments
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
.../vkcv/effects/BloomAndFlaresEffect.hpp | 11 ++++++--
.../effects/include/vkcv/effects/Effect.hpp | 8 ++++++
.../vkcv/effects/GammaCorrectionEffect.hpp | 10 +++++++-
.../include/vkcv/tone/ACESToneMapping.hpp | 7 ++++++
.../include/vkcv/tone/FilmicToneMapping.hpp | 7 ++++++
.../include/vkcv/tone/LottesToneMapping.hpp | 7 ++++++
.../vkcv/tone/Reinhard2ToneMapping.hpp | 7 ++++++
.../include/vkcv/tone/ReinhardToneMapping.hpp | 7 ++++++
.../include/vkcv/tone/ToneMapping.hpp | 25 ++++++++++++++++++-
.../include/vkcv/tone/UchimuraToneMapping.hpp | 7 ++++++
.../vkcv/tone/Uncharted2ToneMapping.hpp | 7 ++++++
.../include/vkcv/tone/UnrealToneMapping.hpp | 7 ++++++
12 files changed, 106 insertions(+), 4 deletions(-)
diff --git a/modules/effects/include/vkcv/effects/BloomAndFlaresEffect.hpp b/modules/effects/include/vkcv/effects/BloomAndFlaresEffect.hpp
index f4a9d03d..71b8d1e4 100644
--- a/modules/effects/include/vkcv/effects/BloomAndFlaresEffect.hpp
+++ b/modules/effects/include/vkcv/effects/BloomAndFlaresEffect.hpp
@@ -7,6 +7,11 @@
namespace vkcv::effects {
+ /**
+ * @addtogroup vkcv_effects
+ * @{
+ */
+
class BloomAndFlaresEffect : public Effect {
private:
bool m_advanced;
@@ -57,8 +62,8 @@ namespace vkcv::effects {
const ImageHandle &output);
public:
- BloomAndFlaresEffect(Core& core,
- bool advanced = false);
+ explicit BloomAndFlaresEffect(Core& core,
+ bool advanced = false);
void recordEffect(const CommandStreamHandle &cmdStream,
const ImageHandle &input,
@@ -70,4 +75,6 @@ namespace vkcv::effects {
};
+ /** @} */
+
}
diff --git a/modules/effects/include/vkcv/effects/Effect.hpp b/modules/effects/include/vkcv/effects/Effect.hpp
index d068fb59..f81d3d7b 100644
--- a/modules/effects/include/vkcv/effects/Effect.hpp
+++ b/modules/effects/include/vkcv/effects/Effect.hpp
@@ -5,6 +5,12 @@
namespace vkcv::effects {
+ /**
+ * @defgroup vkcv_effects Effects Module
+ * A module to apply certain post-processing effects to an image in realtime.
+ * @{
+ */
+
class Effect {
protected:
Core& m_core;
@@ -20,4 +26,6 @@ namespace vkcv::effects {
};
+ /** @} */
+
}
diff --git a/modules/effects/include/vkcv/effects/GammaCorrectionEffect.hpp b/modules/effects/include/vkcv/effects/GammaCorrectionEffect.hpp
index 93a90b82..1c41bdd3 100644
--- a/modules/effects/include/vkcv/effects/GammaCorrectionEffect.hpp
+++ b/modules/effects/include/vkcv/effects/GammaCorrectionEffect.hpp
@@ -4,6 +4,11 @@
namespace vkcv::effects {
+ /**
+ * @addtogroup vkcv_effects
+ * @{
+ */
+
class GammaCorrectionEffect : public Effect {
private:
float m_gamma;
@@ -15,7 +20,7 @@ namespace vkcv::effects {
DescriptorSetHandle m_descriptorSet;
public:
- GammaCorrectionEffect(Core& core);
+ explicit GammaCorrectionEffect(Core& core);
void recordEffect(const CommandStreamHandle& cmdStream,
const ImageHandle& input,
@@ -23,8 +28,11 @@ namespace vkcv::effects {
void setGamma(float gamma);
+ [[nodiscard]]
float getGamma() const;
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/ACESToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/ACESToneMapping.hpp
index 247d1d06..de1c02c5 100644
--- a/modules/tone_mapping/include/vkcv/tone/ACESToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/ACESToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class ACESToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/FilmicToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/FilmicToneMapping.hpp
index 6ed77ad8..c25e1b74 100644
--- a/modules/tone_mapping/include/vkcv/tone/FilmicToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/FilmicToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class FilmicToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/LottesToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/LottesToneMapping.hpp
index 444b5fb3..37dad903 100644
--- a/modules/tone_mapping/include/vkcv/tone/LottesToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/LottesToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class LottesToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/Reinhard2ToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/Reinhard2ToneMapping.hpp
index 2e678083..9bcf9f9e 100644
--- a/modules/tone_mapping/include/vkcv/tone/Reinhard2ToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/Reinhard2ToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class Reinhard2ToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/ReinhardToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/ReinhardToneMapping.hpp
index 1b74dcce..ac7fb5c9 100644
--- a/modules/tone_mapping/include/vkcv/tone/ReinhardToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/ReinhardToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class ReinhardToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/ToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/ToneMapping.hpp
index 467ca74f..00e8c287 100644
--- a/modules/tone_mapping/include/vkcv/tone/ToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/ToneMapping.hpp
@@ -4,6 +4,12 @@
namespace vkcv::tone {
+ /**
+ * @defgroup vkcv_tone Tone Mapping Module
+ * A module to apply tone mapping to an image in realtime.
+ * @{
+ */
+
class ToneMapping {
private:
/**
@@ -11,9 +17,19 @@ namespace vkcv::tone {
*/
Core& m_core;
+ /**
+ * The name of the tone mapping instance.
+ */
std::string m_name;
+
+ /**
+ * Flag whether tone mapping should normalize before mapping.
+ */
bool m_normalize;
+ /**
+ * The compute pipeline of the tone mapping instance.
+ */
ComputePipelineHandle m_pipeline;
/**
@@ -41,7 +57,7 @@ namespace vkcv::tone {
*
* @param[in,out] core Reference to a Core instance
* @param[in] name Name of the tone mapping function
- * @param[in] normalize Normalize color values
+ * @param[in] normalize (Optional) Flag to normalize color values
*/
explicit ToneMapping(Core& core,
const std::string& name,
@@ -49,6 +65,11 @@ namespace vkcv::tone {
~ToneMapping() = default;
+ /**
+ * Return name of the tone mapping instance.
+ *
+ * @return Name of the tone mapping
+ */
[[nodiscard]]
const std::string& getName() const;
@@ -67,4 +88,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/UchimuraToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/UchimuraToneMapping.hpp
index ad2e4f11..83afa0c2 100644
--- a/modules/tone_mapping/include/vkcv/tone/UchimuraToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/UchimuraToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class UchimuraToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/Uncharted2ToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/Uncharted2ToneMapping.hpp
index 99a4d6c7..fc1db5b4 100644
--- a/modules/tone_mapping/include/vkcv/tone/Uncharted2ToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/Uncharted2ToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class Uncharted2ToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
diff --git a/modules/tone_mapping/include/vkcv/tone/UnrealToneMapping.hpp b/modules/tone_mapping/include/vkcv/tone/UnrealToneMapping.hpp
index a5e1f717..10fb9cc6 100644
--- a/modules/tone_mapping/include/vkcv/tone/UnrealToneMapping.hpp
+++ b/modules/tone_mapping/include/vkcv/tone/UnrealToneMapping.hpp
@@ -4,6 +4,11 @@
namespace vkcv::tone {
+ /**
+ * @addtogroup vkcv_tone
+ * @{
+ */
+
class UnrealToneMapping : public ToneMapping {
private:
void initToneMapping() override;
@@ -13,4 +18,6 @@ namespace vkcv::tone {
};
+ /** @} */
+
}
--
GitLab