Struct ImageEncoder 

pub struct ImageEncoder { /* private fields */ }

Encodes raw image buffers into encoded bytes for common formats.

Supports saving as PNG, JPEG, GIF, TIFF, BMP, and JPEG XR when the input color format is compatible.

Example

use windows_capture::encoder::{ImageEncoder, ImageEncoderPixelFormat, ImageFormat};

let width = 320u32;
let height = 240u32;
// BGRA8 buffer (e.g., from a frame)
let bgra = vec![0u8; (width * height * 4) as usize];

let png_bytes = ImageEncoder::new(ImageFormat::Png, ImageEncoderPixelFormat::Bgra8)
    .unwrap()
    .encode(&bgra, width, height)
    .unwrap();

std::fs::write("example.png", png_bytes).unwrap();

Implementations

impl ImageEncoder

pub fn new( format: ImageFormat, pixel_format: ImageEncoderPixelFormat, ) -> Result<Self, ImageEncoderError>

Constructs a new ImageEncoder.

pub fn encode( &self, image_buffer: &[u8], width: u32, height: u32, ) -> Result<Vec<u8>, ImageEncoderError>

Encodes the provided pixel buffer into the configured output ImageFormat.

The input buffer must match the specified source crate::settings::ColorFormat and dimensions. For packed 8-bit formats (e.g., crate::settings::ColorFormat::Bgra8), the buffer length should be width * height * 4.

Errors

• ImageEncoderError::UnsupportedFormat when the source format is unsupported for images (e.g., crate::settings::ColorFormat::Rgba16F)
• ImageEncoderError::WindowsError when Windows Imaging API calls fail
• ImageEncoderError::IntConversionError on integer conversion failures