Struct Scroll 

pub struct Scroll {
    pub axis: ScrollAxis,
    pub sensitivity: f32,
    pub inertia: f32,
    pub velocity: Vec2,
}

Scrollable container configuration. Each instance carries its own sensitivity, inertia, and momentum.

Fields

axis: ScrollAxis

Allowed scroll axes.

sensitivity: f32

Multiplier on raw wheel-delta pixels (1.0 = normal, lower slows scrolling).

inertia: f32

Fraction of each wheel delta added to velocity instead of being applied to offset directly. Range [0.0, 1.0]; 0.0 produces instant jumps, ~0.4 a gentle glide, higher values longer fling.

velocity: Vec2

Per-container momentum in logical pixels per tick. Wheel events add to it; integrate_scroll decays it by INERTIA_DECAY each frame and writes the delta into ScrollOffset.

Implementations

impl Scroll

pub const fn vertical() -> Self

Returns a vertical scroller (axis = Y, sensitivity = 1.0, inertia = 0.4).

pub const fn horizontal() -> Self

Returns a horizontal scroller (axis = X, sensitivity = 1.0, inertia = 0.4).

pub const fn both() -> Self

Returns a two-axis scroller (axis = Both, sensitivity = 1.0, inertia = 0.4).

pub const fn with_sensitivity(self, sensitivity: f32) -> Self

Returns self with sensitivity overridden.

pub const fn with_inertia(self, inertia: f32) -> Self

Returns self with inertia overridden.

Trait Implementations

impl Clone for Scroll

fn clone(&self) -> Scroll

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Scroll

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for Scroll

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

Formats the value using the given formatter.

impl Default for Scroll

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Scroll