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

Update top-level docs.

Browse Source
This commit is contained in:
Robin KAY 2022-11-22 21:30:54 +00:00
parent d41057f905
commit 055a5115dd
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/lib.rs
View File

@ -5,11 +5,16 @@
//! 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 [`OutlineVolume`] component will, by itself, cover the original object entirely with
//! outline colour. The [`OutlineStencil`] component must also be added to prevent the body of //! the outline colour. The [`OutlineStencil`] component must also be added to prevent the body
//! an object from being filled it. This must be added to any entity which needs to appear on //! of 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.
//! //!
//! The [`OutlineBundle`] and [`OutlineStencilBundle`] bundles can be used to add the right
//! components, including the required [`ComputedOutlineDepth`] component. Optionally, the
//! [`SetOutlineDepth`] and [`InheritOutlineDepth`] components may also be added to control the
//! depth ordering of outlines.
//!
//! Vertex extrusion works best with meshes that have smooth surfaces. To avoid visual //! Vertex extrusion works best with meshes that have smooth surfaces. To avoid visual
//! artefacts when outlining meshes with hard edges, see the //! artefacts when outlining meshes with hard edges, see the
//! [`OutlineMeshExt::generate_outline_normals`] function and the //! [`OutlineMeshExt::generate_outline_normals`] function and the