Struct RenderConfig 

pub struct RenderConfig { /* private fields */ }

Configuration for PdfPage::render.

use firecrawl_pdfium::{RenderConfig, PixelFormat};

// 300 DPI grayscale, annotations off:
let config = RenderConfig::new()
    .dpi(300.0)
    .pixel_format(PixelFormat::Gray8)
    .annotations(false);

Implementations

impl RenderConfig

pub const DEFAULT_MAX_OUTPUT_BYTES: u64

Default output-size ceiling: 1 GiB of pixel data.

pub fn new() -> RenderConfig

A configuration rendering at 1:1 (72 DPI), BGRA, white background, annotations and form fields on, 1 GiB output cap.

pub fn scale(self, factor: f32) -> Self

Scale factor over page points (2.0 renders a 612×792pt page at 1224×1584px). Mutually exclusive with the other size selectors; the last one set wins.

pub fn dpi(self, dpi: f32) -> Self

Resolution in dots per inch (72 DPI == scale 1.0).

pub fn width(self, pixels: u32) -> Self

Fixed output width in pixels, preserving aspect ratio.

pub fn height(self, pixels: u32) -> Self

Fixed output height in pixels, preserving aspect ratio.

pub fn fit(self, width: u32, height: u32) -> Self

Largest output that fits in width×height, preserving aspect ratio.

pub fn exact(self, width: u32, height: u32) -> Self

Exact output dimensions (may distort the aspect ratio).

pub fn pixel_format(self, format: PixelFormat) -> Self

Output pixel format (default PixelFormat::Bgra8).

pub fn background(self, color: Color) -> Self

Background color the page is composited over (default white). Use Color::TRANSPARENT with an alpha format for compositing.

pub fn annotations(self, on: bool) -> Self

Render annotations (default true).

pub fn form_fields(self, on: bool) -> Self

Draw AcroForm field appearances (default true). Takes effect only when the document has enable_form_rendering active.

pub fn rotate(self, rotation: Rotation) -> Self

Extra rotation applied at render time, on top of the page’s own /Rotate (default none). 90°/270° swap the output dimensions.

pub fn text_antialiasing(self, on: bool) -> Self

Toggle text anti-aliasing (default true).

pub fn image_antialiasing(self, on: bool) -> Self

Toggle image anti-aliasing (default true).

pub fn path_antialiasing(self, on: bool) -> Self

Toggle path anti-aliasing (default true).

pub fn max_output_bytes(self, limit: u64) -> Self

Ceiling on the pixel buffer size in bytes (default RenderConfig::DEFAULT_MAX_OUTPUT_BYTES, 1 GiB). Renders that would exceed it fail with Error::RenderTooLarge before allocating. Use u64::MAX to disable.

Trait Implementations

impl Clone for RenderConfig

fn clone(&self) -> RenderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderConfig

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

Formats the value using the given formatter.

impl Default for RenderConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RenderConfig

fn eq(&self, other: &RenderConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RenderConfig