Skip to content

Commit c97fca1

Browse files
committed
Add mention of stencils occluding other outlines to docs.
1 parent 0798a93 commit c97fca1

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

src/lib.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@
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))]

0 commit comments

Comments
 (0)