Struct smithay::wayland::seat::AxisFrame

pub struct AxisFrame { /* fields omitted */ }

A frame of pointer axis events.

Can be used with the builder pattern, e.g.:

AxisFrame::new()
    .source(AxisSource::Wheel)
    .discrete(Axis::Vertical, 6)
    .value(Axis::Vertical, 30, time)
    .stop(Axis::Vertical);

Implementations

impl AxisFrame

pub fn new(time: u32) -> Self

Create a new frame of axis events

pub fn source(self, source: AxisSource) -> Self

Specify the source of the axis events

This event is optional, if no source is known, you can ignore this call. Only one source event is allowed per frame.

Using the AxisSource::Finger requires a stop event to be send, when the user lifts off the finger (not necessarily in the same frame).

pub fn discrete(self, axis: Axis, steps: i32) -> Self

Specify discrete scrolling steps additionally to the computed value.

This event is optional and gives the client additional information about the nature of the axis event. E.g. a scroll wheel might issue separate steps, while a touchpad may never issue this event as it has no steps.

pub fn value(self, axis: Axis, value: f64) -> Self

The actual scroll value. This event is the only required one, but can also be send multiple times. The values off one frame will be accumulated by the client.

pub fn stop(self, axis: Axis) -> Self

Notification of stop of scrolling on an axis.

This event is required for sources of the AxisSource::Finger type and otherwise optional.

Trait Implementations

impl Clone for AxisFrame

fn clone(&self) -> AxisFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisFrame

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

Formats the value using the given formatter.

impl Copy for AxisFrame