Struct RenderOptions 

pub struct RenderOptions {
    pub transform: Affine,
    pub color_mode: ColorMode,
    pub text_aa: TextAa,
    pub text_aa_override: Option<TextAa>,
    pub no_path_smooth: bool,
    pub no_image_smooth: bool,
    pub force_halftone: bool,
    pub rect_aa: bool,
    pub convert_fill_to_stroke: bool,
    pub subpixel_text_positioning: bool,
    pub background: Option<Color>,
}

Everything a render is parameterised by.

Constructed with ..RenderOptions::default() struct update. The defaults are the oracle’s: reproducing a golden needs no configuration beyond the target size.

Fields

transform: Affine

Page space to device space. render_page composes this with the page’s own display matrix.

color_mode: ColorMode

The colour mode, normally ColorMode::Normal.

text_aa: TextAa

Glyph antialiasing, for the whole render.

text_aa_override: Option<TextAa>

Glyph antialiasing for this draw only, overriding Self::text_aa.

Text antialiasing is per-draw, not per-render: on a page whose every other run is grayscale, a live edit’s text is drawn with ClearType.

None — the default — means Self::text_aa decides. A caller drawing one run differently sets this on a clone of its options for that run, so the page’s own setting stays readable.

no_path_smooth: bool

bNoPathSmooth: hard-edge every path fill and stroke.

no_image_smooth: bool

bNoImageSmooth: never interpolate an image, whatever /Interpolate or the size heuristic say. Wins over both.

force_halftone: bool

bForceHalftone. Forced on inside type-3 char procs and uncoloured tile cells, so it reaches a render even with the oracle’s bare flags.

rect_aa: bool

bRectAA: antialias axis-aligned rectangle fills instead of integer-snapping them. Forced on inside type-3 char procs.

convert_fill_to_stroke: bool

bConvertFillToStroke, read only under a forced colour scheme.

subpixel_text_positioning: bool

Place each glyph at its true fractional device origin instead of snapping it to a whole pixel.

Default false, which is the oracle: small text is placed on a grid of whole pixels in y and thirds of a pixel in x. Set this to true when a caller wants text where the PDF actually puts it — smooth animation, a non-integer device scale, any use where oracle parity is not the goal — at the cost of matching a golden.

No effect on large text: above the size threshold glyphs are placed fractionally either way.

background: Option<Color>

The page background. None follows the oracle: opaque white for a page without transparency, fully transparent for one with it.

This is load-bearing rather than cosmetic — a white-backed page composites differently at the edges from a transparent-backed one, and the engine’s single compositing path relies on the white being real pixels where the oracle would have replayed a white backdrop.

Implementations

impl RenderOptions

pub fn background_for(&self, has_transparency: bool) -> Color

The background a page with the given transparency renders onto: opaque white when the page is opaque, fully transparent when it is not, unless RenderOptions::background overrides it.

pub fn path_aa(&self) -> AntiAlias

Whether path geometry is antialiased under these options.

pub fn effective_text_aa(&self) -> TextAa

The text antialiasing in force for the draw being made: the per-draw Self::text_aa_override when a caller set one, else Self::text_aa.

pub fn for_text_run(&self, aa: TextAa) -> Self

The options one text run draws under with aa forced, leaving the page’s own options untouched.

This is what a live edit’s text draws through.

pub fn text_antialias(&self) -> AntiAlias

Whether glyph outlines are antialiased under these options.

The outline path has no subpixel spelling, so TextAa::LcdSubpixel antialiases here exactly like TextAa::Grayscale. The subpixel choice is expressed on the bitmap path, the only place the oracle expresses it either.

pub fn for_type3_char_proc(&self) -> Self

The options a type-3 char proc renders under: forced halftone and rectangle antialiasing, which means a rectangle inside a type-3 glyph is antialiased where the same rectangle on the page would not be.

pub fn for_uncolored_tile(&self) -> Self

The options an uncoloured tiling pattern’s cell renders under: alpha colour mode plus forced halftone.

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 PartialEq for RenderOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RenderOptions