From b2e4fb6deb4b67f20dc91e7fff17b2ab69cc4738 Mon Sep 17 00:00:00 2001 From: Sean Lilley Date: Fri, 11 Aug 2017 12:01:23 -0400 Subject: [PATCH] Add doc --- lib/loadMtl.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/loadMtl.js b/lib/loadMtl.js index 62a58ed..bc10fba 100644 --- a/lib/loadMtl.js +++ b/lib/loadMtl.js @@ -17,6 +17,11 @@ module.exports = loadMtl; /** * Parse a .mtl file and load textures referenced within. Returns an array of glTF materials with Texture * objects stored in the texture slots. + *

+ * Packed PBR textures (like metallicRoughnessOcclusion and specularGlossiness) require all input textures to be decoded before hand. + * If a texture is of an unsupported format like .gif or .tga it can't be packed and a metallicRoughness texture will not be created. + * Similarly if a texture cannot be found it will be ignored and a default value will be used instead. + *

* * @param {String} mtlPath Path to the .mtl file. * @param {Object} options The options object passed along from lib/obj2gltf.js