Struct backer::Node

pub struct Node<State> { /* private fields */ }

A layout tree node. Use methods in crate::nodes to create nodes.

Implementations

impl<U> Node<U>

pub fn pad_leading(self, amount: f32) -> Node<U>

Adds padding to the node along the leading edge

pub fn pad_x(self, amount: f32) -> Node<U>

Adds horizontal padding to the node (leading & trailing)

pub fn pad_trailing(self, amount: f32) -> Node<U>

Adds padding to the node along the trailing edge

pub fn pad_top(self, amount: f32) -> Node<U>

Adds padding to the node along the top edge

pub fn pad_y(self, amount: f32) -> Node<U>

Adds vertical padding to the node (top & bottom)

pub fn pad_bottom(self, amount: f32) -> Node<U>

Adds padding to the node along the bottom edge

pub fn pad(self, amount: f32) -> Node<U>

Adds padding to the node on all sides

pub fn offset_x(self, amount: f32) -> Node<U>

Offsets the node along the x axis. This is an absolute offset that simply shifts nodes away from their calculated position This won’t impact layout besides child nodes also being offset

pub fn offset_y(self, amount: f32) -> Node<U>

Offsets the node along the y axis. This is an absolute offset that simply shifts nodes away from their calculated position This won’t impact layout besides child nodes also being offset

pub fn offset(self, offset_x: f32, offset_y: f32) -> Node<U>

Offsets the node along the x & y axis. This is an absolute offset that simply shifts nodes away from their calculated position This won’t impact layout besides child nodes also being offset

pub fn width(self, width: f32) -> Self

Specifies an explicit width for a node

pub fn height(self, height: f32) -> Self

Specifies an explicit height for a node

pub fn height_range<R>(self, range: R) -> Self

where R: RangeBounds<f32>,

Specifies bounds on a node’s height

pub fn width_range<R>(self, range: R) -> Self

where R: RangeBounds<f32>,

Specifies bounds on a node’s width

pub fn align(self, align: Align) -> Self

Specifies an alignment along the x and/or y axis.

This will only have an effect if the node is constrained along the axis to be smaller than the area that is available, otherwise, there’s no wiggle room.

pub fn aspect(self, ratio: f32) -> Self

Constrains the node’s height to ratio of width

pub fn dynamic_height(self, f: impl Fn(f32, &mut U) -> f32 + 'static) -> Self

Constrains the node’s height as a function of available width.

Generally you should prefer size constraints, aspect ratio constraints or area readers over dynamic height.

This is primarily for UI elements such as text where node height must depend on available width & scaling is not a simple option.

pub fn dynamic_width(self, f: impl Fn(f32, &mut U) -> f32 + 'static) -> Self

Constrains the node’s width as a function of available height.

Generally you should prefer size constraints, aspect ratio constraints or area readers over dynamic height.

This is primarily for UI elements such as text where node width must depend on available height & scaling is not a simple option.

Trait Implementations

impl<State> Clone for Node<State>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State: Debug> Debug for Node<State>

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

Formats the value using the given formatter.