Struct DebugDraw 

pub struct DebugDraw {
    pub enabled: bool,
    pub dev_enabled: bool,
    /* private fields */
}

Accumulated debug visuals for the current and future frames.

Store one instance in super::RuntimeResources. Plugins access it via ctx.resources.get_mut::<DebugDraw>(). Call begin_frame before each super::ViewportRuntime::step call to clear transient primitives.

When both enabled and the relevant layer flag are true, submission methods record primitives into the internal buffers. When disabled they are no-ops, so no branches are needed in plugin code.

Fields

enabled: bool

Master switch. When false, all submission methods are no-ops.

dev_enabled: bool

Controls whether DebugLayer::Dev primitives are recorded.

Set to false in ship builds to suppress development-only visuals without changing plugin code. DebugLayer::Overlay primitives are not affected by this flag.

Implementations

impl DebugDraw

pub fn new() -> Self

Create a new DebugDraw with both enabled and dev_enabled set to true.

pub fn overlay_only() -> Self

Create a DebugDraw with dev_enabled = false (overlay-only mode).

Use this in ship builds to suppress dev-layer visuals while keeping any overlay-layer primitives active.

pub fn begin_frame(&mut self)

Clear all transient primitives.

Call this before each frame (before super::ViewportRuntime::step) so that one-frame debug draws do not accumulate across frames. Persistent primitives (added with add_persistent) are not affected.

pub fn line(&mut self, start: Vec3, end: Vec3, colour: [f32; 4]) -> &mut Self

Submit a line segment for this frame.

The default layer is DebugLayer::Dev. Use line_overlay for a line that appears in ship builds.

pub fn line_overlay( &mut self, start: Vec3, end: Vec3, colour: [f32; 4], ) -> &mut Self

Submit a line segment on the DebugLayer::Overlay layer.

pub fn line_layer( &mut self, start: Vec3, end: Vec3, colour: [f32; 4], layer: DebugLayer, ) -> &mut Self

Submit a line segment on a specific layer.

pub fn point( &mut self, position: Vec3, radius: f32, colour: [f32; 4], ) -> &mut Self

Submit a point marker for this frame.

radius is in screen-space pixels.

pub fn point_overlay( &mut self, position: Vec3, radius: f32, colour: [f32; 4], ) -> &mut Self

Submit a point marker on the DebugLayer::Overlay layer.

pub fn point_layer( &mut self, position: Vec3, radius: f32, colour: [f32; 4], layer: DebugLayer, ) -> &mut Self

Submit a point marker on a specific layer.

pub fn aabb(&mut self, min: Vec3, max: Vec3, colour: [f32; 4]) -> &mut Self

Submit an axis-aligned box wireframe for this frame.

pub fn aabb_overlay( &mut self, min: Vec3, max: Vec3, colour: [f32; 4], ) -> &mut Self

Submit an AABB wireframe on the DebugLayer::Overlay layer.

pub fn aabb_layer( &mut self, min: Vec3, max: Vec3, colour: [f32; 4], layer: DebugLayer, ) -> &mut Self

Submit an AABB wireframe on a specific layer.

pub fn sphere( &mut self, center: Vec3, radius: f32, colour: [f32; 4], ) -> &mut Self

Submit a sphere wireframe for this frame.

The sphere is drawn as three great circles (XY, XZ, and YZ planes).

pub fn sphere_overlay( &mut self, center: Vec3, radius: f32, colour: [f32; 4], ) -> &mut Self

Submit a sphere wireframe on the DebugLayer::Overlay layer.

pub fn sphere_layer( &mut self, center: Vec3, radius: f32, colour: [f32; 4], layer: DebugLayer, ) -> &mut Self

Submit a sphere wireframe on a specific layer.

pub fn label( &mut self, position: Vec3, text: impl Into<String>, colour: [f32; 4], ) -> &mut Self

Submit a text label anchored to a world-space position for this frame.

pub fn label_overlay( &mut self, position: Vec3, text: impl Into<String>, colour: [f32; 4], ) -> &mut Self

Submit a label on the DebugLayer::Overlay layer.

pub fn label_layer( &mut self, position: Vec3, text: impl Into<String>, colour: [f32; 4], layer: DebugLayer, ) -> &mut Self

Submit a label on a specific layer.

pub fn add_persistent(&mut self, id: u64, prim: DebugPrim)

Insert or replace a persistent primitive keyed by id.

Persistent primitives survive begin_frame and stay until removed with remove_persistent. The id is caller-assigned; any u64 value works as a stable identifier.

Insertion respects the layer flags: if the layer would be suppressed by the current enabled/dev_enabled state, the primitive is still stored (so it becomes visible when the flag is re-enabled) but it will be skipped during rendering conversion.

pub fn remove_persistent(&mut self, id: u64) -> Option<DebugPrim>

Remove a persistent primitive by id.

Returns the removed primitive, or None if id was not found.

pub fn has_persistent(&self, id: u64) -> bool

True if a persistent primitive with the given id exists.

pub fn clear_persistent(&mut self)

Remove all persistent primitives.

pub fn prims(&self) -> impl Iterator<Item = &DebugPrim>

Iterate over all active primitives (both transient and persistent).

Primitives on the DebugLayer::Dev layer are included regardless of dev_enabled; the caller decides whether to filter. Use to_polylines and friends to get renderer-ready items with layer filtering already applied.

pub fn transient_count(&self) -> usize

Number of transient primitives currently accumulated.

pub fn persistent_count(&self) -> usize

Number of persistent primitives currently stored.

pub fn is_empty(&self) -> bool

True when no primitives (transient or persistent) are present.

pub fn to_polylines(&self) -> Vec<PolylineItem>

Convert accumulated line, AABB, and sphere primitives to polyline render items.

Primitives are grouped by colour to minimize the number of render items. Dev-layer primitives are skipped when dev_enabled is false. Returns an empty Vec when no line-type primitives are present or when enabled is false.

pub fn to_point_cloud(&self) -> Option<PointCloudItem>

Convert accumulated point primitives to a single point cloud render item.

Returns None when no point primitives are present or when enabled is false. Dev-layer points are skipped when dev_enabled is false.

pub fn to_labels(&self) -> Vec<LabelItem>

Convert accumulated label primitives to label render items.

Returns an empty Vec when no label primitives are present or when enabled is false. Dev-layer labels are skipped when dev_enabled is false.

Trait Implementations

impl Default for DebugDraw

fn default() -> Self

Returns the “default value” for a type.