Skip to main content

Renderer

Struct Renderer 

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

Draws windows. One serves every window; it holds the glyph and icon caches.

Implementations§

Source§

impl Renderer

Source

pub fn new() -> Renderer

A renderer with empty caches, looking icons up in the hicolor theme.

Source

pub fn set_icon_theme(&mut self, theme: impl Into<String>)

Sets the icon theme names are looked up in.

Source

pub fn forget_captures(&mut self, gone: &[u64])

Drops the scaled frames kept for screencopy views gone, at once: each is as large as its view, and an idle shell may draw nothing for a long while.

Source

pub fn next_image_frame(&mut self, now: Instant) -> Option<Instant>

When the next frame of an animated GIF is due, counting from now for one drawn since the last call. None while no GIF drawn plays. The platform wakes then and calls advance_images.

Source

pub fn advance_images(&mut self, now: Instant) -> Vec<u64>

Moves each GIF whose next frame is due by now on to it, and returns their image ids for the platform to repaint with Window::repaint_image. A GIF waits for its next frame only once that one is drawn, so one no longer shown wakes nothing more.

Source

pub fn draw( &mut self, view: &WindowView<'_>, damage: &[Rect], text: &mut TextSystem, history: &mut DamageHistory, canvas: Canvas<'_>, ) -> Result<Vec<PixelRect>, CanvasError>

Draws the laid-out window view into canvas and returns the areas to report with wl_surface.damage_buffer.

damage is what the window reported since the last draw, from Window::take_damage. The draw repaints that, plus what changed in frames this buffer missed according to history, or the whole buffer when that is more than half of it or the buffer is new. Text and glyphs come from text.

Commit the buffer after every successful draw, in order: the history counts each one as a frame the compositor showed.

§Errors

If canvas holds the wrong number of bytes for its size, or its scale isn’t a positive number. Nothing is drawn and the history doesn’t advance.

Trait Implementations§

Source§

impl Default for Renderer

Source§

fn default() -> Self

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more