screen-internal-geometry

screen-internal-geometry Function

Summary

Returns the geometry of the unobscured region of a screen or document container.

Package

capi

Signature

screen-internal-geometry screen => x, y, width, height

Arguments

screen⇩

A screen.

Values

`x`⇩	An integer.
`y`⇩	An integer.
`width`⇩	A positive integer.
`height`⇩	A positive integer.

Description

The function screen-internal-geometry returns the geometry (as multiple values representing a screen rectangle) of the region of screen that can be used to display windows without obstruction. This region excludes "system areas" like menubar and taskbar and so on. Examples of these include the Windows taskbar, the macOS menu bar and the macOS Dock.

x and y are the screen rectangle's coordinates as offsets from the top-left of the primary monitor, and width and height are its dimensions.

On Microsoft Windows screen-internal-geometry works with document-container, returning the current size of the container (which may vary over time).

Notes

The internal geometry is a snapshot of the unobscured region of a screen. If a system area moves or changes size, then the screen rectangle returned by screen-internal-geometry changes.
It may be possible to display a CAPI window outside the screen's internal geometry, for example under the macOS Dock, but it will be obscured.
The primary monitor is that represented by the first screen rectangle in the list returned by screen-internal-geometries.