diff --git a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp index fc35b652bdef6e01e922c4f3e583f8bad3a4de72..c1f5b4a81650af5ca00fe049953ce04ea10c1ec9 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); }