Struct Renderer 

pub struct Renderer { /* private fields */ }

Immutable renderer for this release’s compatibility revision.

A renderer holds no per-render state: it is cheap to construct, Clone, Send and Sync, and one instance can serve concurrent renders.

Implementations

impl Renderer

pub fn new() -> Self

Constructs a renderer.

pub fn render( &self, scene: &SceneDocument, request: &RenderRequest, ) -> Result<RenderOutcome, RenderError>

Renders one admitted scene into the request’s selected output format.

Errors

Returns a RenderError when no complete artifact can be produced. Its category says why:

• Input: the scene has no finite bounds (scene.unbounded-geometry).
• Capability: a font the scene needs is not in this build (render.font-unavailable; see the crate’s cjk feature).
• ResourceLimit: the render crosses one of the request’s ResourceLimits (a resource.* code), or a required allocation failed (resource.memory-unavailable).
• NoMeaningfulArtifact: a PDF raster fallback was forbidden by the request or could not be isolated (pdf.raster-fallback-*).
• Encoding: writing the artifact failed (an encode.* code).
• Internal: a renderer invariant failed (render.internal-failure).

The error carries the complete report accumulated before the failure.

pub fn render_frame( &self, frame: FrameRef<'_>, request: &FrameRenderRequest, ) -> Result<RenderOutcome, RenderError>

Renders one discovered frame using reference frame-export semantics.

Errors

Returns a RenderError in the same categories as render. A frame whose viewport falls outside max_coordinate_magnitude fails with resource.coordinate-range-exceeded.

pub fn render_frames<'scene, 'request>( &self, scene: &'scene SceneDocument, frames: impl IntoIterator<Item = FrameRef<'scene>>, request: &'request FrameRenderRequest, ) -> Result<FrameRenderCursor<'scene, 'request>, FrameBatchError>

Starts lazy source-ordered rendering for selected frames.

Errors

Returns a FrameBatchError before rendering anything when a selected frame belongs to another scene document (frame-batch.foreign-target), when the same frame is selected twice (frame-batch.duplicate-target), or when the preparation the frames share cannot be completed (frame-batch.shared-preparation-failed). Each frame’s own render failure is reported by its FrameRenderEntry instead.

Trait Implementations

impl Clone for Renderer

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 Renderer

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

Formats the value using the given formatter.

impl Default for Renderer

fn default() -> Self

Returns the “default value” for a type.