Realm

oa::ui::DetectionOverlay

Ring-buffered detection box and label overlay. Constructed by DetectionOverlay::create; records are uploaded through the non-blocking DetectionOverlay::update, composed into a Ui frame through DetectionOverlay::draw, and released back for overwrite through DetectionOverlay::mark_consumed.

StRust public API

Declaration

pub struct DetectionOverlay { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn update( &mut self, items: &[DetectionOverlayItem], atlas: &TextAtlas, ) -> Result<()>
pub fn draw( &self, ui: &mut Ui<'_>, destination: PixelRect, clip: PixelRect, ) -> Result<()>
pub fn mark_consumed(&mut self, completion: &Event) -> Result<()>
pub const fn count(&self) -> u32

Associated Functions

pub fn create(engine: &Engine, config: DetectionOverlayConfig) -> Result<Self>

Public Method Documentation

pub fn update( &mut self, items: &[DetectionOverlayItem], atlas: &TextAtlas, ) -> Result<()>
No public source comment is attached to this declaration.
pub fn draw( &self, ui: &mut Ui<'_>, destination: PixelRect, clip: PixelRect, ) -> Result<()>
No public source comment is attached to this declaration.
pub fn mark_consumed(&mut self, completion: &Event) -> Result<()>
No public source comment is attached to this declaration.
pub const fn count( &self ) -> u32
No public source comment is attached to this declaration.
pub fn create( engine: &Engine, config: DetectionOverlayConfig ) -> Result<Self>
No public source comment is attached to this declaration.