Skip to main content

TextRenderMode

Enum TextRenderMode 

Source
pub enum TextRenderMode {
    Fill,
    Stroke,
    FillStroke,
    Invisible,
    FillClip,
    StrokeClip,
    FillStrokeClip,
    Clip,
}
Expand description

Text rendering mode — the integer argument to the Tr operator (ISO 32000-1 §9.3.6, Table 106). Determines whether the glyphs of a text run are filled, stroked, used as a clipping boundary, or left unpainted entirely. Surfaced on every TextRun so an extraction consumer can distinguish visible body text from the invisible (3 Tr) OCR layer that scanned PDFs hide behind a page image, and from the clip-only (7 Tr) modes that paint no marks at all.

Variants§

§

Fill

0 — fill text (the default when no Tr is issued).

§

Stroke

1 — stroke text.

§

FillStroke

2 — fill, then stroke text.

§

Invisible

3 — neither fill nor stroke (invisible). The OCR text layer behind a scanned-page image uses this so the glyphs are searchable / selectable but never painted.

§

FillClip

4 — fill text and add to the path for clipping.

§

StrokeClip

5 — stroke text and add to the path for clipping.

§

FillStrokeClip

6 — fill, then stroke text and add to the path for clipping.

§

Clip

7 — add text to the path for clipping (no fill, no stroke).

Implementations§

Source§

impl TextRenderMode

Source

pub fn from_operand(n: i64) -> Self

Resolve a Tr operand integer to its typed mode. Table 106 enumerates exactly 0..=7; out-of-range values are tolerated by mapping back to TextRenderMode::Fill (the §9.3.1 default text state), matching the reader’s lenient stance elsewhere.

Source

pub fn paints_glyphs(self) -> bool

Whether glyphs in this mode paint any visible marks. false only for TextRenderMode::Invisible (3) and TextRenderMode::Clip (7) — the two modes that add nothing to the page raster. Lets a “visible text only” consumer filter the OCR layer out in one call.

Trait Implementations§

Source§

impl Clone for TextRenderMode

Source§

fn clone(&self) -> TextRenderMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TextRenderMode

Source§

impl Debug for TextRenderMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextRenderMode

Source§

fn default() -> TextRenderMode

Returns the “default value” for a type. Read more
Source§

impl Eq for TextRenderMode

Source§

impl PartialEq for TextRenderMode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TextRenderMode

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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