Struct wayland_protocols::unstable::tablet::v1::client::zwp_tablet_tool_v1::ZwpTabletToolV1

pub struct ZwpTabletToolV1(_);

Implementations

impl ZwpTabletToolV1

pub fn set_cursor(
    &self,
    serial: u32,
    surface: Option<&WlSurface>,
    hotspot_x: i32,
    hotspot_y: i32
)

set the tablet tool's surface

Sets the surface of the cursor used for this tool on the given tablet. This request only takes effect if the tool is in proximity of one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the cursor image is hidden.

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

The current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

This request gives the surface the role of a cursor. The role assigned by this request is the same as assigned by wl_pointer.set_cursor meaning the same surface can be used both as a wl_pointer cursor and a wp_tablet cursor. If the surface already has another role, it raises a protocol error. The surface may be used on multiple tablets and across multiple seats.

pub fn destroy(&self)

destroy the tool object

This destroys the client's resource for this tool object.

This is a destructor, you cannot send requests to this object any longer once this method is called.

Trait Implementations

impl AsRef<Proxy<ZwpTabletToolV1>> for ZwpTabletToolV1

fn as_ref(&self) -> &Proxy<Self>

Performs the conversion.

impl Clone for ZwpTabletToolV1

fn clone(&self) -> ZwpTabletToolV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpTabletToolV1

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

Formats the value using the given formatter.

impl Eq for ZwpTabletToolV1

impl From<Proxy<ZwpTabletToolV1>> for ZwpTabletToolV1

fn from(value: Proxy<Self>) -> Self

Performs the conversion.

impl From<ZwpTabletToolV1> for Proxy<ZwpTabletToolV1>

fn from(value: ZwpTabletToolV1) -> Self

Performs the conversion.

impl Interface for ZwpTabletToolV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwpTabletToolV1> for ZwpTabletToolV1

fn eq(&self, other: &ZwpTabletToolV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ZwpTabletToolV1) -> bool

This method tests for !=.

impl StructuralEq for ZwpTabletToolV1

impl StructuralPartialEq for ZwpTabletToolV1