Struct Image 

pub struct Image { /* private fields */ }

Represents an image that can be embedded in a PDF

Implementations

impl Image

pub fn from_jpeg_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load a JPEG image from a file

pub fn from_jpeg_data(data: Vec<u8>) -> Result<Self>

Create an image from JPEG data

pub fn from_png_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load a PNG image from a file

pub fn from_png_data(data: Vec<u8>) -> Result<Self>

Create an image from PNG data with full transparency support

pub fn from_tiff_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load a TIFF image from a file

pub fn from_tiff_data(data: Vec<u8>) -> Result<Self>

Create an image from TIFF data

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load an image from a file, detecting format by extension.

Supported extensions: .jpg, .jpeg, .png, .tif, .tiff (case-insensitive).

Example

use oxidize_pdf::Image;

let img = Image::from_file("photo.jpg").unwrap();
let img = Image::from_file("logo.png").unwrap();

pub fn width(&self) -> u32

Get image width in pixels

pub fn height(&self) -> u32

Get image height in pixels

pub fn data(&self) -> &[u8]

Get image data

pub fn format(&self) -> ImageFormat

Get image format

pub fn bits_per_component(&self) -> u8

Get bits per component

pub fn from_raw_data( data: Vec<u8>, width: u32, height: u32, color_space: ColorSpace, bits_per_component: u8, ) -> Self

Create image from raw RGB/Gray data (no encoding/compression)

pub fn from_rgba_data( rgba_data: Vec<u8>, width: u32, height: u32, ) -> Result<Self>

Create an image from RGBA data (with alpha channel)

pub fn from_gray_data( gray_data: Vec<u8>, width: u32, height: u32, ) -> Result<Self>

Create a grayscale image from gray data

pub fn from_file_raw<P: AsRef<Path>>( path: P, width: u32, height: u32, format: ImageFormat, ) -> Result<Self>

Load raw image data from file (simple implementation without external image crate)

pub fn to_pdf_object(&self) -> Object

Convert to PDF XObject

pub fn to_pdf_object_with_transparency( &self, ) -> Result<(Object, Option<Object>)>

Convert to PDF XObject with SMask for transparency

pub fn has_transparency(&self) -> bool

Check if this image has transparency

pub fn create_stencil_mask(&self, threshold: u8) -> Option<Image>

Create a stencil mask from this image A stencil mask uses 1-bit per pixel for transparency

pub fn create_mask( &self, mask_type: MaskType, threshold: Option<u8>, ) -> Option<Image>

Create an image mask for transparency

pub fn with_mask(self, mask: Image, mask_type: MaskType) -> Self

Apply a mask to this image

pub fn soft_mask(&self) -> Option<&Image>

Get the soft mask if present

pub fn alpha_data(&self) -> Option<&[u8]>

Get the alpha data if present

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.