Skip to content

zwlr_virtual_pointer_v1¤

wayland.zwlr_virtual_pointer_v1 ¤

Virtual pointer

This protocol allows clients to emulate a physical pointer device. The requests are mostly mirror opposites of those specified in wl_pointer.

Methods:

error ¤

motion ¤

motion(time: int, dx: float, dy: float) -> None

Pointer relative motion event

The pointer has moved by a relative amount to the previous request.

Values are in the global compositor space.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • dx ¤

    (float) –

    Displacement on the x-axis

  • dy ¤

    (float) –

    Displacement on the y-axis

motion_absolute ¤

motion_absolute(time: int, x: int, y: int, x_extent: int, y_extent: int) -> None

Pointer absolute motion event

The pointer has moved in an absolute coordinate frame.

Value of x can range from 0 to x_extent, value of y can range from 0 to y_extent.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • x ¤

    (int) –

    Position on the x-axis

  • y ¤

    (int) –

    Position on the y-axis

  • x_extent ¤

    (int) –

    Extent of the x-axis

  • y_extent ¤

    (int) –

    Extent of the y-axis

button ¤

button(time: int, button: int, state: button_state) -> None

Button event

A button was pressed or released.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • button ¤

    (int) –

    Button that produced the event

  • state ¤

    (button_state) –

    Physical state of the button

axis ¤

axis(time: int, axis: axis, value: float) -> None

Axis event

Scroll and other axis requests.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • axis ¤

    (axis) –

    Axis type

  • value ¤

    (float) –

    Length of vector in touchpad coordinates

frame ¤

frame() -> None

End of a pointer event sequence

Indicates the set of events that logically belong together.

axis_source ¤

axis_source(axis_source: axis_source) -> None

Axis source event

Source information for scroll and other axis.

Parameters:

axis_stop ¤

axis_stop(time: int, axis: axis) -> None

Axis stop event

Stop notification for scroll and other axes.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • axis ¤

    (axis) –

    The axis stopped with this event

axis_discrete ¤

axis_discrete(time: int, axis: axis, value: float, discrete: int) -> None

Axis click event

Discrete step information for scroll and other axes.

This event allows the client to extend data normally sent using the axis event with discrete value.

Parameters:

  • time ¤

    (int) –

    Timestamp with millisecond granularity

  • axis ¤

    (axis) –

    Axis type

  • value ¤

    (float) –

    Length of vector in touchpad coordinates

  • discrete ¤

    (int) –

    Number of steps

destroy ¤

destroy() -> None

Destroy the virtual pointer object