screen | Plugin API
For the complete documentation index, see llms.txt. This page is also available as Markdown.

screen

Get information about screen size, display, cursor position, etc.

Methods

getCursorScreenPoint()

Absolute position x, y of the current mouse cursor.

  • Returns Promise<point: Object>

    • point Object

      • point.x

      • point.y

let point = await eagle.screen.getCursorScreenPoint();

getPrimaryDisplay()

Returns primary display information.

  • Returns Promise<display: Display>

    • display Display Object - Current display information.

let display = await eagle.screen.getPrimaryDisplay();

getAllDisplays()

Returns an array Display[], representing currently available screens.

  • Returns Promise<displays: Display[]>


getDisplayNearestPoint(point)

Gets the plugin window coordinates x and y.

  • point Object

    • point.x Integer type

    • point.y Integer type

  • Returns Promise<display: Display>

    • display Display Object - Current display information.

Last updated