Skip to main content

ScrollMetrics

cranpose_ui::scroll

Struct ScrollMetrics 

Source 
pub struct ScrollMetrics {
    pub offset: f32,
    pub max_offset: f32,
    pub viewport_extent: f32,
}
Expand description

A scroll position and the extents it is measured against, read together.

Fields§

§offset: f32

How far the content has travelled, in logical pixels.

§max_offset: f32

The furthest it can travel. Zero when the content fits.

§viewport_extent: f32

How much of the content is on screen.

Implementations§

Source§

impl ScrollMetrics

Source

pub fn content_extent(self) -> f32

The whole scrollable content along the main axis.

Source

pub fn progress(self) -> f32

How far through the scroll the content is, in 0..=1.

Source

pub fn thumb(self, bounds: ThumbBounds) -> Option<ThumbGeometry>

The thumb an indicator of this scroll should draw, given how short its thumb may get, or None when the content fits.

Trait Implementations§

Source§

impl Clone for ScrollMetrics

Source§

fn clone(&self) -> ScrollMetrics

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ScrollMetrics

Source§

impl Debug for ScrollMetrics

Source§

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

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

impl PartialEq for ScrollMetrics

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScrollMetrics

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, 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 = !

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.