XQueryPointer(3) XLIB FUNCTIONS XQueryPointer(3)NAME
XQueryPointer - get pointer coordinates
SYNTAX
Bool XQueryPointer(Display *display, Window w, Window *root_return, Window *child_return, int *root_x_return, int *root_y_return, int
*win_x_return, int *win_y_return, unsigned int *mask_return);
ARGUMENTS
child_return
Returns the child window that the pointer is located in, if any.
display Specifies the connection to the X server.
mask_return
Returns the current state of the modifier keys and pointer buttons.
root_return
Returns the root window that the pointer is in.
root_x_return
root_y_return
Return the pointer coordinates relative to the root window's origin.
w Specifies the window.
win_x_return
win_y_return
Return the pointer coordinates relative to the specified window.
DESCRIPTION
The XQueryPointer function returns the root window the pointer is logically on and the pointer coordinates relative to the root window's
origin. If XQueryPointer returns False, the pointer is not on the same screen as the specified window, and XQueryPointer returns None to
child_return and zero to win_x_return and win_y_return. If XQueryPointer returns True, the pointer coordinates returned to win_x_return
and win_y_return are relative to the origin of the specified window. In this case, XQueryPointer returns the child that contains the
pointer, if any, or else None to child_return.
XQueryPointer returns the current logical state of the keyboard buttons and the modifier keys in mask_return. It sets mask_return to the
bitwise inclusive OR of one or more of the button or modifier key bitmasks to match the current state of the mouse buttons and the modifier
keys.
XQueryPointer can generate a BadWindow error.
DIAGNOSTICS
BadWindow A value for a Window argument does not name a defined Window.
SEE ALSO XGetWindowAttributes(3), XQueryTree(3)
Xlib - C Language X Interface
X Version 11 libX11 1.3.2 XQueryPointer(3)
Check Out this Related Man Page
XQueryPointer() XQueryPointer()
Name
XQueryPointer - get the current pointer location.
Synopsis
Bool XQueryPointer(display, window, root_return, child_return, root_x_return, root_y_return, win_x_return, win_y_return, mask_return)
Display *display;
Window window;
Window *root_return, *child_return;
int *root_x_return, *root_y_return;
int *win_x_return, *win_y_return;
unsigned int *mask_return;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
window Specifies a window which indicates which screen the pointer position is returned for, and child_return will be a child of this
window if pointer is inside a child.
root_return Returns the root window ID the pointer is currently on.
child_return
Returns the ID of the child of w the pointer is located in, or zero if it not in a child.
root_x_returReturn the x and y coordinates of the pointer relative to the root's origin.
root_y_return
win_x_returnReturn the x and y coordinates of the pointer relative to the origin of window window.
win_y_return
mask_return Returns the current state of the modifier keys and pointer buttons. This is a mask composed of the OR of any number of the
following symbols: ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, But-
ton2Mask, Button3Mask, Button4Mask, Button5Mask.
Returns
True if the pointer is on the same screen as the window argument, else False.
Description
XQueryPointer() gets the pointer coordinates relative to a window and relative to the root window, the root_return window ID and the
child_return window ID (if any) the pointer is currently in, and the current state of modifier keys and buttons.
If XQueryPointer() returns False, then the pointer is not on the same screen as window, child_return is None, and win_x_return and
win_y_return are zero. However, root_return, root_x_return, and root_y_return are still valid. If XQueryPointer() returns True, then the
pointer is on the same screen as window, and all return values are valid.
The logical state of the pointer buttons and modifier keys can lag behind their physical state if device event processing is frozen due to
a grab.
Errors
BadWindow
See Also
XChangeActivePointerGrab(), XChangePointerControl(), XGetPointerControl(), XGetPointerMapping(), XGrabPointer(), XSetPointerMapping(), XUn-
grabPointer(), XWarpPointer().
Xlib - Pointer XQueryPointer()