Struct InputOptions

pub struct InputOptions {
    pub line_scroll_speed: f32,
    pub scroll_zoom_speed: f32,
    pub max_click_dist: f32,
    pub max_click_duration: f64,
    pub max_double_click_delay: f64,
    pub zoom_modifier: Modifiers,
    pub horizontal_scroll_modifier: Modifiers,
    pub vertical_scroll_modifier: Modifiers,
}

Options for input state handling.

Fields

line_scroll_speed: f32

Multiplier for the scroll speed when reported in crate::MouseWheelUnit::Lines.

scroll_zoom_speed: f32

Controls the speed at which we zoom in when doing ctrl/cmd + scroll.

max_click_dist: f32

After a pointer-down event, if the pointer moves more than this, it won’t become a click.

max_click_duration: f64

If the pointer is down for longer than this it will no longer register as a click.

If a touch is held for this many seconds while still, then it will register as a “long-touch” which is equivalent to a secondary click.

This is to support “press and hold for context menu” on touch screens.

max_double_click_delay: f64

The new pointer press must come within this many seconds from previous pointer release for double click (or when this value is doubled, triple click) to count.

zoom_modifier: Modifiers

When this modifier is down, all scroll events are treated as zoom events.

The default is CTRL/CMD, and it is STRONGLY recommended to NOT change this.

horizontal_scroll_modifier: Modifiers

When this modifier is down, all scroll events are treated as horizontal scrolls, and when combined with Self::zoom_modifier it will result in zooming on only the horizontal axis.

The default is SHIFT, and it is STRONGLY recommended to NOT change this.

vertical_scroll_modifier: Modifiers

When this modifier is down, all scroll events are treated as vertical scrolls, and when combined with Self::zoom_modifier it will result in zooming on only the vertical axis.

Implementations

impl InputOptions

pub fn ui(&mut self, ui: &mut Ui)

Show the options in the ui.

Trait Implementations

impl Clone for InputOptions

fn clone(&self) -> InputOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputOptions

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

Formats the value using the given formatter.

impl Default for InputOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for InputOptions

fn eq(&self, other: &InputOptions) -> 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 InputOptions

impl StructuralPartialEq for InputOptions