Struct MaskOverlay 

pub struct MaskOverlay<'a> {
    pub background: Option<&'a TensorDyn>,
    pub opacity: f32,
    pub letterbox: Option<[f32; 4]>,
    pub color_mode: ColorMode,
}

Options for mask overlay rendering.

Controls how segmentation masks are composited onto the destination image:

• background: when set, the background image is drawn first and masks are composited over it (result written to dst). When None, dst is cleared to 0x00000000 (fully transparent) before masks are drawn. dst is always fully overwritten — its prior contents are never preserved. Callers who used to pre-load an image into dst before calling draw_decoded_masks / draw_proto_masks must now supply that image via background instead (behaviour changed in v0.16.4).
• opacity: scales the alpha of rendered mask colors. 1.0 (default) preserves the class color’s alpha unchanged; 0.5 makes masks semi-transparent.
• color_mode: controls whether colors are assigned by class label, instance index, or track ID. Defaults to ColorMode::Class.

Fields

background: Option<&'a TensorDyn>

Compositing source image. Must have the same dimensions and pixel format as dst. When Some, the output is background + masks. When None, dst is cleared to 0x00000000 before masks are drawn.

opacity: f32

letterbox: Option<[f32; 4]>

Normalized letterbox region [xmin, ymin, xmax, ymax] in model-input space that contains actual image content (the rest is padding).

When set, bounding boxes and mask coordinates from the decoder (which are in model-input normalized space) are mapped back to the original image coordinate space before rendering.

Use with_letterbox_crop to compute this from the Crop that was used in the model input convert call.

color_mode: ColorMode

Implementations

impl<'a> MaskOverlay<'a>

pub fn new() -> Self

pub fn with_background(self, bg: &'a TensorDyn) -> Self

Set the compositing source image.

bg must have the same dimensions and pixel format as the dst passed to draw_decoded_masks / draw_proto_masks. The output will be bg + masks. Without a background, dst is cleared to 0x00000000.

pub fn with_opacity(self, opacity: f32) -> Self

pub fn with_color_mode(self, mode: ColorMode) -> Self

pub fn with_letterbox_crop( self, crop: &Crop, model_w: usize, model_h: usize, ) -> Self

Set the letterbox transform from the Crop used when preparing the model input, so that bounding boxes and masks are correctly mapped back to the original image coordinate space during rendering.

Pass the same crop that was given to convert along with the model input dimensions (model_w × model_h).

Has no effect when crop.dst_rect is None (no letterbox applied).

Trait Implementations

impl<'a> Clone for MaskOverlay<'a>

fn clone(&self) -> MaskOverlay<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for MaskOverlay<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MaskOverlay<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for MaskOverlay<'a>