get_monitor_workarea


Description:

[ Version ( deprecated = true , deprecated_since = "3.22" , since = "3.4" ) ]
public Rectangle get_monitor_workarea (int monitor_num)

Warning: get_monitor_workarea is deprecated since 3.22.

Retrieves the Rectangle representing the size and position of the “work area” on a monitor within the entire screen area.

Note:

Use get_workarea instead

The returned geometry is in ”application pixels”, not in ”device pixels” (see get_monitor_scale_factor).

The work area should be considered when positioning menus and similar popups, to avoid placing them below panels, docks or other desktop components.

Note that not all backends may have a concept of workarea. This function will return the monitor geometry if a workarea is not available, or does not apply.

Monitor numbers start at 0. To obtain the number of monitors of this, use get_n_monitors.

Parameters:

this

a Screen

monitor_num

the monitor number

dest

a Rectangle to be filled with the monitor workarea