From 6243023aa54b7fe04116d1c1f976bd9a7c9097e2 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Fri, 30 Sep 2022 20:25:14 +0200
Subject: [PATCH] Adjust comments and fix typo
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
.../include/vkcv/upscaling/BilinearUpscaling.hpp | 2 +-
.../upscaling/include/vkcv/upscaling/FSR2Upscaling.hpp | 8 ++++++--
modules/upscaling/include/vkcv/upscaling/FSRUpscaling.hpp | 2 +-
modules/upscaling/include/vkcv/upscaling/NISUpscaling.hpp | 2 +-
modules/upscaling/include/vkcv/upscaling/Upscaling.hpp | 2 +-
5 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/modules/upscaling/include/vkcv/upscaling/BilinearUpscaling.hpp b/modules/upscaling/include/vkcv/upscaling/BilinearUpscaling.hpp
index 4f0bfea8..a3f29276 100644
--- a/modules/upscaling/include/vkcv/upscaling/BilinearUpscaling.hpp
+++ b/modules/upscaling/include/vkcv/upscaling/BilinearUpscaling.hpp
@@ -23,7 +23,7 @@ namespace vkcv::upscaling {
explicit BilinearUpscaling(Core& core);
/**
- * Record the comands of the bilinear upscaling instance to
+ * Record the commands of the bilinear upscaling instance to
* scale the image of the input handle to the resolution of
* the output image handle via bilinear interpolation.
*
diff --git a/modules/upscaling/include/vkcv/upscaling/FSR2Upscaling.hpp b/modules/upscaling/include/vkcv/upscaling/FSR2Upscaling.hpp
index f10b23ec..d8402c03 100644
--- a/modules/upscaling/include/vkcv/upscaling/FSR2Upscaling.hpp
+++ b/modules/upscaling/include/vkcv/upscaling/FSR2Upscaling.hpp
@@ -174,9 +174,13 @@ namespace vkcv::upscaling {
void bindVelocityBuffer(const ImageHandle& velocityInput);
/**
- * Record the comands of the FSR2 upscaling instance to
+ * Record the commands of the FSR2 upscaling instance to
* scale the image of the input handle to the resolution of
- * the output image handle via FidelityFX Super Resolution.
+ * the output image handle via FidelityFX Super Resolution
+ * and dispatch them.
+ *
+ * Beware that this method will dispatch the commands
+ * automatically!
*
* @param[in] cmdStream Command stream handle to record commands
* @param[in] colorInput Color input image handle
diff --git a/modules/upscaling/include/vkcv/upscaling/FSRUpscaling.hpp b/modules/upscaling/include/vkcv/upscaling/FSRUpscaling.hpp
index 5330c063..5a4c59ef 100644
--- a/modules/upscaling/include/vkcv/upscaling/FSRUpscaling.hpp
+++ b/modules/upscaling/include/vkcv/upscaling/FSRUpscaling.hpp
@@ -188,7 +188,7 @@ namespace vkcv::upscaling {
explicit FSRUpscaling(Core& core);
/**
- * Record the comands of the FSR upscaling instance to
+ * Record the commands of the FSR upscaling instance to
* scale the image of the input handle to the resolution of
* the output image handle via FidelityFX Super Resolution.
*
diff --git a/modules/upscaling/include/vkcv/upscaling/NISUpscaling.hpp b/modules/upscaling/include/vkcv/upscaling/NISUpscaling.hpp
index 91398340..62fadf83 100644
--- a/modules/upscaling/include/vkcv/upscaling/NISUpscaling.hpp
+++ b/modules/upscaling/include/vkcv/upscaling/NISUpscaling.hpp
@@ -84,7 +84,7 @@ namespace vkcv::upscaling {
explicit NISUpscaling(Core &core);
/**
- * Record the comands of the NIS upscaling instance to
+ * Record the commands of the NIS upscaling instance to
* scale the image of the input handle to the resolution of
* the output image handle via NVIDIA Image Scaling.
*
diff --git a/modules/upscaling/include/vkcv/upscaling/Upscaling.hpp b/modules/upscaling/include/vkcv/upscaling/Upscaling.hpp
index 4d04746f..06e35208 100644
--- a/modules/upscaling/include/vkcv/upscaling/Upscaling.hpp
+++ b/modules/upscaling/include/vkcv/upscaling/Upscaling.hpp
@@ -32,7 +32,7 @@ namespace vkcv::upscaling {
~Upscaling() = default;
/**
- * Record the comands of the given upscaling instance to
+ * Record the commands of the given upscaling instance to
* scale the image of the input handle to the resolution of
* the output image handle.
*
--
GitLab