forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add links to the types on the documentation of GltfAssetLabel (#17791)

Browse Source 
# Objective

Allow quick jump to definition of types of GlTFs labeled assets.

## Solution

Add links to the types refered on the docs of `GltfAssetLabel`

## Testing

Ran `cargo run -p ci`
This commit is contained in:
Lucas Franca 2025-02-10 22:30:41 -03:00 committed by GitHub
parent 575f66504b
commit 5e9da923f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
crates/bevy_gltf/src/lib.rs
View File

@ -492,13 +492,13 @@ pub struct GltfMaterialName(pub String);
/// ``` /// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)] #[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GltfAssetLabel { pub enum GltfAssetLabel {
/// `Scene{}`: glTF Scene as a Bevy `Scene` /// `Scene{}`: glTF Scene as a Bevy [`Scene`]
Scene(usize), Scene(usize),
/// `Node{}`: glTF Node as a `GltfNode` /// `Node{}`: glTF Node as a [`GltfNode`]
Node(usize), Node(usize),
/// `Mesh{}`: glTF Mesh as a `GltfMesh` /// `Mesh{}`: glTF Mesh as a [`GltfMesh`]
Mesh(usize), Mesh(usize),
/// `Mesh{}/Primitive{}`: glTF Primitive as a Bevy `Mesh` /// `Mesh{}/Primitive{}`: glTF Primitive as a Bevy [`Mesh`]
Primitive { Primitive {
/// Index of the mesh for this primitive /// Index of the mesh for this primitive
mesh: usize, mesh: usize,
@ -506,28 +506,29 @@ pub enum GltfAssetLabel {
primitive: usize, primitive: usize,
}, },
/// `Mesh{}/Primitive{}/MorphTargets`: Morph target animation data for a glTF Primitive /// `Mesh{}/Primitive{}/MorphTargets`: Morph target animation data for a glTF Primitive
/// as a Bevy [`Image`](bevy_image::prelude::Image)
MorphTarget { MorphTarget {
/// Index of the mesh for this primitive /// Index of the mesh for this primitive
mesh: usize, mesh: usize,
/// Index of this primitive in its parent mesh /// Index of this primitive in its parent mesh
primitive: usize, primitive: usize,
}, },
/// `Texture{}`: glTF Texture as a Bevy `Image` /// `Texture{}`: glTF Texture as a Bevy [`Image`](bevy_image::prelude::Image)
Texture(usize), Texture(usize),
/// `Material{}`: glTF Material as a Bevy `StandardMaterial` /// `Material{}`: glTF Material as a Bevy [`StandardMaterial`]
Material { Material {
/// Index of this material /// Index of this material
index: usize, index: usize,
/// Used to set the [`Face`](bevy_render::render_resource::Face) of the material, useful if it is used with negative scale /// Used to set the [`Face`](bevy_render::render_resource::Face) of the material, useful if it is used with negative scale
is_scale_inverted: bool, is_scale_inverted: bool,
}, },
/// `DefaultMaterial`: as above, if the glTF file contains a default material with no index /// `DefaultMaterial`: glTF's default Material as a Bevy [`StandardMaterial`]
DefaultMaterial, DefaultMaterial,
/// `Animation{}`: glTF Animation as Bevy `AnimationClip` /// `Animation{}`: glTF Animation as Bevy [`AnimationClip`]
Animation(usize), Animation(usize),
/// `Skin{}`: glTF mesh skin as `GltfSkin` /// `Skin{}`: glTF mesh skin as [`GltfSkin`]
Skin(usize), Skin(usize),
/// `Skin{}/InverseBindMatrices`: glTF mesh skin matrices as Bevy `SkinnedMeshInverseBindposes` /// `Skin{}/InverseBindMatrices`: glTF mesh skin matrices as Bevy [`SkinnedMeshInverseBindposes`]
InverseBindMatrices(usize), InverseBindMatrices(usize),
} }