current-pointer-position

current-pointer-position Function

Summary

Returns the current position of the pointer.

Package

capi

Signature

current-pointer-position &key relative-to pane-relative-p => x, y

Arguments

`relative-to`⇩	A screen or a displayed interface or a CAPI pane.
`pane-relative-p`⇩	A boolean.

Values

`x`	An integer.
`y`	An integer.

Description

The function current-pointer-position returns the current x,y position of the pointer on the screen of relative-to, which defaults to the current screen.

If pane-relative-p is true then the position is returned relative to relative-to, otherwise it is returned relative to the screen. The default value of pane-relative-p is t.