Crate bevy_gizmos

Expand description

This crate adds an immediate mode drawing api to Bevy for visual debugging.

§Example

fn system(mut gizmos: Gizmos) {
    gizmos.line(Vec3::ZERO, Vec3::X, GREEN);
}

See the documentation on Gizmos for more examples.

aabb: A module adding debug visualization of Aabbs.
arcs: Additional GizmoBuffer Functions – Arcs
arrows: Additional GizmoBuffer Functions – Arrows
circles: Additional GizmoBuffer Functions – Circles
config: A module for the GizmoConfig<T> Resource.
cross: Additional GizmoBuffer Functions – Crosses
curves: Additional GizmoBuffer Functions – Curves
gizmos: A module for the Gizmos SystemParam.
grid: Additional GizmoBuffer Functions – Grids
prelude: The gizmos prelude.
primitives: A module for rendering each of the 2D and 3D bevy_math::primitives with Gizmos.
retained: This module is for ‘retained’ alternatives to the ‘immediate mode’ Gizmos system parameter.
rounded_box: Additional GizmoBuffer Functions – Rounded cuboids and rectangles

GizmoAsset: A collection of gizmos.
GizmoMeshSystems: System set for updating the rendering meshes for drawing gizmos.
GizmoPlugin: A Plugin that provides an immediate mode drawing api for visual debugging.

GizmoRenderSystems: System set label for the systems handling the rendering of gizmos.

AppGizmoBuilder: A extension trait adding App::init_gizmo_group and App::insert_gizmo_config.

clear_gizmo_context: Clear out the contextual gizmos.
collect_requested_gizmos: Collect the requested gizmos into a specific clear context.
end_gizmo_context: End this gizmo clearing context.
propagate_gizmos: Propagate the contextual gizmo into the Update storage for rendering.
start_gizmo_context: Start a new gizmo clearing context.