Struct VisualDebugOverlay 

pub struct VisualDebugOverlay { /* private fields */ }

Visual debug overlay manager

Implementations

impl VisualDebugOverlay

pub fn new(brp_client: Arc<RwLock<BrpClient>>) -> Self

Create new visual debug overlay system

pub fn with_config( brp_client: Arc<RwLock<BrpClient>>, config: OverlayConfig, ) -> Self

Create with custom configuration

pub async fn set_overlay_enabled( &self, overlay_type: &DebugOverlayType, enabled: bool, config: Option<Value>, ) -> Result<()>

Enable or disable an overlay type

pub async fn highlight_entities( &self, entity_ids: Vec<u64>, color: Option<[f32; 4]>, mode: Option<HighlightMode>, ) -> Result<()>

Highlight specific entities

pub async fn clear_highlights(&self) -> Result<()>

Clear entity highlighting

pub async fn show_colliders( &self, config: Option<ColliderVisualizationConfig>, ) -> Result<()>

Enable collider visualization

pub async fn show_transform_gizmos( &self, config: Option<TransformGizmoConfig>, ) -> Result<()>

Enable transform gizmos

pub async fn show_metrics( &self, config: Option<MetricsOverlayConfig>, ) -> Result<()>

Show performance metrics overlay

pub async fn add_debug_marker(&self, marker: DebugMarker) -> Result<()>

Add a custom debug marker

pub async fn remove_debug_marker(&self, marker_id: &str) -> Result<()>

Remove a debug marker

pub async fn clear_all_overlays(&self) -> Result<()>

Clear all overlays

pub async fn update_performance_metrics( &self, overlay_type: &DebugOverlayType, frame_time_ms: f32, )

Update performance metrics for an overlay

pub async fn get_performance_metrics(&self) -> HashMap<DebugOverlayType, f32>

Get current performance metrics

pub async fn is_budget_exceeded(&self) -> bool

Check if performance budget is exceeded

pub fn get_config(&self) -> &OverlayConfig

Get overlay configuration

pub fn set_config(&mut self, config: OverlayConfig)

Update overlay configuration