Struct GltfDocument 

pub struct GltfDocument<Ct: IsContainer = GpuCpuArray> {

    pub animations: Vec<Animation>,
    pub cameras: Vec<GltfCamera>,
    pub default_scene: Option<usize>,
    pub extensions: Option<Value>,
    pub textures: Vec<AtlasTexture>,
    pub lights: Vec<AnalyticalLight>,
    pub meshes: Vec<GltfMesh<Ct>>,
    pub nodes: Vec<GltfNode>,
    pub default_material: Material,
    pub materials: Vec<Material>,
    pub primitives: FxHashMap<usize, Vec<Primitive>>,
    pub scenes: Vec<Vec<usize>>,
    pub skins: Vec<GltfSkin>,
}

A loaded GLTF document.

After being loaded, a GltfDocument is a collection of staged resources.

All primitives are automatically added to the Stage they were loaded from.

Note

After being loaded, the meshes field contains Vertices and Indices that can be inspected from the CPU. This has memory implications, so if your document contains lots of geometric data it is advised that you unload that data from the CPU using GltfDocument::into_gpu_only.

Fields

animations: Vec<Animation>

cameras: Vec<GltfCamera>

default_scene: Option<usize>

extensions: Option<Value>

textures: Vec<AtlasTexture>

lights: Vec<AnalyticalLight>

meshes: Vec<GltfMesh<Ct>>

nodes: Vec<GltfNode>

default_material: Material

materials: Vec<Material>

primitives: FxHashMap<usize, Vec<Primitive>>

scenes: Vec<Vec<usize>>

Vector of scenes - each being a list of nodes.

skins: Vec<GltfSkin>

Implementations

impl GltfDocument

pub fn from_gltf( stage: &Stage, document: &Document, buffer_data: Vec<Data>, images: Vec<Data>, ) -> Result<GltfDocument, StageError>

pub fn into_gpu_only(self) -> GltfDocument<GpuOnlyArray>

Unload vertex and index data from the CPU.

The data can still be updated from the CPU, but will not be inspectable.

impl<Ct> GltfDocument<Ct>

where Ct: IsContainer<Pointer<Vertex> = Array<Vertex>> + IsContainer<Pointer<u32> = Array<u32>>,

pub fn renderlets_iter(&self) -> impl Iterator<Item = &Primitive>

pub fn root_nodes_in_scene( &self, scene_index: usize, ) -> impl Iterator<Item = &GltfNode>

Returns the root (top-level) nodes in the given scene.

This roughly follows gltf::Scene::nodes, returning only the nodes directly referenced by the scene — not their children.

Use recursive_nodes_in_scene if you need all nodes (including descendants).

pub fn recursive_nodes_in_scene( &self, scene_index: usize, ) -> impl Iterator<Item = &GltfNode>

Returns all nodes in the given scene, recursively including children.

Root nodes are visited first, followed by their descendants in depth-first order.

pub fn bounding_volume(&self) -> Option<Aabb>

Returns the bounding volume of this document, if possible.

This function will return None if this document does not contain meshes.