File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 99//! An outline consists of two parts, a volume and a stencil. The volume
1010//! will, by itself, cover the original object entirely with the outline
1111//! colour. The stencil prevents the body of an object from being filled in.
12- //! These parts are controlled by the [`OutlineVolume`] and [`OutlineStencil`]
13- //! components respectively.
12+ //! Stencils also allows other entities to occlude outlines, otherwise the
13+ //! outline will be drawn on top of them. These parts are controlled by the
14+ //! [`OutlineVolume`] and [`OutlineStencil`] components respectively.
1415//!
1516//! The [`OutlineMode`] component specifies the rendering method. Outlines may
1617//! be flattened into a plane in order to further avoid clipping, or left in
@@ -121,6 +122,10 @@ pub enum NodeOutline {
121122}
122123
123124/// A component for stenciling meshes during outline rendering.
125+ ///
126+ /// Stencils are used both to prevent the normal volume of an entity from
127+ /// being covered by the outline colour and to allow entities to occlude
128+ /// outlines behind them.
124129#[ derive( Clone , Component ) ]
125130#[ cfg_attr( feature = "reflect" , derive( Reflect ) ) ]
126131#[ cfg_attr( feature = "reflect" , reflect( Component , Default ) ) ]
You can’t perform that action at this time.
0 commit comments