Merge pull request #401 from alteous/main

Version 1.4.0

CHANGELOG.md

@@ -8,6 +8,24 @@ The `gltf` crate adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## [1.4.0] - 2023-12-17
+
+### Added
+
+- New API for reading arbitary extension data.
+- Interval improvements to prevent panics on 32 bit systems when loading large glTF files.
+
+### Changed
+
+- Offsets and sizes in the `gltf-json` crate have been widened to 64 bits.
+- Loading glTF on a 32 bit system containing offsets or sizes larger than `u32` will
+  result in a validation error.
+
+### Fixed
+
+- `Gltf::from_reader` no longer winds the reader back to offset zero.
+- Broken link in `Material::unlit` documentation.
+
 ## [1.3.0] - 2023-08-21
 
 ### Added

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gltf"
-version = "1.3.0"
+version = "1.4.0"
 authors = ["David Harvey-Macaulay <[email protected]>"]
 description = "glTF 2.0 loader"
 documentation = "https://docs.rs/gltf"
@@ -25,7 +25,7 @@ approx = "0.5"
 [dependencies]
 base64 = { optional = true, version = "0.13" }
 byteorder = "1.3"
-gltf-json = { path = "gltf-json", version = "1.3.0" }
+gltf-json = { path = "gltf-json", version = "1.4.0" }
 lazy_static = "1"
 urlencoding = { optional = true, version = "2.1" }
 serde_json = { features = ["raw_value"], version = "1.0" }

gltf-derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gltf-derive"
-version = "1.3.0"
+version = "1.4.0"
 authors = ["David Harvey-Macaulay <[email protected]>"]
 description = "Internal macros for the gltf crate"
 repository = "https://github.com/gltf-rs/gltf"

gltf-json/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gltf-json"
-version = "1.3.0"
+version = "1.4.0"
 authors = ["David Harvey-Macaulay <[email protected]>"]
 description = "JSON parsing for the gltf crate"
 repository = "https://github.com/gltf-rs/gltf"
@@ -9,7 +9,7 @@ edition = "2021"
 rust-version = "1.61"
 
 [dependencies]
-gltf-derive = { path = "../gltf-derive", version = "1.3.0" }
+gltf-derive = { path = "../gltf-derive", version = "1.4.0" }
 serde = "1.0"
 serde_derive = "1.0"
 serde_json = { features = ["raw_value"], version = "1.0" }

src/accessor/mod.rs

@@ -140,15 +140,15 @@ impl<'a> Accessor<'a> {
         self.json.component_type.unwrap().0
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/animation/mod.rs

@@ -113,15 +113,15 @@ impl<'a> Animation<'a> {
         }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/buffer.rs

@@ -103,15 +103,15 @@ impl<'a> Buffer<'a> {
         self.json.name.as_deref()
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {
@@ -186,15 +186,15 @@ impl<'a> View<'a> {
         self.json.target.map(|target| target.unwrap())
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/camera.rs

@@ -89,15 +89,15 @@ impl<'a> Camera<'a> {
         }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {
@@ -137,15 +137,15 @@ impl<'a> Orthographic<'a> {
         self.json.znear
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {
@@ -185,15 +185,15 @@ impl<'a> Perspective<'a> {
         self.json.znear
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/image.rs

@@ -131,15 +131,15 @@ impl<'a> Image<'a> {
         }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/lib.rs

@@ -446,15 +446,15 @@ impl Document {
         }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let root = self.0.extensions.as_ref()?;
         Some(&root.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/material.rs

@@ -96,7 +96,7 @@ impl<'a> Material<'a> {
         PbrMetallicRoughness::new(self.document, &self.json.pbr_metallic_roughness)
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
@@ -239,7 +239,7 @@ impl<'a> Material<'a> {
     /// Returns `true` if the [`KHR_materials_unlit`] property was specified, in which
     /// case the renderer should prefer to ignore all PBR values except `baseColor`.
     ///
-    /// [`KHR_materials_unlit`](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit#overview)
+    /// [`KHR_materials_unlit`]: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit#overview
     #[cfg(feature = "KHR_materials_unlit")]
     #[cfg_attr(docsrs, doc(cfg(feature = "KHR_materials_unlit")))]
     pub fn unlit(&self) -> bool {
@@ -320,7 +320,7 @@ impl<'a> PbrMetallicRoughness<'a> {
         })
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
@@ -610,7 +610,7 @@ impl<'a> NormalTexture<'a> {
         self.texture.clone()
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
@@ -665,7 +665,7 @@ impl<'a> OcclusionTexture<'a> {
         self.texture.clone()
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {

src/mesh/mod.rs

@@ -148,15 +148,15 @@ impl<'a> Mesh<'a> {
         self.index
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {
@@ -215,15 +215,15 @@ impl<'a> Primitive<'a> {
         Bounds { min, max }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/scene/mod.rs

@@ -145,15 +145,15 @@ impl<'a> Node<'a> {
         }
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {
@@ -245,15 +245,15 @@ impl<'a> Scene<'a> {
         self.index
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {

src/skin/mod.rs

@@ -46,15 +46,15 @@ impl<'a> Skin<'a> {
         self.index
     }
 
-    /// Returns the extension values map
+    /// Returns extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extensions(&self) -> Option<&Map<String, Value>> {
         let ext = self.json.extensions.as_ref()?;
         Some(&ext.others)
     }
 
-    /// Return a value for a given extension name
+    /// Queries extension data unknown to this crate version.
     #[cfg(feature = "extensions")]
     #[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
     pub fn extension_value(&self, ext_name: &str) -> Option<&Value> {