Struct pdfium_render::bitmap::PdfBitmap

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

A bitmap image with a specific width and height.

Implementations

impl<'a> PdfBitmap<'a>

pub fn empty( width: Pixels, height: Pixels, format: PdfBitmapFormat, bindings: &'a dyn PdfiumLibraryBindings ) -> Result<PdfBitmap<'_>, PdfiumError>

Creates an empty PdfBitmap with a buffer capable of storing an image of the given pixel width and height in the given pixel format.

pub unsafe fn from_bytes( width: Pixels, height: Pixels, format: PdfBitmapFormat, buffer: &'a mut [u8], bindings: &'a dyn PdfiumLibraryBindings ) -> Result<PdfBitmap<'a>, PdfiumError>

Creates a new PdfBitmap that wraps the given byte buffer. The buffer must be capable of storing an image of the given pixel width and height in the given pixel format, otherwise a buffer overflow may occur during rendering.

This function is not available when compiling to WASM.

Safety

This function is unsafe because a buffer overflow may occur during rendering if the buffer is too small to store a rendered image of the given pixel dimensions.

pub fn bindings(&self) -> &dyn PdfiumLibraryBindings

Returns the PdfiumLibraryBindings used by this PdfBitmap.

pub fn width(&self) -> Pixels

Returns the width of the image in the bitmap buffer backing this PdfBitmap.

pub fn height(&self) -> Pixels

Returns the height of the image in the bitmap buffer backing this PdfBitmap.

pub fn format(&self) -> Result<PdfBitmapFormat, PdfiumError>

Returns the pixel format of the image in the bitmap buffer backing this PdfBitmap.

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

Returns an immutable reference to the bitmap buffer backing this PdfBitmap.

pub fn as_image(&self) -> DynamicImage

Returns a new Image::DynamicImage created from the bitmap buffer backing this PdfBitmap.

This function is only available when this crate’s image feature is enabled.

pub fn as_array(&self) -> Uint8Array

Returns a Javascript Uint8Array object representing the bitmap buffer backing this PdfBitmap.

This function avoids a memory allocation and copy required by both PdfBitmap::as_bytes() and PdfBitmap::as_image_data(), making it preferable for situations where performance is paramount.

This function is only available when compiling to WASM.

pub fn as_image_data(&self) -> Result<ImageData, JsValue>

Returns a new Javascript ImageData object created from the bitmap buffer backing this PdfBitmap. The resulting ImageData can be easily displayed in an HTML <canvas> element like so:

canvas.getContext('2d').putImageData(image_data);

This function is slower than calling PdfBitmap::as_array() because it must perform an additional memory allocation in order to create the ImageData object. Consider calling the PdfBitmap::as_array() function directly if performance is paramount.

This function is only available when compiling to WASM.

pub fn bytes_required_for_size(width: Pixels, height: Pixels) -> usize

Estimates the maximum memory buffer size required for a PdfBitmap of the given dimensions.

Certain platforms, architectures, and operating systems may limit the maximum size of a bitmap buffer that can be created by Pdfium.

The returned value assumes four bytes of memory will be consumed for each rendered pixel.

Trait Implementations

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

fn drop(&mut self)

Closes this PdfBitmap, releasing the memory held by the bitmap buffer.