get_mpositionget_mpositionGetMpositionGetMposition (Operator)

Name

get_mpositionget_mpositionGetMpositionGetMposition — Query the mouse position.

Signature

Description

get_mpositionget_mpositionGetMpositionGetMpositionGetMposition 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 pressed, get_mpositionget_mpositionGetMpositionGetMpositionGetMposition returns 0 in ButtonButtonButtonButtonbutton, even if a modifier key is pressed. The following values are assigned to the individual buttons and keys:

0:

No button,

1:

Left button,

2:

Middle button,

4:

Right button,

8:

Shift key,

16:

Ctrl key,

32:

Alt key.

The sum of the values for all pressed buttons/keys is returned in ButtonButtonButtonButtonbutton.

The origin of the coordinate system is located in the left upper corner of the window. For graphics windows the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are expressed with consideration of the current image part (see set_partset_partSetPartSetPartSetPart).

If subpixel accurate image coordinates are required, you can use the operator get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix.

Attention

get_mpositionget_mpositionGetMpositionGetMpositionGetMposition fails (returns FAIL) if the mouse pointer is not located within the window. In this case, no values are returned.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

get_mpositionget_mpositionGetMpositionGetMpositionGetMposition returns the value 2 (H_MSG_TRUE). If the mouse pointer is not located within the window, 5 (H_MSG_FAIL) is returned.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Alternatives

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPix

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Module

Foundation