get_mposition — Query the mouse position.
get_mposition returns the pixel accurate image coordinates of the
mouse pointer in the output window and the mouse button pressed.
These values are returned regardless of the state of the mouse
buttons (pressed or not pressed). If at least one mouse button is pressed,
the state of the modfier keys is returned as well. If no mouse button is
get_mposition returns 0 in
Button, even if
a modifier key is pressed.
The following values are assigned to the individual buttons and keys:
The sum of the values for all pressed buttons/keys is returned in
The origin of the coordinate system is located in the left upper
corner of the window. For graphics windows the coordinates
Column are expressed with consideration of the current
image part (see
If subpixel accurate image coordinates are required, you can use the
get_mposition fails (returns FAIL) if the mouse pointer
is not located within the window. In this case, no values
Row coordinate of the mouse cursor in the image coordinate system.
Column coordinate of the mouse cursor in the image coordinate system.
Mouse button(s) pressed or 0.
get_mposition returns the value 2 (H_MSG_TRUE).
If the mouse pointer is not located within the
window, 5 (H_MSG_FAIL) is returned.