Struct pdfium_render::bitmap::PdfBitmap

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

A rendered image of a single PdfPage at a specific width and height.

By default, PdfBitmap is lazy; it will not render its page into a bitmap until it is required to do so in order to return a byte buffer or an Image::DynamicImage. If preferred, rendering can be initiated manually by calling the PdfBitmap::render() function. Once rendered, the page will not be re-rendered.

Implementations

impl<'a> PdfBitmap<'a>

pub fn width(&self) -> u32

Returns the width of the image in this PdfBitmap, in pixels.

pub fn height(&self) -> u32

Returns the height of the image in this PdfBitmap, in pixels.

pub fn format(&self) -> PdfBitmapFormat

Returns the pixel format of the image in this PdfBitmap.

pub fn rotation(&self) -> PdfBitmapRotation

Returns the rotation setting that will be applied to this page during rendering.

pub fn as_image(&mut self) -> DynamicImage

Returns a new DynamicImage created from the bitmap buffer backing this PdfBitmap, rendering the referenced page if necessary.

pub fn as_bytes(&mut self) -> &'a [u8]

Returns an immutable reference to the bitmap buffer backing this PdfBitmap, rendering the referenced page if necessary.

pub fn render(&mut self)

Renders this page into a bitmap buffer. Once rendered, the page will not be re-rendered.

It is generally unnecessary to call this function directly, since PdfBitmap will automatically initiate rendering itself on the first call to either the PdfBitmap::as_bytes() function or the PdfBitmap::as_image() function.

Trait Implementations

impl<'a> Drop for PdfBitmap<'a>

fn drop(&mut self)

Closes the PdfPage, releasing the memory held by the bitmap buffer.