Struct three_d::io::Loaded

pub struct Loaded { /* fields omitted */ }

Contains the resources loaded using the Loader and/or manually inserted using the insert_bytes method. Use the remove_bytes or get_bytes function to extract the raw byte array for the loaded resource or one of the other methods to both extract and deserialize a loaded resource.

Implementations

impl Loaded

pub fn new() -> Self

Constructs a new empty set of loaded files. Use this together with insert_bytes to load resources from an unsuported source and then parse them as usual using the functionality on Loaded.

pub fn remove_bytes(&mut self, path: impl AsRef<Path>) -> ThreeDResult<Vec<u8>>

Remove and returns the loaded byte array for the resource at the given path. The byte array then has to be deserialized to whatever type this resource is (image, 3D model etc.).

pub fn get_bytes(&mut self, path: impl AsRef<Path>) -> ThreeDResult<&[u8]>

Returns a reference to the loaded byte array for the resource at the given path. The byte array then has to be deserialized to whatever type this resource is (image, 3D model etc.).

pub fn insert_bytes(&mut self, path: impl AsRef<Path>, bytes: Vec<u8>)

Inserts the given bytes into the set of loaded files which is useful if you want to load the data from an unsuported source. The files can then be parsed as usual using the functionality on Loaded.

impl Loaded

pub fn three_d<P: AsRef<Path>>(
    &mut self,
    path: P
) -> ThreeDResult<(Vec<CPUMesh>, Vec<CPUMaterial>)>

This is supported on crate feature 3d-io only.

Deserialize a loaded .3d file resource (a custom binary format for three-d) into a list of meshes and materials.

impl Loaded

pub fn obj<P: AsRef<Path>>(
    &mut self,
    path: P
) -> ThreeDResult<(Vec<CPUMesh>, Vec<CPUMaterial>)>

This is supported on crate feature obj-io only.

Deserialize a loaded .obj file resource and .mtl material file resource (if present) into a list of meshes and materials. It uses the wavefront-obj crate.

impl Loaded

pub fn gltf(
    &mut self,
    path: impl AsRef<Path>
) -> ThreeDResult<(Vec<CPUMesh>, Vec<CPUMaterial>)>

This is supported on crate feature gltf-io only.

Deserialize a loaded .gltf file and related .bin resource file and related texture resources or a loaded .glb file into a list of meshes and materials. It uses the gltf crate.

impl Loaded

pub fn image<P: AsRef<Path>>(&mut self, path: P) -> ThreeDResult<CPUTexture<u8>>

This is supported on crate feature image-io only.

Deserialize the loaded image resource at the given path into a CPUTexture using the image crate. The CPUTexture can then be used to create a Texture2D.

pub fn cube_image<P: AsRef<Path>>(
    &mut self,
    right_path: P,
    left_path: P,
    top_path: P,
    bottom_path: P,
    front_path: P,
    back_path: P
) -> ThreeDResult<CPUTexture<u8>>

This is supported on crate feature image-io only.

Deserialize the 6 loaded image resources at the given paths into a CPUTexture using the image crate. The CPUTexture can then be used to create a TextureCubeMap.

Trait Implementations

impl Debug for Loaded

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

Formats the value using the given formatter.

impl Default for Loaded

fn default() -> Loaded

Returns the “default value” for a type.