Struct ScrollMetrics

pub struct ScrollMetrics {
    pub viewport: Size,
    pub content: Size,
}

Viewport/content sizes used to clamp a scroll state.

Examples

use ailloli_ui_core::{ScrollMetrics, Size};

let metrics = ScrollMetrics::new(Size::new(100.0, 80.0), Size::new(320.0, 240.0));
assert_eq!(metrics.viewport.w, 100.0);

Fields

viewport: Size

Visible viewport size in logical pixels.

content: Size

Full scrollable content size in logical pixels.

Implementations

impl ScrollMetrics

pub fn new(viewport: Size, content: Size) -> Self

Creates metrics without normalizing either size.

Examples

use ailloli_ui_core::{ScrollMetrics, Size};
let metrics = ScrollMetrics::new(Size::new(10.0, 20.0), Size::new(30.0, 40.0));
assert_eq!(metrics.content.h, 40.0);

pub fn max_offset(self) -> Offset

Returns the greatest non-negative logical offset on each axis.

Content smaller than its viewport produces zero. A non-finite subtraction also produces zero for that axis.

Examples

use ailloli_ui_core::{Offset, ScrollMetrics, Size};
let metrics = ScrollMetrics::new(Size::new(100.0, 80.0), Size::new(320.0, 240.0));
assert_eq!(metrics.max_offset(), Offset::new(220.0, 160.0));

Trait Implementations

impl Clone for ScrollMetrics

fn clone(&self) -> ScrollMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollMetrics

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

Formats the value using the given formatter.

impl PartialEq for ScrollMetrics

fn eq(&self, other: &ScrollMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ScrollMetrics

impl StructuralPartialEq for ScrollMetrics