Trait wayland_protocols::unstable::tablet::v2::client::zwp_tablet_tool_v2::RequestsTrait

pub trait RequestsTrait {
    fn set_cursor(
        &self, 
        serial: u32, 
        surface: Option<&Proxy<WlSurface>>, 
        hotspot_x: i32, 
        hotspot_y: i32
    );
    fn destroy(&self);
}

Required methods

fn set_cursor(
    &self,
    serial: u32,
    surface: Option<&Proxy<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 wp_tablet_tool cursor. A surface may only ever be used as the cursor surface for one wp_tablet_tool. If the surface already has another role or has previously been used as cursor surface for a different tool, a protocol error is raised.

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.

Loading content...

Implementations on Foreign Types

impl RequestsTrait for Proxy<ZwpTabletToolV2>

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

fn destroy(&self)

Loading content...

Implementors

Loading content...