Crate bevy_mod_outline

This crate provides a Bevy plugin, OutlinePlugin, and associated components for 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 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 non-outline geometry.

The OutlineVolume 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 an object from being filled it. This must be added to any entity which needs to appear on top of an outline.

The OutlineMode component specifies the rendering method. Outlines may be flattened into a plane in order to further avoid clipping, or left in real space.

The OutlineBundle and OutlineStencilBundle bundles can be used to add the right components, including the required ComputedOutline component. Outlines can be inherited from the parent via the InheritOutline component and InheritOutlineBundle.

Vertex extrusion works best with meshes that have smooth surfaces. To avoid visual artefacts when outlining meshes with hard edges, see the OutlineMeshExt::generate_outline_normals function and the AutoGenerateOutlineNormalsPlugin.

Structs

• AsyncSceneInheritOutline
  A component for triggering the AsyncSceneInheritOutlinePlugin.
• AsyncSceneInheritOutlinePlugin
  Automatically inherits outlines for the entities in a scene.
• AutoGenerateOutlineNormalsPlugin
  Automatically runs generate_outline_normals on every mesh.
• ComputedOutline
  A component for storing the computed depth at which the outline lies.
• InheritOutline
  A component for inheriting outlines from the parent entity.
• InheritOutlineBundle
  A bundle for inheriting outlines from the parent entity.
• OutlineBundle
  A bundle for rendering stenciled outlines around meshes.
• OutlinePlugin
  Adds support for rendering outlines.
• OutlineRenderLayers
  A component for specifying what layer(s) the outline should be rendered for.
• OutlineStencil
  A component for stenciling meshes during outline rendering.
• OutlineStencilBundle
  A bundle for stenciling meshes in the outlining pass.
• OutlineVolume
  A component for rendering outlines around meshes.

Enums

• GenerateOutlineNormalsError
  Failed to generate outline normals for the mesh.
• NodeOutline
  Labels for render graph nodes which draw outlines.
• OutlineMode
  A component which specifies how the outline should be rendered.

Constants

• ATTRIBUTE_OUTLINE_NORMAL
  The direction to extrude the vertex when rendering the outline.

Traits

• OutlineMeshExt
  Extension methods for Mesh.