Browse Source

more documentation.

Vicente Penades 6 years ago
parent
commit
39fa59838d
1 changed files with 9 additions and 0 deletions
  1. 9 0
      src/SharpGLTF.DOM/Schema2/gltf.Serialization.cs

+ 9 - 0
src/SharpGLTF.DOM/Schema2/gltf.Serialization.cs

@@ -270,6 +270,9 @@ namespace SharpGLTF.Schema2
         /// </summary>
         /// <param name="filePath">A valid file path to write to.</param>
         /// <param name="fmt">The formatting of the JSON document.</param>
+        /// <remarks>
+        /// Satellite files like buffers and images are also saved with the file name formatted as "FILE_{Index}.EXT".
+        /// </remarks>
         public void SaveGLTF(string filePath, Formatting fmt = Formatting.None)
         {
             Guard.FilePathMustBeValid(filePath, nameof(filePath));
@@ -290,6 +293,9 @@ namespace SharpGLTF.Schema2
         /// </summary>
         /// <param name="settings">A <see cref="WriteSettings"/> to use to write the files.</param>
         /// <param name="baseName">The base name to use for asset files.</param>
+        /// <remarks>
+        /// Satellite files like buffers and images are also written with the file name formatted as "FILE_{Index}.EXT".
+        /// </remarks>
         public void Write(WriteSettings settings, string baseName)
         {
             if (settings.BinaryMode)
@@ -385,6 +391,9 @@ namespace SharpGLTF.Schema2
             {
                 var settings = new WriteSettings(m);
 
+                // ensure that images are embedded.
+                settings.EmbedImages = true;
+
                 Write(settings, "model");
 
                 return m.ToArray();