Struct ImageProcessor 

pub struct ImageProcessor {
    pub cpu: Option<CPUProcessor>,
    /* private fields */
}

Image converter that uses available hardware acceleration or CPU as a fallback.

Fields

cpu: Option<CPUProcessor>

CPU-based image converter as a fallback. This is only None if the EDGEFIRST_DISABLE_CPU environment variable is set.

Implementations

impl ImageProcessor

pub fn new() -> Result<Self>

Creates a new ImageProcessor instance, initializing available hardware converters based on the system capabilities and environment variables.

Examples

let image = include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/../../testdata/zidane.jpg"));
let src = load_image(image, Some(PixelFormat::Rgba), None)?;
let mut converter = ImageProcessor::new()?;
let mut dst = converter.create_image(640, 480, PixelFormat::Rgb, DType::U8, None)?;
converter.convert(&src, &mut dst, Rotation::None, Flip::None, Crop::default())?;

pub fn with_config(config: ImageProcessorConfig) -> Result<Self>

Creates a new ImageProcessor with the given configuration.

When ImageProcessorConfig::backend is set to a specific backend, environment variables are ignored and the processor initializes the requested backend plus CPU as a fallback.

When Auto, the existing EDGEFIRST_FORCE_BACKEND and EDGEFIRST_DISABLE_* environment variables apply.

pub fn create_image( &self, width: usize, height: usize, format: PixelFormat, dtype: DType, memory: Option<TensorMemory>, ) -> Result<TensorDyn>

Create a TensorDyn image with the best available memory backend.

Priority: DMA-buf → PBO (byte-sized types: u8, i8) → system memory.

Use this method instead of TensorDyn::image() when the tensor will be used with ImageProcessor::convert(). It selects the optimal memory backing (including PBO for GPU zero-copy) which direct allocation cannot achieve.

This method is on ImageProcessor rather than ImageProcessorTrait because optimal allocation requires knowledge of the active compute backends (e.g. the GL context handle for PBO allocation). Individual backend implementations (CPUProcessor, etc.) do not have this cross-backend visibility.

Arguments

• width - Image width in pixels
• height - Image height in pixels
• format - Pixel format
• dtype - Element data type (e.g. DType::U8, DType::I8)
• memory - Optional memory type override; when None, the best available backend is selected automatically.

Returns

A TensorDyn backed by the highest-performance memory type available on this system.

Errors

Returns an error if all allocation strategies fail.

pub fn draw_masks( &mut self, decoder: &Decoder, outputs: &[&TensorDyn], dst: &mut TensorDyn, overlay: MaskOverlay<'_>, ) -> Result<Vec<DetectBox>>

Decode model outputs and draw segmentation masks onto dst.

This is the primary mask rendering API. The processor decodes via the provided [Decoder], selects the optimal rendering path (hybrid CPU+GL or fused GPU), and composites masks onto dst.

Returns the detected bounding boxes.

Trait Implementations

impl Debug for ImageProcessor

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

Formats the value using the given formatter.

impl ImageProcessorTrait for ImageProcessor

fn convert( &mut self, src: &TensorDyn, dst: &mut TensorDyn, rotation: Rotation, flip: Flip, crop: Crop, ) -> Result<()>

Converts the source image to the destination image format and size. The image is cropped first, then flipped, then rotated

Prefer hardware accelerators when available, falling back to CPU if necessary.

fn draw_decoded_masks( &mut self, dst: &mut TensorDyn, detect: &[DetectBox], segmentation: &[Segmentation], overlay: MaskOverlay<'_>, ) -> Result<()>

Draw pre-decoded detection boxes and segmentation masks onto dst.

fn draw_proto_masks( &mut self, dst: &mut TensorDyn, detect: &[DetectBox], proto_data: &ProtoData, overlay: MaskOverlay<'_>, ) -> Result<()>

Draw masks from proto data onto image (fused decode+draw).

fn set_class_colors(&mut self, colors: &[[u8; 4]]) -> Result<()>

Sets the colors used for rendering segmentation masks. Up to 20 colors can be set.

impl Send for ImageProcessor

impl Sync for ImageProcessor