Skip to main content

DisplayList

Struct DisplayList 

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

A recorded list of rendering commands that can be replayed onto a pixmap.

The display list captures rendering operations so they can be executed later, potentially multiple times or at different scales. This is useful for caching page rendering results, implementing tiled rendering, and print preview.

Implementations§

Source§

impl DisplayList

Source

pub fn new(width: u32, height: u32) -> Self

Create a new empty display list with the given target dimensions.

Source

pub fn push(&mut self, cmd: DisplayCommand)

Record a command.

Source

pub fn len(&self) -> usize

Number of recorded commands.

Source

pub fn is_empty(&self) -> bool

Returns true if no commands have been recorded.

Source

pub fn commands(&self) -> &[DisplayCommand]

Get all commands.

Source

pub fn replay(&self, pixmap: &mut Pixmap)

Replay all commands onto a pixmap using the identity transform.

Source

pub fn replay_with_transform( &self, pixmap: &mut Pixmap, extra_transform: Transform, )

Replay all commands onto a pixmap with an extra transform applied to every drawing operation. This is useful for rendering at different scales or offsets without re-recording the display list.

Source

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

Compute the axis-aligned bounding box that encloses all paths in the display list. Returns None if no paths have been recorded.

Source

pub fn optimize(&mut self)

Remove redundant command sequences that have no visual effect.

Currently optimizes:

  • Consecutive Save / Restore pairs with nothing between them.
  • Consecutive BeginGroup / EndGroup pairs with nothing between them.
Source

pub fn width(&self) -> u32

Width of the target surface in pixels.

Source

pub fn height(&self) -> u32

Height of the target surface in pixels.

Source

pub fn render_tile( &self, tile_left: f32, tile_top: f32, tile_width: u32, tile_height: u32, ) -> Option<Pixmap>

Render a rectangular tile of the display list.

The tile is specified by its top-left corner (tile_left, tile_top) in the display list’s coordinate system, and its dimensions in pixels. The display list is replayed with a translation so that the tile region maps to (0, 0) on the output pixmap.

Returns None if the pixmap cannot be created (e.g. zero dimensions).

Source

pub fn render_tiled(&self, tile_size: u32, background: Color) -> Option<Pixmap>

Render the display list as a grid of tiles and composite them into a single output pixmap. This can reduce peak memory usage compared to rendering the full page at once when combined with command culling.

Returns None if the output pixmap cannot be created.

Trait Implementations§

Source§

impl Clone for DisplayList

Source§

fn clone(&self) -> DisplayList

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DisplayList

Source§

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

Formats the value using the given formatter. Read more

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