Struct RenderOptions 

pub struct RenderOptions {
    pub output_format: Option<OutputFormat>,
    pub ppi: Option<f32>,
    pub pages: Option<Vec<usize>>,
    pub regions: bool,
}

Internal rendering options.

Built from Default and narrowed by the with_* setters:

use quillmark_core::types::{OutputFormat, RenderOptions};

let opts = RenderOptions::default()
    .with_output_format(OutputFormat::Png)
    .with_ppi(300.0);

Fields

output_format: Option<OutputFormat>

ppi: Option<f32>

Pixels per inch for raster output formats (e.g., PNG). Ignored for vector/document formats (PDF, SVG). None resolves to RenderOptions::DEFAULT_PPI through ppi_or_default.

Must be finite and positive, and small enough to keep every rendered page under MAX_RASTER_PIXELS; a raster backend refuses anything else with a backend::invalid_raster_scale RenderError.

pages: Option<Vec<usize>>

Optional 0-based page indices to render (e.g., vec![0, 2] for the first and third pages). None renders all pages. Any index >= page_count fails with a RenderError carrying the backend::page_index_out_of_bounds code: call LiveSession::page_count() first if validation is needed. A format the backend emits whole — PDF on both built-in backends — fails with backend::page_selection_not_supported when this is Some.

regions: bool

Populate RenderResult::regions with the schema-field geometry sidecar, for consumers without a live session. Default false, so exports pay no introspection cost.

The sidecar always describes the whole document: page indices are document-space and unaffected by a pages subset selection.

Implementations

impl RenderOptions

pub const DEFAULT_PPI: f32 = 144.0

The pixels per inch every raster backend uses when ppi is None: 2x at 72 pt/inch.

pub fn ppi_or_default(&self) -> f32

ppi, or DEFAULT_PPI.

pub fn with_output_format(self, output_format: OutputFormat) -> RenderOptions

pub fn with_ppi(self, ppi: f32) -> RenderOptions

pub fn with_pages(self, pages: Vec<usize>) -> RenderOptions

pub fn with_regions(self, regions: bool) -> RenderOptions

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

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<(), Error>

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.