Enum wayland_client::protocol::wl_touch::Event

#[non_exhaustive]
pub enum Event {
    Down {
        serial: u32,
        time: u32,
        surface: WlSurface,
        id: i32,
        x: f64,
        y: f64,
    },
    Up {
        serial: u32,
        time: u32,
        id: i32,
    },
    Motion {
        time: u32,
        id: i32,
        x: f64,
        y: f64,
    },
    Frame,
    Cancel,
    Shape {
        id: i32,
        major: f64,
        minor: f64,
    },
    Orientation {
        id: i32,
        orientation: f64,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Down

touch down event and beginning of a touch sequence

A new touch point has appeared on the surface. This touch point is assigned a unique ID. Future events from this touch point reference this ID. The ID ceases to be valid after a touch up event and may be reused in the future.

Fields

serial: u32

serial number of the touch down event

time: u32

timestamp with millisecond granularity

surface: WlSurface

surface touched

id: i32

the unique ID of this touch point

x: f64

surface-local x coordinate

y: f64

surface-local y coordinate

Up

end of a touch event sequence

The touch point has disappeared. No further events will be sent for this touch point and the touch point’s ID is released and may be reused in a future touch down event.

Fields

serial: u32

serial number of the touch up event

time: u32

timestamp with millisecond granularity

id: i32

the unique ID of this touch point

Motion

update of touch point coordinates

A touch point has changed coordinates.

Fields

time: u32

timestamp with millisecond granularity

id: i32

the unique ID of this touch point

x: f64

surface-local x coordinate

y: f64

surface-local y coordinate

Frame

end of touch frame event

Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding.

A wl_touch.frame terminates at least one event but otherwise no guarantee is provided about the set of events within a frame. A client must assume that any state not updated in a frame is unchanged from the previously known state.

Cancel

touch session cancelled

Sent if the compositor decides the touch stream is a global gesture. No further events are sent to the clients from that particular gesture. Touch cancellation applies to all touch points currently active on this client’s surface. The client is responsible for finalizing the touch points, future touch points on this surface may reuse the touch point ID.

Shape

update shape of touch point

Sent when a touchpoint has changed its shape.

This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for any previously reported, or new touch points of that frame.

Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.orientation may be sent within the same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed. A wl_touch.down event is guaranteed to occur before the first wl_touch.shape event for this touch ID but both events may occur within the same wl_touch.frame.

A touchpoint shape is approximated by an ellipse through the major and minor axis length. The major axis length describes the longer diameter of the ellipse, while the minor axis length describes the shorter diameter. Major and minor are orthogonal and both are specified in surface-local coordinates. The center of the ellipse is always at the touchpoint location as reported by wl_touch.down or wl_touch.move.

This event is only sent by the compositor if the touch device supports shape reports. The client has to make reasonable assumptions about the shape if it did not receive this event.

Only available since version 6 of the interface

Fields

id: i32

the unique ID of this touch point

major: f64

length of the major axis in surface-local coordinates

minor: f64

length of the minor axis in surface-local coordinates

Orientation

update orientation of touch point

Sent when a touchpoint has changed its orientation.

This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for any previously reported, or new touch points of that frame.

Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.shape may be sent within the same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed. A wl_touch.down event is guaranteed to occur before the first wl_touch.orientation event for this touch ID but both events may occur within the same wl_touch.frame.

The orientation describes the clockwise angle of a touchpoint’s major axis to the positive surface y-axis and is normalized to the -180 to +180 degree range. The granularity of orientation depends on the touch device, some devices only support binary rotation values between 0 and 90 degrees.

This event is only sent by the compositor if the touch device supports orientation reports.

Only available since version 6 of the interface

Fields

id: i32

the unique ID of this touch point

orientation: f64

angle between major axis and positive surface y-axis in degrees

Implementations

impl Event

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.