Layout

Struct Layout 

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

Defines a horizontal and vertical grid layout setup.

Layout is used for separating a given total space (e.g., the window size) into easy-to-manage rectangular chunks for rendering UI elements.

Implementations§

Source§

impl Layout

Source

pub fn new() -> Self

Starts a new Layout definition.

Source

pub fn row( self, height_constraint: Constraint, width_constraints: Vec<Constraint>, ) -> Self

Adds a new row to the layout with specified height and column width constraints.

Source

pub fn empty_row(self, constraint: Constraint) -> Self

Creates a row that takes up the full width of the available space with a single height constraint.

Source

pub fn calculate( self, space: impl Into<Vec2>, ) -> Result<Vec<Vec<Rect>>, LayoutError>

Calculates the Rects for all elements in the layout based on the total available space.

Source

pub fn render<R: Render>( self, space: impl Into<Vec2>, buffer: &mut Buffer, elements: Vec<Vec<R>>, ) -> Result<Vec<Vec<Rect>>, LayoutError>

Calculates the layout and renders elements to each rect area.

Source

pub fn render_clipped<R: Render>( self, space: impl Into<Vec2>, buffer: &mut Buffer, elements: Vec<Vec<R>>, ) -> Result<Vec<Vec<Rect>>, LayoutError>

Calculates the layout and renders elements with clipping to fit within each rect.

Trait Implementations§

Source§

impl Clone for Layout

Source§

fn clone(&self) -> Layout

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 Layout

Source§

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

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

impl Default for Layout

Source§

fn default() -> Layout

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

Auto Trait Implementations§

§

impl Freeze for Layout

§

impl RefUnwindSafe for Layout

§

impl Send for Layout

§

impl Sync for Layout

§

impl Unpin for Layout

§

impl UnwindSafe for Layout

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