com.atteneder.gltfast Release 6.15.1

Author: atteneder

.github/workflows/dotnet-format.yml

@@ -61,7 +61,7 @@ jobs:
       image: europe-docker.pkg.dev/unity-cds-services-prd/ds-docker/unity-ci-format:latest@sha256:73b38fb713c2b95a142ffe870c6e130edda9d3aad61adadfda24fe985973f6b1
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           ref: ${{ inputs.GIT_BRANCH }}
           filter: blob:none

CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.15.1] - 2025-12-09
+
+### Added
+- Assigned glTF logo to [GltfEntityAsset](xref:GLTFast.GltfEntityAsset) component.
+- (Test) Test glTF asset *CylinderWithMaterial* that's procedurally generated at runtime.
+- (Test) Tests for documentation examples.
+- (Test) `OpenGltfScene` improvements.
+  - Refactored to use custom load method.
+  - Load method option to choose between loading from file or URI.
+  - Scene index option.
+  - Informative console logs with file path/URI and load time.
+  - Now works at runtime as well (without file dialog).
+  - Re-positions camera so that the loaded glTF scene is framed.
+  - Can load via [EntityInstantiator](xref:GLTFast.EntityInstantiator).
+
+### Changed
+- (Entities) Entities of a scene are grouped via `LinkedEntityGroup`.
+- (Performance) Import mesh indices as unsigned integers and don't convert to signed integers anymore.
+- (Performance) Limited copy buffer size, so that garbage allocations do not scale with glTF-Binary content size anymore (when loading from file or `Stream`).
+- (Performance) Large glTF-Binary content is now loaded into memory in smaller chunks, which keeps the frame rate smooth (when loading from file or `Stream`).
+- (Performance) Shift loading glTF-Binary from stream to memory to a background thread, if it won't likely fit within the current update loop.
+- (Performance) glTF-Binary buffers are not initialized with zeros before population.
+- [meshoptimizer mesh compression for Unity] minimum required version was raised to 0.2.0-exp.1.
+- (Test) Updated tests dependency Graphics Test Framework (com.unity.testframework.graphics) to 8.13.1-exp.1.
+
+### Fixed
+- Returning a proper error for glTF-Binary with a content length shorter than what's depicted in the header.
+- NotSupportedException when loading a glTF-Binary file with excess length (fixes [#786](https://github.com/atteneder/glTFast/issues/786)).
+- (Documentation) Clarified how to add export shader variants.
+- (Test) Fixed generated test glTFs by exporting them in synchronous mode (only available internally).
+- (Importer) Synchronization Context is now properly reset after an exception (thanks [Bruno](https://github.com/bruno1308) for [#29](https://github.com/Unity-Technologies/com.unity.cloud.gltfast/pull/29)).
+- Removed compiler warning when `GLTFAST_SAFE` scripting define is active.
+- (Test) Stabilize tests by executing `LogAssert.Expect` before actual tests.
+- (Entities) Sub-meshes are rendered properly.
+- (Test) Tests destroy the glTF entities before disposing meshes/materials to avoid batch rendering errors.
+
 ## [6.15.0] - 2025-11-17
 
 ### Added
@@ -42,6 +78,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 - Broken consistency check between image data URI mediatype against image's mimeType.
+- Support for obsolete Hybrid Renderer (com.unity.rendering.hybrid).
 
 ## [6.14.1] - 2025-09-30
 
@@ -145,7 +182,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [6.10.2] - 2025-02-03
 
 ### Added
-- (Importer) *Textures Readable* checkbox in the imnporter inspector (*Textures* section).
+- (Importer) *Textures Readable* checkbox in the importer inspector (*Textures* section).
 - (Export) Error message when attempting to export with unsupported meshopt compression.
 - (Tests) Runtime import performance tests.
 - (Tests) Procedurally generated glTFs for testing purpose.
@@ -370,7 +407,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - All missing extensions are logged (not just the first one).
   - There's now a single message per missing package.
   - Depending on whether that extension is required the message's type is warning or error.
-  - Added explicit message when [*meshoptimizer decompression for Unity*][meshoptUnity] is missing.
+  - Added explicit message when [meshoptimizer mesh compression for Unity] is missing.
 
 ## [6.3.0] - 2024-03-27
 
@@ -1482,7 +1519,7 @@ This release contains multiple breaking changes. Please read the [upgrade guide]
 [Draco for Unity]: https://docs.unity3d.com/Packages/com.unity.cloud.draco@latest
 [DracoUnity]: https://github.com/atteneder/DracoUnity
 [PolySpatialVisionOS]: https://docs.unity3d.com/Packages/com.unity.polyspatial.visionos@latest/
-[meshoptUnity]: https://docs.unity3d.com/Packages/com.unity.meshopt.decompress@latest/
+[meshoptimizer mesh compression for Unity]: https://docs.unity3d.com/Packages/com.unity.meshopt.decompress@latest/
 [aurorahcx]: https://github.com/aurorahcx
 [Battlehub0x]: https://github.com/Battlehub0x
 [Bersaelor]: https://github.com/Bersaelor

DocExamples/AssemblyInfo.cs

@@ -0,0 +1,6 @@
+// SPDX-FileCopyrightText: 2025 Unity Technologies and the glTFast authors
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("glTFast.Tests")]

DocExamples/AssemblyInfo.cs.meta

@@ -1,30 +1,35 @@
 // SPDX-FileCopyrightText: 2023 Unity Technologies and the glTFast authors
 // SPDX-License-Identifier: Apache-2.0
 
-using GLTFast.Logging;
-
 #if NEWTONSOFT_JSON
 namespace GLTFast.Documentation.Examples
 {
 #region CustomGltfImport
-    using GLTFast;
-    using Addons;
     using System;
+    using System.Threading.Tasks;
+    using Addons;
+    using GLTFast;
+    using GLTFast.Logging;
     using UnityEngine;
     using GltfImport = GLTFast.Newtonsoft.GltfImport;
 
     class CustomGltfImport : MonoBehaviour
     {
         // Path to the gltf asset to be imported
-        public string Uri;
+        public string uri;
 
         async void Start()
+        {
+            await LoadGltf();
+        }
+
+        public async Task LoadGltf()
         {
             try
             {
                 ImportAddonRegistry.RegisterImportAddon(new MyAddon());
                 var gltfImport = new GltfImport(logger:new ConsoleLogger());
-                await gltfImport.Load(Uri);
+                await gltfImport.Load(uri);
                 await gltfImport.InstantiateMainSceneAsync(transform);
             }
             catch (Exception e)
@@ -33,8 +38,9 @@ async void Start()
             }
         }
 
-        public class MyAddon : ImportAddon<MyAddonInstance> { }
-        public class MyAddonInstance : ImportAddonInstance
+        class MyAddon : ImportAddon<MyAddonInstance> { }
+
+        class MyAddonInstance : ImportAddonInstance
         {
             GltfImport m_GltfImport;
 
@@ -55,7 +61,7 @@ public override void Inject(IInstantiator instantiator)
                 var goInstantiator = instantiator as GameObjectInstantiator;
                 if (goInstantiator == null)
                     return;
-                var _ = new MyInstantiatorAddon(m_GltfImport, goInstantiator);
+                _ = new MyInstantiatorAddon(m_GltfImport, goInstantiator);
             }
 
             public override bool SupportsGltfExtension(string extensionName)
@@ -67,8 +73,8 @@ public override bool SupportsGltfExtension(string extensionName)
 
     class MyInstantiatorAddon
     {
-        GltfImport m_GltfImport;
-        GameObjectInstantiator m_Instantiator;
+        readonly GltfImport m_GltfImport;
+        readonly GameObjectInstantiator m_Instantiator;
 
         public MyInstantiatorAddon(GltfImport gltfImport, GameObjectInstantiator instantiator)
         {

DocExamples/CustomGltfImport.cs

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using System.Threading.Tasks;
-using UnityEngine.Serialization;
 
 namespace GLTFast.Documentation.Examples
 {
@@ -13,12 +12,9 @@ namespace GLTFast.Documentation.Examples
 
     class ExportSamples : MonoBehaviour
     {
+        public string destinationFilePath;
 
-        [FormerlySerializedAs("path")]
-        [SerializeField]
-        string destinationFilePath;
-
-        async Task AdvancedExport()
+        public async Task AdvancedExport()
         {
             #region AdvancedExport
 
@@ -82,7 +78,7 @@ async Task AdvancedExport()
             #endregion
         }
 
-        void ExportSettingsDraco()
+        public static ExportSettings ExportSettingsDraco()
         {
             #region ExportSettingsDraco
             // ExportSettings provides generic export settings
@@ -97,14 +93,15 @@ void ExportSettingsDraco()
                 }
             };
             #endregion
+            return exportSettings;
         }
 
         async void Start()
         {
             await LocalTransform();
         }
 
-        async Task LocalTransform()
+        public async Task LocalTransform()
         {
             #region LocalTransform
             var export = new GameObjectExport();

DocExamples/ExportSamples.cs

@@ -42,15 +42,16 @@ async Task LoadGltfFile()
         }
         #endregion
 
-        void LoadViaComponent()
+        public void LoadViaComponent()
         {
             #region LoadViaComponent
             var gltf = gameObject.AddComponent<GltfAsset>();
             gltf.Url = "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Assets/main/Models/Duck/glTF/Duck.gltf";
             #endregion
+            gltf.LoadOnStartup = false;
         }
 
-        async Task ImportSettings()
+        public static async Task ImportSettings(string filePath)
         {
             #region ImportSettings
             var gltf = new GltfImport();
@@ -63,7 +64,7 @@ async Task ImportSettings()
                 NodeNameMethod = NameImportMethod.OriginalUnique
             };
             // Load the glTF and pass along the settings
-            var success = await gltf.Load("file:///path/to/file.gltf", settings);
+            var success = await gltf.Load(filePath, settings);
 
             if (success)
             {
@@ -77,12 +78,12 @@ async Task ImportSettings()
             #endregion
         }
 
-        async Task Instantiation()
+        public async Task Instantiation()
         {
             #region Instantiation
             // First step: load glTF
             var gltf = new GLTFast.GltfImport();
-            var success = await gltf.Load("file:///path/to/file.gltf");
+            var success = await gltf.Load(filePath);
 
             if (success)
             {
@@ -111,16 +112,15 @@ async Task Instantiation()
         }
 
 #if UNITY_ANIMATION
-        async Task SceneInstanceAccess()
+        public async Task SceneInstanceAccess()
         {
             #region SceneInstanceAccess
             var gltfImport = new GltfImport();
-            await gltfImport.Load("test.gltf");
+            await gltfImport.Load(filePath);
             var instantiator = new GameObjectInstantiator(gltfImport, transform);
             var success = await gltfImport.InstantiateMainSceneAsync(instantiator);
             if (success)
             {
-
                 // Get the SceneInstance to access the instance's properties
                 var sceneInstance = instantiator.SceneInstance;
 
@@ -150,17 +150,17 @@ async Task SceneInstanceAccess()
         }
 #endif // UNITY_ANIMATION
 
-        async Task CustomDeferAgent()
+        public async Task CustomDeferAgent()
         {
             var manyUrls = new[]
             {
                 "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Assets/main/Models/Duck/glTF/Duck.gltf"
             };
             #region CustomDeferAgent
             // Recommended: Use a common defer agent across multiple GltfImport instances!
-            // For a stable frame rate:
+            // TimeBudgetPerFrameDeferAgent for a stable frame rate:
             IDeferAgent deferAgent = gameObject.AddComponent<TimeBudgetPerFrameDeferAgent>();
-            // Or for faster loading:
+            // Or alternatively, UninterruptedDeferAgent for low latency loading:
             deferAgent = new UninterruptedDeferAgent();
 
             var tasks = new List<Task>();