{
  "name": "Screen",
  "component": "gui",
  "header": "nativeui/screen.h",
  "type": "table",
  "singleton": true,
  "namespace": "nu",
  "description": "Receive information about system’s monitor or screen.",
  "methods": [
    {
      "signature": {
        "returnType": {
          "name": "Display",
          "id": "display"
        },
        "name": "getprimarydisplay",
        "parameters": [],
        "shortStr": "getprimarydisplay()",
        "str": "getprimarydisplay()"
      },
      "description": "Return the primary display.",
      "id": "getprimarydisplay"
    },
    {
      "signature": {
        "returnType": {
          "name": "table"
        },
        "name": "getalldisplays",
        "parameters": [],
        "shortStr": "getalldisplays()",
        "str": "getalldisplays()"
      },
      "description": "Return the list of displays that are currently available.",
      "id": "getalldisplays"
    },
    {
      "signature": {
        "returnType": {
          "name": "Display",
          "id": "display"
        },
        "name": "getdisplaynearestwindow",
        "parameters": [
          {
            "type": {
              "name": "Window",
              "id": "window"
            },
            "name": "window"
          }
        ],
        "shortStr": "getdisplaynearestwindow(window)",
        "str": "getdisplaynearestwindow(window)"
      },
      "description": "Return the display nearest the specified `window`.",
      "id": "getdisplaynearestwindow-window"
    },
    {
      "signature": {
        "returnType": {
          "name": "Display",
          "id": "display"
        },
        "name": "getdisplaynearestpoint",
        "parameters": [
          {
            "type": {
              "name": "PointF",
              "id": "pointf"
            },
            "name": "point"
          }
        ],
        "shortStr": "getdisplaynearestpoint(point)",
        "str": "getdisplaynearestpoint(point)"
      },
      "description": "Return the display nearest the specified DIP `point`.",
      "id": "getdisplaynearestpoint-point"
    },
    {
      "signature": {
        "returnType": {
          "name": "PointF",
          "id": "pointf"
        },
        "name": "getcursorscreenpoint",
        "parameters": [],
        "shortStr": "getcursorscreenpoint()",
        "str": "getcursorscreenpoint()"
      },
      "description": "Return the current absolute position of the mouse pointer.",
      "id": "getcursorscreenpoint"
    }
  ],
  "events": [
    {
      "signature": {
        "name": "onadddisplay",
        "parameters": [
          {
            "type": {
              "name": "Display",
              "id": "display"
            },
            "name": "display"
          }
        ],
        "shortStr": "onadddisplay(display)",
        "str": "onadddisplay(display)"
      },
      "description": "Emitted when a new `display` is available.",
      "id": "onadddisplay-display"
    },
    {
      "signature": {
        "name": "onremovedisplay",
        "parameters": [
          {
            "type": {
              "name": "Display",
              "id": "display"
            },
            "name": "display"
          }
        ],
        "shortStr": "onremovedisplay(display)",
        "str": "onremovedisplay(display)"
      },
      "description": "Emitted when the `display` has been removed.",
      "id": "onremovedisplay-display"
    },
    {
      "signature": {
        "name": "onupdatedisplay",
        "parameters": [
          {
            "type": {
              "name": "Display",
              "id": "display"
            },
            "name": "display"
          }
        ],
        "shortStr": "onupdatedisplay(display)",
        "str": "onupdatedisplay(display)"
      },
      "description": "Emitted when there are changes happened to `display`.",
      "id": "onupdatedisplay-display"
    }
  ],
  "module": "yue.gui",
  "detail": "\nThis class can not be created by user, you can only receive its global\ninstance from the `screen` property of the module:\n\n```lua\ngui.screen:getprimarydisplay()\n```\n",
  "id": "screen"
}