holotrek/screen_retriever

This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc.

screen_retriever

This plugin allows Flutter desktop apps to Retrieve information about screen size, displays, cursor position, etc.

---

English | 简体中文

---

• screen_retriever
  • Platform Support
  • Quick Start
    • Installation
    • Usage
  • Who's using it?
  • API
    • ScreenRetriever
  • License

Platform Support

Linux	macOS	Windows
✔️	✔️	✔️

Quick Start

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  screen_retriever: ^0.1.9

Or

dependencies:
  screen_retriever:
    git:
      url: https://github.com/leanflutter/screen_retriever.git
      ref: main

Usage

Display? _primaryDisplay;
List<Display> _displayList = [];

void _init() async {
  _primaryDisplay = await screenRetriever.getPrimaryDisplay();
  _displayList = await screenRetriever.getAllDisplays();
  setState(() {});
}

Please see the example app of this plugin for a full example.

Who's using it?

• Biyi (比译) - A convenient translation and dictionary app.

API

ScreenRetriever

Method	Description	Linux	macOS	Windows
getCursorScreenPoint	Returns Offset - The current absolute position of the mouse pointer.	✔️	✔️	✔️
getPrimaryDisplay	Returns Display - The primary display.	✔️	✔️	✔️
getAllDisplays	Returns List<Display> - An array of displays that are currently available.	✔️	✔️	✔️

License

MIT