1XIQUERYPOINTER(3)                                            XIQUERYPOINTER(3)
2
3
4

NAME

6       XIQueryPointer - get device pointer coordinates.
7

SYNOPSIS

9       #include <X11/extensions/XInput2.h>
10
11       Bool XIQueryPointer( Display *display,
12                            int deviceid,
13                            Window win,
14                            Window *root_return,
15                            Window *child_return,
16                            double *root_x_return,
17                            double *root_y_return,
18                            double *win_x_return,
19                            double *win_y_return,
20                            XIButtonState *buttons_return,
21                            XIModifierState *modifiers_return,
22                            XIGroupState *group_return);
23
24       buttons_return
25              Returns the current button state.
26
27       child_return
28              Returns the child window that the pointer is located in,
29              if any.
30
31       deviceid
32              Specifies the device to query.
33
34       display
35              Specifies the connection to the X server.
36
37       group_return
38              Returns the current group state.
39
40       modifiers_return
41              Returns the current state of the modifier keys.
42
43       root_return
44              Returns the root window that the pointer is in.
45
46       root_x_return, root_y_return
47              Return the pointer coordinates relative to the root
48              window's origin.
49
50       win
51              Specifies the window.
52
53       win_x_return, win_y_return
54              Return the pointer coordinates relative to the specified
55              window.
56

DESCRIPTION

58           The XIQueryPointer function returns the root window the
59           device's pointer is logically on and the pointer coordinates
60           relative to the root window's origin. If XIQueryPointer returns
61           False, the pointer is not on the same screen as the specified
62           window, and XIQueryPointer returns None to child_return and
63           zero to win_x_return and win_y_return. If XIQueryPointer
64           returns True, the pointer coordinates returned to win_x_return
65           and win_y_return are relative to the origin of the specified
66           window. In this case, XIQueryPointer returns the child that
67           contains the pointer, if any, or else None to child_return.
68
69           XIQueryPointer returns the current logical state of the buttons
70           buttons_return. The keyboard paired with the master pointer is
71           selected to obtain the data for modifiers_return and
72           group_return.
73
74           The mask field in buttons_return is dynamically allocated and
75           must be freed by the caller.
76
77           XIQueryPointer is identical to XQueryPointer but specifies the
78           device explicitly.
79
80           XIQueryPointer can generate a BadDevice and a BadWindow error.
81

DIAGNOSTICS

83           BadDevice
84                  An invalid device was specified. The device does not
85                  exist or is not a pointer device.
86
87           BadWindow
88                  A value for a Window argument does not name a defined
89                  window.
90

SEE ALSO

92           XQueryPointer(3)
93
94
95
96                                  09/15/2021                 XIQUERYPOINTER(3)
Impressum