Struct gltf::Gltf

pub struct Gltf {
    pub document: Document,
    pub blob: Option<Vec<u8>>,
}

glTF JSON wrapper plus binary payload.

Fields

document: Document

The glTF JSON wrapper.

blob: Option<Vec<u8>>

The glTF binary payload in the case of binary glTF.

Implementations

impl Gltf

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

where P: AsRef<Path>,

Convenience function that loads glTF from the file system.

pub fn from_reader_without_validation<R>(reader: R) -> Result<Self>

where R: Read + Seek,

Loads glTF from a reader without performing validation checks.

pub fn from_reader<R>(reader: R) -> Result<Self>

where R: Read + Seek,

Loads glTF from a reader.

pub fn from_slice_without_validation(slice: &[u8]) -> Result<Self>

Loads glTF from a slice of bytes without performing validation checks.

pub fn from_slice(slice: &[u8]) -> Result<Self>

Loads glTF from a slice of bytes.

Methods from Deref<Target = Document>

pub fn as_json(&self) -> &Root

Unwraps the glTF document, without consuming it.

pub fn accessors(&self) -> Accessors<'_>

Returns an Iterator that visits the accessors of the glTF asset.

pub fn animations(&self) -> Animations<'_>

Returns an Iterator that visits the animations of the glTF asset.

pub fn buffers(&self) -> Buffers<'_>

Returns an Iterator that visits the pre-loaded buffers of the glTF asset.

pub fn cameras(&self) -> Cameras<'_>

Returns an Iterator that visits the cameras of the glTF asset.

pub fn default_scene(&self) -> Option<Scene<'_>>

Returns the default scene, if provided.

pub fn extensions_used(&self) -> ExtensionsUsed<'_>

Returns the extensions referenced in this .document file.

pub fn extensions_required(&self) -> ExtensionsRequired<'_>

Returns the extensions required to load and render this asset.

pub fn images(&self) -> Images<'_>

Returns an Iterator that visits the pre-loaded images of the glTF asset.

pub fn extensions(&self) -> Option<&Map<String, Value>>

Available on crate feature extensions only.

Returns extension data unknown to this crate version.

pub fn extension_value(&self, ext_name: &str) -> Option<&Value>

Available on crate feature extensions only.

Queries extension data unknown to this crate version.

pub fn lights(&self) -> Option<Lights<'_>>

Available on crate feature KHR_lights_punctual only.

Returns an Iterator that visits the lights of the glTF asset as defined by the KHR_lights_punctual extension.

pub fn variants(&self) -> Option<Variants<'_>>

Available on crate feature KHR_materials_variants only.

Returns an Iterator that visits the variants of the glTF asset as defined by the KHR_materials_variants extension.

pub fn materials(&self) -> Materials<'_>

Returns an Iterator that visits the materials of the glTF asset.

pub fn meshes(&self) -> Meshes<'_>

Returns an Iterator that visits the meshes of the glTF asset.

pub fn nodes(&self) -> Nodes<'_>

Returns an Iterator that visits the nodes of the glTF asset.

pub fn samplers(&self) -> Samplers<'_>

Returns an Iterator that visits the samplers of the glTF asset.

pub fn scenes(&self) -> Scenes<'_>

Returns an Iterator that visits the scenes of the glTF asset.

pub fn skins(&self) -> Skins<'_>

Returns an Iterator that visits the skins of the glTF asset.

pub fn textures(&self) -> Textures<'_>

Returns an Iterator that visits the textures of the glTF asset.

pub fn views(&self) -> Views<'_>

Returns an Iterator that visits the pre-loaded buffer views of the glTF asset.

Trait Implementations

impl Clone for Gltf

fn clone(&self) -> Gltf

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Gltf

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DerefMut for Gltf

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for Gltf

type Target = Document

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.