Skip to main content

ClipStack

Struct ClipStack 

Source
pub struct ClipStack { /* private fields */ }
Expand description

The clipping state: an ordered list of contributions to intersect.

The entries sit behind an Arc, so the clone every emitted object takes of its graphics state shares them: thousands of consecutive paths under one clip cost one reference count each, and a push copies the vector only when it is shared. With the vector owned, the state clone was 9.6% of vector_paths_1751’s build.

Implementations§

Source§

impl ClipStack

Source

pub fn new() -> Self

An unclipped state.

Source

pub fn entries(&self) -> &[ClipEntry]

The contributions, outermost first.

Source

pub fn len(&self) -> usize

How many contributions there are.

Source

pub fn is_empty(&self) -> bool

Whether nothing clips.

Source

pub fn push_path(&mut self, path: BezPath, rule: ClipRule)

Add a path, merging it with a containing rectangle above it.

The merge is what keeps a re W n inside a larger re W n from producing two entries.

Source

pub fn push_text(&mut self, runs: Vec<TextClipRun>) -> Result<(), TextClipLimit>

Add a batch of clipping text runs.

A batch taking the total past MAX_TEXT_OBJECTS is dropped whole, not truncated — no prefix of it clips.

§Errors

TextClipLimit when the batch would take the stack past the cap. The stack is left unchanged; a refused batch does not re-offer itself at the next ET.

Source

pub fn push_empty(&mut self)

Add an empty clip, which blanks everything after it.

This is what a single-point path with a pending clip produces: a degenerate rectangle at the origin, whose interior is nothing.

Source

pub fn bounds(&self) -> Option<Rect>

The intersection of every contribution’s bounding box, or None when nothing clips.

Trait Implementations§

Source§

impl Clone for ClipStack

Source§

fn clone(&self) -> ClipStack

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 Debug for ClipStack

Source§

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

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

impl Default for ClipStack

Source§

fn default() -> ClipStack

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

impl PartialEq for ClipStack

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClipStack

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<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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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 = !

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.