All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

screen-monitor-geometries Function

Summary

Returns the geometries of all of a screen's monitors.

Package

capi

Signature

screen-monitor-geometries screen => monitor-geometries

Arguments
screen
A CAPI screen.
Values
monitor-geometries
A list of screen rectangles.
Description

The function screen-monitor-geometries returns the geometries of all the monitors of screen. A monitor corresponds to an entity that the host machine regards as a physical monitor. screen-monitor-geometries ignores software manipulations like the desktop on GTK+.

The monitor geometry is a rectangle which includes all of its display area, including "system areas" like menubar and taskbar and so on. Examples of these include the Windows taskbar, the macOS menu bar and the macOS Dock.

Each monitor geometry screen rectangle is represented by a list of four numbers: the x and y coordinates as offsets from the top-left of the primary monitor, and the width and height.

The first screen rectangle in monitor-geometries corresponds to the primary monitor.

Notes
  1. screen-monitor-geometries differs from screen-internal-geometries by returning screen rectangles which include all the monitor areas, and also by ignoring desktop manipulations.
  2. You cannot display a CAPI window on the macOS menu bar. You can display a CAPI window in the area occupied by the macOS Dock or the Windows task bar, but the window will be obscured.
See also

pane-screen-internal-geometry
screen-internal-geometries
virtual-screen-geometry
3.13 Screens
4.3 Support for multiple monitors
11.6 Querying and modifying interface geometry


CAPI User Guide and Reference Manual (Macintosh version) - 01 Dec 2021 19:31:27