Struct GltfReader

Source

pub struct GltfReader { /* private fields */ }

Available on crate feature gltf-reader only.

Expand description

A reader for glTF/GLB files with Draco mesh decompression support.

Implementations§

Source §

impl GltfReader

Source

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a glTF or GLB file.

The file type is detected automatically based on the magic bytes.

Source

pub fn from_glb(data: &[u8]) -> Result<Self>

Parse from GLB binary data.

Source

pub fn from_bytes(data: &[u8]) -> Result<Self>

Parse from glTF JSON or GLB binary data.

The payload type is detected automatically from the GLB magic bytes. For glTF JSON with external buffers, use Self::from_bytes_with_base_path.

Source

pub fn from_bytes_with_base_path( data: &[u8], base_path: Option<&Path>, ) -> Result<Self>

Parse from glTF JSON or GLB binary data with an optional base path for external buffers.

Source

pub fn from_gltf(json_data: &[u8], base_path: Option<&Path>) -> Result<Self>

Parse from glTF JSON data with optional base path for external buffers.

Source

pub fn from_bytes_lenient(data: &[u8]) -> Result<Self>

Parse glTF/GLB bytes, decoding geometry even when the asset uses scene features this crate does not model (skins, animations, morph targets).

Unlike Self::from_bytes, which rejects such assets, this reader ignores those features and decodes only geometry. Use it to read meshes out of skinned or animated assets, including the output of crate::compress_gltf_bytes for those assets. Per-primitive decoding still fails for unsupported attribute layouts.

Source

pub fn from_bytes_lenient_with_base_path( data: &[u8], base_path: Option<&Path>, ) -> Result<Self>

Like Self::from_bytes_lenient, with a base path for external buffers.

Source

pub fn from_value(doc: &Value, buffers: Vec<Vec<u8>>) -> Result<Self>

Builds a lenient reader from an already-parsed glTF document (doc) and its resolved buffer bytes.

This lets a caller that already holds a parsed scene and its buffers (for example a gltf-rs document and the bytes it resolved) decode geometry through this reader without serializing back to glTF/GLB bytes and re-resolving the buffers. The same lenient policy as Self::from_bytes_lenient applies: skins, animations, and morph targets are ignored (not rejected), and per-primitive decoding still fails for unsupported attribute layouts.

buffers must already be resolved and indexed by glTF buffer index; no URI or BIN-chunk resolution is performed here.

Source

pub fn decode_primitive_with_semantics( &self, mesh_idx: usize, prim_idx: usize, ) -> Result<(Mesh, Vec<(String, u32)>)>

Decode a single non-Draco primitive, returning the mesh and the (glTF semantic, Draco unique id) mapping for its attributes.

Used by the compressor to build the KHR_draco_mesh_compression attributes map with the original glTF semantic names (including TANGENT, JOINTS_n, WEIGHTS_n, extra TEXCOORD_n/COLOR_n, and custom _* attributes), which the Draco attribute model alone cannot preserve. Errors if the primitive is already Draco-compressed.

This is the geometry-decode callback expected by crate::compress_gltf_value, so a caller holding a parsed scene can drive the compressor: build a reader with Self::from_value and pass |mesh, prim| reader.decode_primitive_with_semantics(mesh, prim).

Source