This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
function:SCREEN [2023/02/17 01:56] peternlewis |
function:SCREEN [2023/09/20 03:47] (current) peternlewis |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== SCREEN, SCREENVISIBLE and SCREENINDEX Functions ====== | + | ====== SCREEN Functions ====== |
- | The //SCREEN// and //SCREENVISIBLE// functions return the position or size of a screen. //SCREENVISIBLE()// refers to the visible section of the screen, excluding the menu bar and the dock. | + | The SCREEN() and SCREENVISIBLE() functions return the position or size of a screen. SCREENVISIBLE() refers to the visible section of the screen, excluding the menu bar and the dock. |
- | The //SCREENINDEX// function returns (v10.0+) the actual index of the specified screen, counting from left to right. | + | The SCREENINDEX() function (v10.0+) returns the actual index of the specified screen, counting from left to right. |
``` | ``` | ||
Line 10: | Line 10: | ||
``` | ``` | ||
- | The SCREEN *index* can be referenced by either a _number_ OR a _name_. The _Index number_ can be 0 for the main screen, and then 1 through n are the screens in orientation order from left to right (and top down for screens at the same position). _Index Names_ are shown below. | + | The SCREEN //index// can be referenced by either a //number// or a //name//. The //Index Number// can be 0 for the main screen, and then 1 through SCREENCOUNT() are the screens in orientation order from left to right (and top down for screens at the same position). //Index Names// are shown below. |
- | The _Main_ screen is set by your macOS System Preferences. | + | The //Main// screen is set by your macOS System Preferences. |
- | The other screens (monitors) are referenced positionally from the left most screen, which may, or _may not_, be the _Main_ screen. | + | The other screens (monitors) are referenced positionally from the left most screen, which may or may not, be the //Main// screen. |
^ Index Name ^ Description ^ | ^ Index Name ^ Description ^ | ||
Line 30: | Line 30: | ||
| Variable Name | the index value based on the value of the variable (v9.0+). | | | Variable Name | the index value based on the value of the variable (v9.0+). | | ||
- | :!: Note: Since the _Main_ screen can be in any position: | + | :!: Note: Since the //Main// screen can be in any position: |
- | * SCREEN(0) is always the _Main_ screen. | + | * SCREEN(0) is always the //Main// screen. |
- | * SCREEN(1) may or may not be the _Main_ screen. | + | * SCREEN(1) may or may not be the //Main// screen. |
- | * SCREEN(2+) may or may not be the _Main_ screen. | + | * SCREEN(2+) may or may not be the //Main// screen. |
- | The SCREEN *coordinate* can be: | + | The SCREEN //coordinate// can be: |
* Left | * Left | ||
Line 47: | Line 47: | ||
* Index (v9.0+) | * Index (v9.0+) | ||
- | The optional SCREEN *percentage* parameter specifies a percentage of the width or height to offset by. Offsets are always to the right and down, but negative offsets are allowed. | + | The optional SCREEN //percentage// parameter specifies a percentage of the width or height to offset by. Offsets are always to the right and down, but negative offsets are allowed. |
- | For example SCREEN(Internal,Left,10%) would be the coordinate of left edge of the internal screen plus 10% of the width of the internal screen. SCREEN(Front,Right,-10%) would be the coordinate of the right edge of the external screen minus 10% of the width of the external screen. | + | For example SCREEN(Internal,Left,10%) would be the coordinate of left edge of the internal screen plus 10% of the width of the internal screen. SCREEN(Front,Right,-10%) would be the coordinate of the right edge of the front screen minus 10% of the width of the front screen. |
SCREEN sizes and positions are in //nominal resolution pixels// (so a retina screen will typically have half as many nominal resolution pixels as raw pixels). | SCREEN sizes and positions are in //nominal resolution pixels// (so a retina screen will typically have half as many nominal resolution pixels as raw pixels). | ||
Line 65: | Line 65: | ||
==== Functions ==== | ==== Functions ==== | ||
- | * [[function:MENUBARHEIGHT|MENUBARHEIGHT()]] function | + | * [[MENUBARHEIGHT]] |
- | * [[function:MOUSEBUTTON|MOUSEBUTTON()]] function | + | * [[MOUSEBUTTON]] |
- | * [[function:MOUSEX|MOUSEX()]] function | + | * [[MOUSEX]] |
- | * [[function:MOUSEY|MOUSEY()]] function | + | * [[MOUSEY]] |
- | * [[function:SCREENCOUNT|SCREENCOUNT()]] function | + | * [[SCREENCOUNT]] |
- | * [[function:WINDOW|WINDOW()]] function | + | * [[WINDOW]] |
- | * [[function:WINDOWCOUNT|WINDOWCOUNT()]] function | + | * [[WINDOWCOUNT]] |
* [[:Functions|See all Functions]] | * [[:Functions|See all Functions]] | ||