Struct RenderOptions 

pub struct RenderOptions {
    pub dpi: f64,
    pub background: [f32; 4],
    pub render_annotations: bool,
    pub width: Option<u16>,
    pub height: Option<u16>,
    pub max_pixels: Option<u32>,
    pub quality: RasterQuality,
}

Options for rendering a page.

Fields

dpi: f64

Resolution in dots per inch (default: 72.0 = 1:1 with PDF points).

background: [f32; 4]

Background colour as [r, g, b, a] in 0.0..1.0 (default: opaque white).

render_annotations: bool

Whether to render annotations (default: true).

width: Option<u16>

Force output width in pixels (overrides DPI for width).

height: Option<u16>

Force output height in pixels (overrides DPI for height).

max_pixels: Option<u32>

Optional opt-in pixel budget. When Some(n) and the requested scale would produce more than n pixels (width × height), the effective scale is reduced proportionally so the output fits the budget. Default None preserves the exact requested scale (byte-identical to prior behavior).

This is an explicit, caller-controlled quality/performance trade-off — it is never applied by default and the returned RenderedPage reports the actual width/height so callers see the applied resolution.

quality: RasterQuality

Rasterization precision/speed trade-off (default DEFAULT_RASTER_QUALITY, currently RasterQuality::Quality).

RasterQuality::Quality (default) uses the higher-precision f32 compositing pipeline and is byte-identical to historical output. RasterQuality::Speed is an explicit opt-in: ~1.4–1.6× faster on content-heavy pages, with sub-perceptual rounding differences where blending/anti-aliasing/images compose. Never changes output by default.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&RenderConfig> for RenderOptions

fn from(cfg: &RenderConfig) -> Self

Converts to this type from the input type.