From 4aaa2734c9bf59942bec3794d1da34a35640ef7f Mon Sep 17 00:00:00 2001 From: Trevor Hollmann <thollmann@uni-koblenz.de> Date: Tue, 22 Jun 2021 09:53:48 +0200 Subject: [PATCH] [#79] Fix documenting comment of materialHasTexture. --- .../asset_loader/include/vkcv/asset/asset_loader.hpp | 10 ++++++++-- 1 file changed, 8 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 b8b043a1..314d45fa 100644 --- a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp +++ b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp @@ -158,10 +158,16 @@ enum class PBRTextureTarget { * contact with bit-level operations. */ #define bitflag(ENUM) (0x1u << ((unsigned)(ENUM))) -/** To signal that a certain texture target is active in a Material struct, its +/** + * To signal that a certain texture target is active in a Material struct, its * bit is set in the textureMask. You can use this function to check that: * Material mat = ...; - * if (materialHasTexture(&mat, baseColor)) {...} */ + * if (materialHasTexture(&mat, baseColor)) {...} + * @param m The material to query + * @param t The target to query for + * @return Boolean to signal whether the texture target is active in the + * material. + */ bool materialHasTexture(const Material *const m, const PBRTextureTarget t); /** With these enums, 0 is reserved to signal uninitialized or invalid data. */ -- GitLab