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

Fix outdated doc in bevy_render (#8578)

Browse Source 
# Objective

Fix an out-of-date doc string.

The old doc string says "returns None if …" and "for a given
descriptor",
but this method neither takes an argument or returns an `Option`.
This commit is contained in:
Nicola Papale 2023-05-17 21:46:18 +02:00 committed by GitHub
parent a47f1ab4be
commit dce472222f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/bevy_render/src/mesh/mesh/mod.rs
View File

@ -214,9 +214,9 @@ impl Mesh {
}) })
} }
/// For a given `descriptor` returns a [`VertexBufferLayout`] compatible with this mesh. If this /// Get this `Mesh`'s [`MeshVertexBufferLayout`], used in [`SpecializedMeshPipeline`].
/// mesh is not compatible with the given `descriptor` (ex: it is missing vertex attributes), [`None`] will ///
/// be returned. /// [`SpecializedMeshPipeline`]: crate::render_resource::SpecializedMeshPipeline
pub fn get_mesh_vertex_buffer_layout(&self) -> MeshVertexBufferLayout { pub fn get_mesh_vertex_buffer_layout(&self) -> MeshVertexBufferLayout {
let mut attributes = Vec::with_capacity(self.attributes.len()); let mut attributes = Vec::with_capacity(self.attributes.len());
let mut attribute_ids = Vec::with_capacity(self.attributes.len()); let mut attribute_ids = Vec::with_capacity(self.attributes.len());