Struct egui::containers::scroll_area::State

pub struct State {
    pub offset: Vec2,
    offset_target: [Option<ScrollTarget>; 2],
    show_scroll: Vec2b,
    content_is_too_large: Vec2b,
    scroll_bar_interaction: Vec2b,
    vel: Vec2,
    scroll_start_offset_from_top_left: [Option<f32>; 2],
    scroll_stuck_to_end: Vec2b,
    interact_rect: Option<Rect>,
}

Fields

offset: Vec2

Positive offset means scrolling down/right

offset_target: [Option<ScrollTarget>; 2]

If set, quickly but smoothly scroll to this target offset.

show_scroll: Vec2b

Were the scroll bars visible last frame?

content_is_too_large: Vec2b

The content were to large to fit large frame.

scroll_bar_interaction: Vec2b

Did the user interact (hover or drag) the scroll bars last frame?

vel: Vec2

Momentum, used for kinetic scrolling

scroll_start_offset_from_top_left: [Option<f32>; 2]

Mouse offset relative to the top of the handle when started moving the handle.

scroll_stuck_to_end: Vec2b

Is the scroll sticky. This is true while scroll handle is in the end position and remains that way until the user moves the scroll_handle. Once unstuck (false) it remains false until the scroll touches the end position, which reenables stickiness.

interact_rect: Option<Rect>

Area that can be dragged. This is the size of the content from the last frame.

Implementations

impl State

pub fn load(ctx: &Context, id: Id) -> Option<Self>

pub fn store(self, ctx: &Context, id: Id)

pub fn velocity(&self) -> Vec2

Get the current kinetic scrolling velocity.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl Copy for State