Struct gltf::Gltf

source ·
pub struct Gltf {
    pub document: Document,
    pub blob: Option<Vec<u8>>,
}
Expand description

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§

source§

impl Gltf

source

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

Convenience function that loads glTF from the file system.

source

pub fn from_reader_without_validation<R>(reader: R) -> Result<Self>
where R: Read + Seek,

Loads glTF from a reader without performing validation checks.

source

pub fn from_reader<R>(reader: R) -> Result<Self>
where R: Read + Seek,

Loads glTF from a reader.

source

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

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

source

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

Loads glTF from a slice of bytes.

Methods from Deref<Target = Document>§

source

pub fn as_json(&self) -> &Root

Unwraps the glTF document, without consuming it.

source

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

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

source

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

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

source

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

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

source

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

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

source

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

Returns the default scene, if provided.

source

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

Returns the extensions referenced in this .document file.

source

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

Returns the extensions required to load and render this asset.

source

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

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

source

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

Available on crate feature extensions only.

Returns extension data unknown to this crate version.

source

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

Available on crate feature extensions only.

Queries extension data unknown to this crate version.

source

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.

source

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.

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

Trait Implementations§

source§

impl Clone for Gltf

source§

fn clone(&self) -> Gltf

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Gltf

source§

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

Formats the value using the given formatter. Read more
source§

impl DerefMut for Gltf

source§

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

Mutably dereferences the value.
source§

impl Deref for Gltf

§

type Target = Document

The resulting type after dereferencing.
source§

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

Dereferences the value.

Auto Trait Implementations§

§

impl Freeze for Gltf

§

impl RefUnwindSafe for Gltf

§

impl Send for Gltf

§

impl Sync for Gltf

§

impl Unpin for Gltf

§

impl UnwindSafe for Gltf

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.