From 1ba3d40de460a54fba5f0078808d7fe60fa573f8 Mon Sep 17 00:00:00 2001
From: Trevor Hollmann <thollmann@uni-koblenz.de>
Date: Tue, 3 Aug 2021 10:33:43 +0200
Subject: [PATCH] [#79] Update documentation of asset loader.
---
modules/asset_loader/include/vkcv/asset/asset_loader.hpp | 6 +++++-
modules/asset_loader/src/vkcv/asset/asset_loader.cpp | 3 ++-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
index 2b14ccc0..fc35b652 100644
--- a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
+++ b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
@@ -269,6 +269,8 @@ struct Mesh {
* initialized and all information is final, except for the missing binary
* data. This means that indices to vectors will remain valid even when the
* shallow scene struct is filled with data by loadMesh().
+ * Note that for URIs only (local) filesystem paths are supported, no
+ * URLs using network protocols etc.
*
* @param path must be the path to a glTF- or glb-file.
* @param scene is a reference to a Scene struct that will be filled with the
@@ -300,6 +302,8 @@ struct Mesh {
*/
int loadScene(const std::filesystem::path &path, Scene &scene);
+ /**
+ * TODO document
+ */
Texture loadTexture(const std::filesystem::path& path);
-
}
diff --git a/modules/asset_loader/src/vkcv/asset/asset_loader.cpp b/modules/asset_loader/src/vkcv/asset/asset_loader.cpp
index 56ae8f5c..5ce21ec8 100644
--- a/modules/asset_loader/src/vkcv/asset/asset_loader.cpp
+++ b/modules/asset_loader/src/vkcv/asset/asset_loader.cpp
@@ -342,7 +342,8 @@ namespace vkcv::asset {
}
/**
- * TODO document
+ * Initializes vertex groups of a Mesh, including copying the data to
+ * index- and vertex-buffers.
*/
static int loadVertexGroups(const fx::gltf::Mesh &objectMesh,
const fx::gltf::Document &sceneObjects,
--
GitLab