From 038154363d5a066811748eacb1c32bfb50ec10f9 Mon Sep 17 00:00:00 2001
From: Trevor Hollmann <thollmann@uni-koblenz.de>
Date: Tue, 17 Aug 2021 09:41:58 +0200
Subject: [PATCH] [#79] Add missing documentation for loadTexture()
---
modules/asset_loader/include/vkcv/asset/asset_loader.hpp | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
index fc35b652..c1f5b4a8 100644
--- a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
+++ b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
@@ -303,7 +303,13 @@ struct Mesh {
int loadScene(const std::filesystem::path &path, Scene &scene);
/**
- * TODO document
+ * Simply loads a single image at the given path and returns a Texture
+ * struct describing it. This is for special use cases only (eg.
+ * loading a font atlas) and not meant to be used for regular assets.
+ * The sampler is set to -1, signalling that this Texture was loaded
+ * outside the context of a glTF-file.
+ *
+ * @param path must be the path to an image file
*/
Texture loadTexture(const std::filesystem::path& path);
}
--
GitLab