Struct pdfium_render::page_object_image::PdfPageImageObject

pub struct PdfPageImageObject<'a> { /* private fields */ }

A single PdfPageObject of type PdfPageObjectType::Image. The page object defines a single bitmapped image.

Page objects can be created either attached to a PdfPage (in which case the page object’s memory is owned by the containing page) or detached from any page (in which case the page object’s memory is owned by the object). Page objects are not rendered until they are attached to a page; page objects that are never attached to a page will be lost when they fall out of scope.

The simplest way to create a page image object that is immediately attached to a page is to call the PdfPageObjects::create_image_object() function.

Creating a detached page image object offers more scope for customization, but you must add the object to a containing PdfPage manually. To create a detached page image object, use the PdfPageImageObject::new() function. The detached page image object can later be attached to a page by using the PdfPageObjects::add_image_object() function.

Implementations

impl<'a> PdfPageImageObject<'a>

pub fn new(
    document: &PdfDocument<'a>,
    image: &DynamicImage
) -> Result<Self, PdfiumError>

Creates a new PdfPageImageObject from the given arguments. The returned page object will not be rendered until it is added to a PdfPage using the PdfPageObjects::add_image_object() function.

The returned page object will have its width and height both set to 1.0 points. Use the PdfPageObjectCommon::scale() function to apply a horizontal and vertical scale to the object after it is created, or use one of the PdfPageImageObject::new_with_width(), PdfPageImageObject::new_with_height(), or PdfPageImageObject::new_with_size() functions to scale the page object to a specific width and/or height at the time the object is created.

pub fn new_with_width(
    document: &PdfDocument<'a>,
    image: &DynamicImage,
    width: PdfPoints
) -> Result<Self, PdfiumError>

Creates a new PdfPageImageObject from the given arguments. The page object will be scaled horizontally to match the given width; its height will be adjusted to maintain the aspect ratio of the given image. The returned page object will not be rendered until it is added to a PdfPage using the PdfPageObjects::add_image_object() function.

pub fn new_with_height(
    document: &PdfDocument<'a>,
    image: &DynamicImage,
    height: PdfPoints
) -> Result<Self, PdfiumError>

Creates a new PdfPageImageObject from the given arguments. The page object will be scaled vertically to match the given height; its width will be adjusted to maintain the aspect ratio of the given image. The returned page object will not be rendered until it is added to a PdfPage using the PdfPageObjects::add_image_object() function.

pub fn new_with_size(
    document: &PdfDocument<'a>,
    image: &DynamicImage,
    width: PdfPoints,
    height: PdfPoints
) -> Result<Self, PdfiumError>

Creates a new PdfPageImageObject from the given arguments. The page object will be scaled to match the given width and height. The returned page object will not be rendered until it is added to a PdfPage using the PdfPageObjects::add_image_object() function.

pub fn get_raw_image(&self) -> Result<DynamicImage, PdfiumError>

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfPageImageObject, ignoring any image filters, image mask, or object transforms applied to this page object.

pub fn get_processed_image(
    &self,
    document: &PdfDocument<'_>
) -> Result<DynamicImage, PdfiumError>

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.

pub fn get_processed_image_with_width(
    &self,
    document: &PdfDocument<'_>,
    width: Pixels
) -> Result<DynamicImage, PdfiumError>

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.

The returned image will be scaled during rendering so its width matches the given target width.

pub fn get_processed_image_with_height(
    &self,
    document: &PdfDocument<'_>,
    height: Pixels
) -> Result<DynamicImage, PdfiumError>

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.

The returned image will be scaled during rendering so its height matches the given target height.

pub fn get_processed_image_with_size(
    &self,
    document: &PdfDocument<'_>,
    width: Pixels,
    height: Pixels
) -> Result<DynamicImage, PdfiumError>

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfPageImageObject, taking into account any image filters, image mask, and object transforms applied to this page object.

The returned image will be scaled during rendering so its width and height match the given target dimensions.

pub fn set_image(&mut self, image: &DynamicImage) -> Result<(), PdfiumError>

Applies the byte data in the given Image::DynamicImage to this PdfPageImageObject.

pub fn set_bitmap(&mut self, bitmap: &PdfBitmap<'_>) -> Result<(), PdfiumError>

Applies the byte data in the given PdfBitmap to this PdfPageImageObject.

pub fn horizontal_dpi(&self) -> Result<f32, PdfiumError>

Returns the horizontal dots per inch resolution of the image assigned to this PdfPageImageObject, based on the intrinsic resolution of the assigned image and the dimensions of this object.

pub fn vertical_dpi(&self) -> Result<f32, PdfiumError>

Returns the vertical dots per inch resolution of the image assigned to this PdfPageImageObject, based on the intrinsic resolution of the assigned image and the dimensions of this object.

pub fn bits_per_pixel(&self) -> Result<u8, PdfiumError>

Returns the bits per pixel for the image assigned to this PdfPageImageObject.

This value is not available if this object has not been attached to a PdfPage.

pub fn color_space(&self) -> Result<PdfColorSpace, PdfiumError>

Returns the color space for the image assigned to this PdfPageImageObject.

This value is not available if this object has not been attached to a PdfPage.

pub fn filters(&self) -> PdfPageImageObjectFilters<'_>

Returns the collection of image filters currently applied to this PdfPageImageObject.

Trait Implementations

impl<'a> From<PdfPageImageObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageImageObject<'a>) -> Self

Converts to this type from the input type.