Skip to main content

Renderer

Struct Renderer 

Source
pub struct Renderer<'a> { /* private fields */ }
Expand description

A document’s renderer: the per-document caches (fonts, CMYK table, decoded image samples) that its page renders share. The pipeline renders every page at two scales; hold one Renderer per document across both.

Implementations§

Source§

impl<'a> Renderer<'a>

Source

pub fn new(meta: &'a PdfMeta) -> Renderer<'a>

A renderer decoding its JPEGs for docling’s bitmap hint (1.0 pixel per PDF unit — the model-input renders).

Source

pub fn with_bitmap_hint(meta: &'a PdfMeta, bitmap_hint: f64) -> Renderer<'a>

A renderer with an explicit bitmap_target_pixels_per_unit: 0.0 decodes every image at full size (the page rasters a caller keeps — render_pages, the VLM input — where docling-parse is asked with 0.0 too).

Source

pub fn render_scaled(&self, index: usize, scale: f64) -> Option<RgbImage>

Render page index at scale pixels per point the way docling-parse sizes its canvas (display orientation, /Rotate applied).

Source

pub fn render(&self, index: usize, width: u32, height: u32) -> Option<RgbImage>

Render page index into exactly width × height display-frame pixels (the crop box stretched onto the canvas, as every renderer here does).

Source

pub fn render_with_hint( &self, index: usize, width: u32, height: u32, bitmap_hint: f64, ) -> Option<RgbImage>

Renderer::render with an explicit bitmap_target_pixels_per_unit for this one render: 1.0 decodes JPEGs the way docling’s model inputs are decoded, 0.0 at full size — what a bitmap kept for OCR wants (the recognizer reads a scan’s 300 dpi, not a quarter of it blitted up; docling’s own OCR runs on its hint-1.0 decode, the deliberate deviation the pdfium raster of a scan already makes).

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Renderer<'a>

§

impl<'a> !Send for Renderer<'a>

§

impl<'a> !Sync for Renderer<'a>

§

impl<'a> !UnwindSafe for Renderer<'a>

§

impl<'a> Freeze for Renderer<'a>

§

impl<'a> Unpin for Renderer<'a>

§

impl<'a> UnsafeUnpin for Renderer<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V