Struct ClipperBuffer

pub struct ClipperBuffer<'a> { /* private fields */ }

Render to the temp buffer.

• It maps your widget area from layout coordinates to screen coordinates before rendering.
• It helps with cleanup of the widget state if your widget is currently invisible.

Implementations

impl<'a> ClipperBuffer<'a>

pub fn render_widget<W>(&mut self, widget: W, area: Rect)

where W: Widget,

Render a widget to the temp buffer.

pub fn render_stateful<W, S>(&mut self, widget: W, area: Rect, state: &mut S)

where W: StatefulWidget<State = S>, S: RelocatableState,

Render a widget to the temp buffer. This expects that the state is a RelocatableState, so it can reset the areas for hidden widgets.

pub fn render_widget_handle<W, Idx>( &mut self, widget: W, area: AreaHandle, tag: Idx, )

where W: Widget, [Rect]: Index<Idx, Output = Rect>,

Render a widget to the temp buffer.

pub fn render_stateful_handle<W, S, Idx>( &mut self, widget: W, area: AreaHandle, tag: Idx, state: &mut S, )

where W: StatefulWidget<State = S>, S: RelocatableState, [Rect]: Index<Idx, Output = Rect>,

Render a widget to the temp buffer. This expects that the state is a RelocatableState, so it can reset the areas for hidden widgets.

pub fn layout(&self) -> &ClipperLayout

Return the layout.

pub fn is_visible_area(&self, area: Rect) -> bool

Is the given area visible?

pub fn is_visible_handle(&self, handle: AreaHandle) -> bool

Is any of the areas behind the handle visible?

pub fn shift(&self) -> (i16, i16)

Calculate the necessary shift from view to screen.

pub fn locate_handle(&self, handle: AreaHandle) -> Box<[Rect]>

Locate an area from layout coordinates to buffer coordinates for rendering.

Any sub-area may be None if it is outside the buffer.

These are still not screen coordinates as the buffer may be clipped into place.

pub fn locate_area(&self, area: Rect) -> Rect

Locate an area coordinates to buffer coordinates for rendering.

pub fn relocate<S>(&self, state: &mut S)

where S: RelocatableState,

After rendering the widget to the buffer it may have stored areas in its state. These will be in buffer coordinates instead of screen coordinates.

Call this function to correct this after rendering.

pub fn hidden<S>(&self, state: &mut S)

where S: RelocatableState,

If a widget is not rendered because it is out of the buffer area, it may still have left over areas in its state.

This uses the mechanism for [relocate] to zero them out.

pub fn buffer_mut(&mut self) -> &mut Buffer

Access the temporary buffer.

Note Use of render_widget is preferred.

pub fn into_widget(self) -> ClipperWidget<'a>

Rendering the content is finished.

Convert to the output widget that can be rendered in the target area.

Trait Implementations

impl<'a> Debug for ClipperBuffer<'a>

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

Formats the value using the given formatter.