pub struct OverlayAgent { /* private fields */ }Expand description
The agent responsible for overlay / debug rendering passes.
Owns a [LaneRegistry] of overlay lanes (gizmo, wireframe, emissive,
…). Each lane is asked to run every frame; lanes that have nothing
to do early-out internally rather than being gated at the agent
level. This keeps the agent generic — it never knows what each lane
needs to consult to decide.
Trait Implementations§
Source§impl Agent for OverlayAgent
impl Agent for OverlayAgent
Source§fn access(&self) -> AgentAccess
fn access(&self) -> AgentAccess
Reads only the LaneBus and shared read-only resources, records into its
own encoder, and buffers its pass into its OutputDeck — no World, no
shared mutable resource. Eligible to run concurrently with any wave.
Source§fn deck_writes(&self) -> Vec<TypeId>
fn deck_writes(&self) -> Vec<TypeId>
Buffers its pass into the [OverlayPassSlot] deck slot.
Source§fn negotiate(&mut self, _request: NegotiationRequest) -> NegotiationResponse
fn negotiate(&mut self, _request: NegotiationRequest) -> NegotiationResponse
Negotiates with the DCC to determine the best execution strategy
given the current global resource constraints and priorities.
Source§fn apply_budget(&mut self, budget: ResourceBudget)
fn apply_budget(&mut self, budget: ResourceBudget)
Applies a resource budget issued by the DCC.
The agent must adjust its internal logic (e.g., LOD, quality settings)
to stay within the allocated limits.
Source§fn on_initialize(&mut self, context: &mut EngineContext<'_>)
fn on_initialize(&mut self, context: &mut EngineContext<'_>)
Called once after the agent is registered with the DCC. Read more
Source§fn execute(&mut self, context: &mut EngineContext<'_>)
fn execute(&mut self, context: &mut EngineContext<'_>)
Called every frame by the engine loop. Read more
Source§fn report_status(&self) -> AgentStatus
fn report_status(&self) -> AgentStatus
Reports the current status and health of the agent.
Source§fn execution_timing(&self) -> ExecutionTiming
fn execution_timing(&self) -> ExecutionTiming
Declares WHEN and HOW this agent should execute within the frame pipeline. Read more
Source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
Allows mutable downcasting to concrete agent types.
Auto Trait Implementations§
impl Freeze for OverlayAgent
impl !RefUnwindSafe for OverlayAgent
impl Send for OverlayAgent
impl Sync for OverlayAgent
impl Unpin for OverlayAgent
impl UnsafeUnpin for OverlayAgent
impl !UnwindSafe for OverlayAgent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more