franklinblanco/bevy_mod_outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comment about outline normals.

Browse Source
This commit is contained in:
Robin KAY 2022-08-08 23:56:50 +01:00
parent ce228d1c2d
commit 5736faf0c1
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/lib.rs
View File

@ -83,6 +83,9 @@ pub enum GenerateOutlineNormalsError {
pub trait OutlineMeshExt { pub trait OutlineMeshExt {
/// Generates outline normals for the mesh by normalising the sum of the regular normals. /// Generates outline normals for the mesh by normalising the sum of the regular normals.
/// ///
/// To the extent that outline normals are not perpendicular to the surface of the mesh,
/// this may result in non-uniform outline thickness.
///
/// This function will silently do nothing if the outline normals would be equal to the /// This function will silently do nothing if the outline normals would be equal to the
/// regular normals. /// regular normals.
fn generate_outline_normals(&mut self) -> Result<(), GenerateOutlineNormalsError>; fn generate_outline_normals(&mut self) -> Result<(), GenerateOutlineNormalsError>;