1xcb_warp_pointer(3)              XCB Requests              xcb_warp_pointer(3)
2
3
4

NAME

6       xcb_warp_pointer - move mouse pointer
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_void_cookie_t xcb_warp_pointer(xcb_connection_t *conn,
13              xcb_window_t src_window, xcb_window_t dst_window, int16_t src_x,
14              int16_t src_y, uint16_t src_width, uint16_t src_height,
15              int16_t dst_x, int16_t dst_y);
16

REQUEST ARGUMENTS

18       conn      The XCB connection to X11.
19
20       src_window
21                 If src_window is not XCB_NONE (TODO), the move will only take
22                 place if the pointer is inside src_window and within the rec‐
23                 tangle specified by (src_x, src_y, src_width, src_height).
24                 The rectangle coordinates are relative to src_window.
25
26       dst_window
27                 If dst_window is not XCB_NONE (TODO), the pointer will be
28                 moved to the offsets (dst_x, dst_y) relative to dst_window.
29                 If dst_window is XCB_NONE (TODO), the pointer will be moved
30                 by the offsets (dst_x, dst_y) relative to the current posi‐
31                 tion of the pointer.
32
33       src_x     TODO: NOT YET DOCUMENTED.
34
35       src_y     TODO: NOT YET DOCUMENTED.
36
37       src_width TODO: NOT YET DOCUMENTED.
38
39       src_height
40                 TODO: NOT YET DOCUMENTED.
41
42       dst_x     TODO: NOT YET DOCUMENTED.
43
44       dst_y     TODO: NOT YET DOCUMENTED.
45

DESCRIPTION

47       Moves the mouse pointer to the specified position.
48
49       If src_window is not XCB_NONE (TODO), the move will only take place if
50       the pointer is inside src_window and within the rectangle specified by
51       (src_x, src_y, src_width, src_height). The rectangle coordinates are
52       relative to src_window.
53
54       If dst_window is not XCB_NONE (TODO), the pointer will be moved to the
55       offsets (dst_x, dst_y) relative to dst_window. If dst_window is
56       XCB_NONE (TODO), the pointer will be moved by the offsets (dst_x,
57       dst_y) relative to the current position of the pointer.
58

RETURN VALUE

60       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
61       event loop.
62
63       If you want to handle errors directly with xcb_request_check instead,
64       use xcb_warp_pointer_checked. See xcb-requests(3) for details.
65

ERRORS

67       xcb_window_error_t
68                 TODO: reasons?
69

SEE ALSO

71       xcb-requests(3), xcb_set_input_focus(3)
72

AUTHOR

74       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
75       rections and improvements.
76
77
78
79X Version 11                      libxcb 1.12              xcb_warp_pointer(3)
Impressum