Struct ForegroundHandle 

pub struct ForegroundHandle { /* private fields */ }

Composed RGBA foreground image with transparent background.

Final output produced by composing the original RGB image with a mask as the alpha channel. The mask’s grayscale values map to alpha, producing smooth or hard edges depending on processing. Obtain by calling foreground on a crate::MatteHandle or crate::MaskHandle.

Example

use outline::Outline;

let outline = Outline::new("model.onnx");
let session = outline.for_image("input.jpg")?;

// Soft edges from raw matte
let soft = session.matte().foreground()?;
soft.save("soft-cutout.png")?;

// Hard edges from processed mask
let hard = session.matte()
    .blur()
    .threshold()
    .processed()?
    .foreground()?;
hard.save("hard-cutout.png")?;

Implementations

impl ForegroundHandle

pub fn image(&self) -> &RgbaImage

Get a reference to the RGBA foreground image.

pub fn dimensions(&self) -> (u32, u32)

Return the foreground image dimensions.

pub fn into_image(self) -> RgbaImage

Consume the handle and return the RGBA foreground image.

pub fn save(&self, path: impl AsRef<Path>) -> OutlineResult<()>

Save the RGBA foreground image to the specified path.

pub fn bounding_box(&self) -> Option<BoundingBox>

Compute the bounding box of non-transparent content using a non-zero alpha threshold.

pub fn bounding_box_with(&self, threshold: u8) -> Option<BoundingBox>

Compute the bounding box of content whose alpha is at or above threshold.

pub fn pad(self, padding: impl Into<Padding>) -> Self

Expand the canvas by the given padding, filling new pixels with transparency.

pub fn crop(self, bounds: BoundingBox) -> Option<Self>

Crop the image to bounds.

Returns None when bounds is empty or outside the current image canvas.

pub fn crop_to_content(self) -> Option<Self>

Crop the image to its non-transparent content.

Returns None when the image has no non-transparent pixels.

pub fn crop_to_content_with(self, threshold: u8) -> Option<Self>

Crop the image to content whose alpha is at or above threshold.

Returns None when the image is fully transparent at the given threshold.

Trait Implementations

impl Debug for ForegroundHandle

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

Formats the value using the given formatter.