API Mouse.GetPosition2D: Difference between revisions
XML import of API documentation |
XML import |
||
| Line 1: | Line 1: | ||
<sidebar>API Contents</sidebar> | <sidebar>API Contents</sidebar> | ||
Gets the X/Y position of the mouse in screen coords | Gets the X/Y position of the mouse in screen coords | ||
Revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the X/Y position of the mouse in screen coords
Parameters
LONG X
- Pixel screen coordinate from the left of the panel area
- This parameter is returned back to the caller
LONG Y
- Pixel screen coordinate from the top of the panel area
- This parameter is returned back to the caller
Return value
Returns the X/Y position of the mouse in screen coords
Detailed description
This gets the X/Y position in screen units relative to the top left corner of the panel the mouse is over. If the mouse is not over a panel the last known position is used.
Note that the coordinates returned from this call are not 3D coordinates.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Mouse.GetPosition2D(return_x, return_y)
No additional examples