Struct PdfiumPage

pub struct PdfiumPage { /* private fields */ }

Rust interface to FPDF_PAGE

Implementations

impl PdfiumPage

pub fn boundaries(&self) -> PdfiumPageBoundaries<'_>

pub fn render_with_matrix( &self, width: i32, height: i32, format: PdfiumBitmapFormat, background: Option<PdfiumColor>, matrix: &PdfiumMatrix, render_flags: i32, clipping: Option<PdfiumRect>, ) -> PdfiumResult<PdfiumBitmap>

Renders this PdfiumPage into a new PdfiumBitmap using a transformation matrix.

This function provides fine-grained control over the rendering process by allowing you to directly specify a transformation matrix, background color, render flags, and clipping rectangle. The transformation matrix can be used to apply scaling, rotation or translation transformations during rendering.

Arguments

• width - The width of the target bitmap in pixels
• height - The height of the target bitmap in pixels
• format - The pixel format for the target bitmap
• background - Optional background color to fill the bitmap before rendering
• matrix - The transformation matrix to apply during rendering
• render_flags - Flags controlling the rendering behavior (0 for most use cases)
• clipping - Optional clipping rectangle to restrict rendering to a specific area

Returns

Returns a PdfiumBitmap containing the rendered page, or a PdfiumError if rendering fails.

Examples

use pdfium::*;

fn page_to_bitmap(
    document: &PdfiumDocument,
    index: i32,
    height: i32,
) -> PdfiumResult<PdfiumBitmap> {
    let page = document.page(index)?;
    let bounds = page.boundaries().media()?;
    let zoom = height as f32 / bounds.height();
    let width = (bounds.width() * zoom) as i32;
    let matrix = PdfiumMatrix::new_scale(zoom);
    page.render_with_matrix(
        width,
        height,
        PdfiumBitmapFormat::Bgra,
        Some(PdfiumColor::WHITE),
        &matrix,
        0,
        None,
    )
}

pub fn render_into_bitmap_with_matrix( &self, bitmap: &mut PdfiumBitmap, matrix: &PdfiumMatrix, render_flags: i32, clipping: Option<PdfiumRect>, )

Renders this PdfiumPage into the given PdfiumBitmap using a transformation matrix.

This function provides fine-grained control over the rendering process by allowing you to directly specify a transformation matrix, render flags, and clipping rectangle. The transformation matrix can be used to apply scaling, rotation or translation transformations during rendering.

Arguments

• bitmap - The target bitmap to render into
• matrix - The transformation matrix to apply during rendering
• render_flags - Flags controlling the rendering behavior (0 for most use cases)
• clipping - Optional clipping rectangle to restrict rendering to a specific area. If None, defaults to the full bitmap dimensions.

Returns

Returns Ok(()) if rendering succeeds, or a PdfiumError if rendering fails.

Trait Implementations

impl Drop for PdfiumPage

fn drop(&mut self)

Closes this PdfiumPage, releasing held memory.

impl From<&PdfiumPage> for FPDF_PAGE

fn from(value: &PdfiumPage) -> Self

Converts to this type from the input type.