Struct GltfPlugin 

pub struct GltfPlugin {
    pub default_sampler: ImageSamplerDescriptor,
    pub use_model_forward_direction: bool,
    pub custom_vertex_attributes: HashMap<Box<str>, MeshVertexAttribute>,
}

Adds support for glTF file loading to the app.

Fields

default_sampler: ImageSamplerDescriptor

The default image sampler to lay glTF sampler data on top of.

Can be modified with the DefaultGltfImageSampler resource.

use_model_forward_direction: bool

CAUTION: This is an experimental feature with known issues. Behavior may change in future versions.

How to convert glTF coordinates on import. Assuming glTF cameras, glTF lights, and glTF meshes had global identity transforms, their Bevy Transform::forward will be pointing in the following global directions:

• When set to false
  • glTF cameras and glTF lights: global -Z,
  • glTF models: global +Z.
• When set to true
  • glTF cameras and glTF lights: global +Z,
  • glTF models: global -Z.

The default is false.

custom_vertex_attributes: HashMap<Box<str>, MeshVertexAttribute>

Registry for custom vertex attributes.

To specify, use GltfPlugin::add_custom_vertex_attribute.

Implementations

impl GltfPlugin

pub fn add_custom_vertex_attribute( self, name: &str, attribute: MeshVertexAttribute, ) -> GltfPlugin

Register a custom vertex attribute so that it is recognized when loading a glTF file with the GltfLoader.

name must be the attribute name as found in the glTF data, which must start with an underscore. See this section of the glTF specification for additional details on custom attributes.

Examples found in repository

examples/2d/custom_gltf_vertex_attribute.rs (line 38)

fn main() {
    App::new()
        .insert_resource(AmbientLight {
            color: Color::WHITE,
            brightness: 1.0 / 5.0f32,
            ..default()
        })
        .add_plugins((
            DefaultPlugins.set(
                GltfPlugin::default()
                    // Map a custom glTF attribute name to a `MeshVertexAttribute`.
                    // The glTF file used here has an attribute name with *two*
                    // underscores: __BARYCENTRIC
                    // One is stripped to do the comparison here.
                    .add_custom_vertex_attribute("_BARYCENTRIC", ATTRIBUTE_BARYCENTRIC),
            ),
            Material2dPlugin::<CustomMaterial>::default(),
        ))
        .add_systems(Startup, setup)
        .run();
}

Trait Implementations

impl Default for GltfPlugin

fn default() -> GltfPlugin

Returns the “default value” for a type.

impl Plugin for GltfPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn finish(&self, app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.