Struct LayoutMetrics

pub struct LayoutMetrics { /* private fields */ }

Layout metrics in a LAYOUT context.

Implementations

impl LayoutMetrics

pub fn new(scale_factor: Factor, viewport: PxSize, font_size: Px) -> Self

New root LayoutMetrics.

The font_size sets both font sizes, the initial PPI is 96.0, you can use the builder style method and with_screen_ppi to set a different value.

pub fn constraints(&self) -> PxConstraints2d

Current size constraints.

pub fn z_constraints(&self) -> PxConstraints

Current perspective constraints.

pub fn inline_constraints(&self) -> Option<InlineConstraints>

Current inline constraints.

Only present if the parent widget supports inline.

pub fn direction(&self) -> LayoutDirection

Gets the inline or text flow direction.

pub fn font_size(&self) -> Px

Current computed font size.

pub fn root_font_size(&self) -> Px

Computed font size at the root widget.

pub fn scale_factor(&self) -> Factor

Pixel scale factor.

pub fn viewport(&self) -> PxSize

Computed size of the nearest viewport ancestor.

This is usually the window content area size, but can be the scroll viewport size or any other value depending on the implementation of the context widgets.

pub fn viewport_min(&self) -> Px

Smallest dimension of the viewport.

pub fn viewport_max(&self) -> Px

Largest dimension of the viewport.

pub fn screen_ppi(&self) -> Ppi

The current screen “pixels-per-inch” resolution.

This value is dependent in the actual physical size of the screen.

Default is 96.0.

pub fn leftover(&self) -> Size2D<Option<Px>, ()>

Computed leftover length for the widget, given the Length::Leftover value it communicated to the parent.

pub fn with_constraints(self, constraints: PxConstraints2d) -> Self

Sets the constraints to constraints.

pub fn with_z_constraints(self, constraints: PxConstraints) -> Self

Sets the z_constraints to constraints.

pub fn with_inline_constraints( self, inline_constraints: Option<InlineConstraints>, ) -> Self

Set the inline_constraints.

pub fn with_font_size(self, font_size: Px) -> Self

Sets the font_size.

pub fn with_viewport(self, viewport: PxSize) -> Self

Sets the viewport.

pub fn with_scale_factor(self, scale_factor: Factor) -> Self

Sets the scale_factor.

pub fn with_screen_ppi(self, screen_ppi: Ppi) -> Self

Sets the screen_ppi.

pub fn with_direction(self, direction: LayoutDirection) -> Self

Sets the direction.

pub fn with_leftover(self, width: Option<Px>, height: Option<Px>) -> Self

Sets the leftover.

pub fn snapshot(&self) -> LayoutMetricsSnapshot

Clones all current metrics into a snapshot.

Trait Implementations

impl Clone for LayoutMetrics

fn clone(&self) -> LayoutMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutMetrics

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

Formats the value using the given formatter.