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

Fix trailing whitespace.

This commit is contained in:
Robin KAY 2022-08-09 01:49:20 +01:00
parent d32b00f6a0
commit 4996c9d108
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -1,15 +1,15 @@
//! This crate provides a Bevy plugin, [`OutlinePlugin`], and associated components for //! This crate provides a Bevy plugin, [`OutlinePlugin`], and associated components for
//! rendering outlines around meshes using the vertex extrusion method. //! rendering outlines around meshes using the vertex extrusion method.
//! //!
//! Outlines are rendered in a seperate pass following the main 3D pass. The effect of this //! Outlines are rendered in a seperate pass following the main 3D pass. The effect of this
//! pass is to present the outlines in depth sorted order according to the model translation //! pass is to present the outlines in depth sorted order according to the model translation
//! of each mesh. This ensures that outlines are not clipped by other geometry. //! of each mesh. This ensures that outlines are not clipped by other geometry.
//! //!
//! The [`Outline`] component will, by itself, cover the original object entirely with the //! The [`Outline`] component will, by itself, cover the original object entirely with the
//! outline colour. The [`OutlineStencil`] component must also be added to prevent the body of //! outline colour. The [`OutlineStencil`] component must also be added to prevent the body of
//! an object from being filled it. This must be added to any entity which needs to appear on //! an object from being filled it. This must be added to any entity which needs to appear on
//! top of an outline. //! top of an outline.
//! //!
//! Vertex extrusion works best with meshes that have smooth surfaces. For meshes with hard //! Vertex extrusion works best with meshes that have smooth surfaces. For meshes with hard
//! edges, see the [`OutlineMeshExt::generate_outline_normals`] function. //! edges, see the [`OutlineMeshExt::generate_outline_normals`] function.