Struct taffy::tree::LayoutInput

source ·
pub struct LayoutInput {
    pub run_mode: RunMode,
    pub sizing_mode: SizingMode,
    pub axis: RequestedAxis,
    pub known_dimensions: Size<Option<f32>>,
    pub parent_size: Size<Option<f32>>,
    pub available_space: Size<AvailableSpace>,
    pub vertical_margins_are_collapsible: Line<bool>,
}
Expand description

A struct containing the inputs constraints/hints for laying out a node, which are passed in by the parent

Fields§

§run_mode: RunMode

Whether we only need to know the Node’s size, or whe

§sizing_mode: SizingMode

Whether a Node’s style sizes should be taken into account or ignored

§axis: RequestedAxis

Which axis we need the size of

§known_dimensions: Size<Option<f32>>

Known dimensions represent dimensions (width/height) which should be taken as fixed when performing layout. For example, if known_dimensions.width is set to Some(WIDTH) then this means something like:

“What would the height of this node be, assuming the width is WIDTH”

Layout functions will be called with both known_dimensions set for final layout. Where the meaning is:

“The exact size of this node is WIDTHxHEIGHT. Please lay out your children”

§parent_size: Size<Option<f32>>

Parent size dimensions are intended to be used for percentage resolution.

§available_space: Size<AvailableSpace>

Available space represents an amount of space to layout into, and is used as a soft constraint for the purpose of wrapping.

§vertical_margins_are_collapsible: Line<bool>

Specific to CSS Block layout. Used for correctly computing margin collapsing. You probably want to set this to Line::FALSE.

Implementations§

source§

impl LayoutInput

source

pub const HIDDEN: LayoutInput = _

A LayoutInput that can be used to request hidden layout

Trait Implementations§

source§

impl Clone for LayoutInput

source§

fn clone(&self) -> LayoutInput

Returns a copy 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 LayoutInput

source§

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

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

impl Copy for LayoutInput

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.