hs.screen

Если установлено в true, методы hs.screen:toEast(), :toNorth() и т. д. проигнорируют экраны, расположенные перпендикулярно желаемой оси

Получает текущее состояние настроек доступности, связанных с экраном

• Нет

• Таблица, содержащая следующие ключи и соответствующие булевы значения, указывающие, включил ли пользователь эти параметры:
  • ReduceMotion (доступно только в macOS 10.12 и более поздних версиях)
  • ReduceTransparency
  • IncreaseContrast
  • InvertColors (доступно только в macOS 10.12 и более поздних версиях)
  • DifferentiateWithoutColor

Находит экраны

• hint - критерий поиска желаемого экрана(ов); он может быть:
  • число по hs.screen:id()
  • строка, содержащая UUID желаемого экрана
  • строковый шаблон, который соответствует (через string.match) имени экрана по hs.screen:name() (для удобства сопоставление будет выполняться с использованием строчных букв)
  • объект hs.geometry point или аргумент конструктора с координатами x и y экрана в текущей компоновке по hs.screen:position()
  • объект hs.geometry size или аргумент конструктора с разрешением экрана по hs.screen:fullFrame()
  • объект hs.geometry rect или аргумент конструктора с произвольной областью в абсолютных координатах; будет возвращён экран, содержащий наибольшую часть области

• один или несколько объектов hs.screen, соответствующих предоставленному критерию поиска, или nil если не найдено ни одного

• для удобства вызывается как hs.screen(hint)

Пример:

hs.screen(724562417) --> Color LCD - by id
hs.screen'Dell'      --> DELL U2414M - by name
hs.screen'Built%-in' --> Built-in Retina Display, note the % to escape the hyphen repetition character
hs.screen'0,0'       --> PHL BDM4065 - by position, same as hs.screen.primaryScreen()
hs.screen{x=-1,y=0}  --> DELL U2414M - by position, screen to the immediate left of the primary screen
hs.screen'3840x2160' --> PHL BDM4065 - by screen resolution
hs.screen'-500,240 700x1300' --> DELL U2414M, by arbitrary rect

Восстанавливает параметры gamma по умолчанию

• Нет

• Нет

• Это возвращает все дисплеи к таблицам gamma, указанным профилями цветового синхронизации, выбранными пользователем

Возвращает список всех подключенных и активных экранов вместе с их "позицией" относительно главного экрана

• Нет

• таблица, где каждый ключ — объект hs.screen, а соответствующее значение — таблица {x=X,y=Y}, где X и Y пытаются указать позицию каждого экрана относительно главного экрана (который находится в {x=0,y=0}); например, значение {x=-1,y=0} указывает экран, расположенный непосредственно слева от главного экрана, а значение {x=0,y=2} указывает экран, расположенный ниже главного экрана, с другим экраном между ними.

• расположения экранов в виде сетки одинакового размера должны вести себя последовательно; но нет гарантии последовательного результата для более «экзотических» расположений экранов

Возвращает все экраны

• Нет

• Таблица, содержащая один или несколько объектов hs.screen

Возвращает «главный» экран, т. е. тот, на котором находится в данный момент фокусированное окно

• Нет

• Объект hs.screen

Возвращает главный экран

• Нет

• Объект hs.screen

Преобразует пространство абсолютных координат, используемых OSX/Hammerspoon, в локальное пространство координат экрана, где 0,0 находится в верхнем левом углу экрана

• geom - объект hs.geometry point или rect или аргументы для его создания

• объект hs.geometry point или rect, преобразованный в локальное пространство координат экрана

Возвращает таблицу, содержащую режимы отображения, поддерживаемые экраном. Режим отображения — это комбинация разрешения, коэффициента масштабирования и глубины цвета.

• Ничего

• Таблица, содержащая поддерживаемые режимы экрана. Ключи таблицы имеют вид "1440x900@2x" (для режима HiDPI) или "1680x1050@1x" (для режима с родным DPI). Значения — это таблицы, содержащие следующие ключи:
• w — число, содержащее ширину режима экрана в точках
• h — число, содержащее высоту режима экрана в точках
• scale — число, содержащее коэффициент масштабирования режима экрана (обычно 1 для родного режима, 2 для режима HiDPI)
• freq — число, содержащее вертикальную частоту обновления в Гц
• depth — число, содержащее глубину бита режима отображения

• До версии 0.9.83 возвращались только режимы с 32-битным цветом, но теперь возвращаются все глубины цвета. Это потребовало изменения названий режимов в возвращаемой таблице.
• "Точки" не обязательно совпадают с пикселями, поскольку они учитывают коэффициент масштабирования (например, "1440x900@2x" — это разрешение экрана 2880x1800 с коэффициентом масштабирования 2, т. е. с включённым HiDPI-рендерингом с удвоенным количеством пикселей), однако они намного полезнее для работы, чем родные пиксельные режимы, когда речь идёт о экране Retina. Для экранов, не являющихся Retina, точки и пиксели эквивалентны.

Возвращает таблицу, описывающую текущий режим экрана.

• Ничего

• Таблица, содержащая текущий режим экрана. Ключи таблицы:
• w — число, содержащее ширину режима экрана в точках
• h — число, содержащее высоту режима экрана в точках
• scale — число, содержащее коэффициент масштабирования режима экрана (обычно 1 для родного режима, 2 для режима HiDPI)
• freq — число, содержащее вертикальную частоту обновления в Гц
• depth — число, содержащее глубину бита
• desc — строка, содержащая представление режима, используемого в hs.screen:availableModes() — например, "1920x1080@2x 60Hz 4bpp"

Получение/установка изображения фона рабочего стола для экрана

• imageURL — необязательная ссылка file:// на файл изображения, который нужно установить в качестве фона. Если опущено, возвращается текущая ссылка на файл

• объект hs.screen, если была установлена новая ссылка, иначе строка, содержащая текущую ссылку

• Если пользователь установил папку с изображениями для чередования фона рабочего стола, будет возвращён путь к этой папке.

Возвращает рамку экрана без панели задач и меню.

• Ничего

• прямоугольник hs.geometry, описывающий "используемую" рамку этого экрана (т. е. без панели задач и панели меню) в абсолютных координатах

Возвращает абсолютный прямоугольник заданного прямоугольника в единицах на этом экране.

• unitrect — прямоугольник hs.geometry в единицах или аргументы для его построения

• прямоугольник hs.geometry, описывающий заданный прямоугольник в абсолютных координатах

• Этот метод — это просто удобная обертка для hs.geometry.fromUnitRect(unitrect,this_screen:frame())

Возвращает рамку экрана, включая панель задач и меню.

• Ничего

• прямоугольник hs.geometry, описывающий рамку этого экрана в абсолютных координатах

Получение яркости экрана

• Ничего

• Число с плавающей запятой от 0 до 1, содержащее текущий уровень яркости, или nil, если дисплей не поддерживает запросы яркости

Получение параметра ForceToGray экрана

• Ничего

• Булево значение, true, если режим ForceToGray установлен, иначе false

Получение текущих белых и черных точек экрана

• Ничего

• Таблица, содержащая белые и черные точки экрана, или nil, если произошла ошибка. Ключи whitepoint и blackpoint имеют значения таблицы, содержащей следующие ключи со значениями от 0,0 до 1,0:
• red
• green
• blue

Получение таблицы с информацией об объекте hs.screen

• Ничего

• Таблица, содержащая различную информацию, или nil, если произошла ошибка.

Получение параметра InvertedPolarity экрана

• Ничего

• Булево значение, true, если режим InvertedPolarity установлен, иначе false

Получение UUID объекта hs.screen

• Ничего

• Строка, содержащая UUID, или nil, если произошла ошибка.

Возвращает уникальный идентификатор экрана

• Ничего

• Число, содержащее идентификатор экрана

Преобразует координаты из локального пространства экрана, где 0,0 находится в левом верхнем углу экрана, в абсолютное координатное пространство, используемое OSX/Hammerspoon

• geom - точка или прямоугольник hs.geometry, или аргументы для их построения

• точка или прямоугольник hs.geometry, преобразованный в абсолютное координатное пространство

Делает этот экран зеркальным отображением другого

• aScreen - объект hs.screen, который вы хотите отобразить в зеркальном режиме
• permanent - необязательный булевый параметр, true, если это должно быть настроено постоянно, false, если это должно применяться только для текущей сессии входа в систему. По умолчанию false.

• true, если операция выполнена успешно, иначе false

Останавливает зеркалирование этого экрана другим

• permanent - необязательный булевый параметр, true, если это должно быть настроено постоянно, false, если это должно применяться только для текущей сессии входа в систему. По умолчанию false.

• true, если операция выполнена успешно, иначе false

Возвращает предпочтительное имя экрана, заданное производителем

• Нет

• Строка, содержащая имя экрана, или nil, если произошла ошибка

Получает экран 'после' текущего (в произвольном порядке); этот метод циклически возвращается к первому экрану.

• Нет

• Объект hs.screen

Возвращает положение заданного экрана относительно основного экрана - см. 'hs.screen.screenPositions()'

• Нет

• два целых числа, указывающие позицию экрана в текущей компоновке экранов, соответственно по осям x и y.

Получает экран 'перед' текущим (в произвольном порядке); этот метод циклически возвращается к последнему экрану.

• Нет

• Объект hs.screen

Получает/устанавливает поворот экрана

• degrees - необязательное число, указывающее на поворот по часовой стрелке на несколько градусов. Если число не указано, возвращается текущий угол поворота. Это число должно быть одним из:
  • 0
  • 90
  • 180
  • 270

• Если поворот устанавливается, булево значение, true, если операция выполнена успешно, иначе false. Если поворот запрашивается, возвращается число

Устанавливает яркость экрана

• brightness - число с плавающей точкой от 0 до 1

• Объект hs.screen

Устанавливает режим ForceToGray для экрана

• ForceToGray - булевое значение, если режим ForceToGray должен быть включен

• Нет

Устанавливает текущую точку белого и черного цвета экрана

• whitepoint - таблица, содержащая значения компонентов цвета от 0,0 до 1,0 для каждого из ключей:
  • red
  • green
  • blue
• blackpoint - таблица, содержащая значения компонентов цвета от 0,0 до 1,0 для каждого из ключей:
  • red
  • green
  • blue

• булево значение, true, если настройки гаммы были применены, false, если произошла ошибка

• Если указанные значения whitepoint и blackpoint очень похожи, прочитать экран будет невозможно. Будьте осторожны и, возможно, захотите прикрепить горячую клавишу к hs.screen.restoreGamma(), когда экспериментируете

Устанавливает режим InvertedPolarity для экрана

• InvertedPolarity - булевое значение, если режим InvertedPolarity должен быть включен

• Нет

Устанавливает режим экрана

• width - число, содержащее ширину нового режима в пунктах
• height - число, содержащее высоту нового режима в пунктах
• scale - число, содержащее коэффициент масштабирования нового режима (обычно 1 для родных разрешений пикселей, 2 для HiDPI/Retina разрешений)
• frequency - число, содержащее вертикальную частоту обновления в герцах нового режима
• depth - число, содержащее разрядность нового режима

• булево значение, true, если запрашиваемый режим был установлен, иначе false

• Доступные ширины/высоты/масштабы можно увидеть в выводе hs.screen:availableModes(), однако следует отметить, что подсистема CoreGraphics, кажется, перечисляет больше режимов для данного экрана, чем она на самом деле готова установить, поэтому вы можете обнаружить, что, казалось бы, допустимые режимы по-прежнему возвращают false. В настоящее время неизвестно, почему так происходит!

Устанавливает начало координат экрана в глобальной системе координат отображения. Начало координат основного или первичного экрана — (0,0). Новое начало устанавливается как можно ближе к запрошенному местоположению, без наложения или оставления зазора между экранами. Если вы используете эту функцию для изменения начала координат зеркального экрана, экран может быть удалён из набора зеркальных отображений.

• x - Желаемая координата x для верхнего левого угла экрана.
• y - Желаемая координата y для верхнего левого угла экрана.

• true, если операция выполнена успешно, иначе false

Устанавливает экран в качестве основного (т. е. содержащего строку меню и док).

• Нет

• Булево значение, true, если операция выполнена успешно, иначе false

Сохраняет изображение экрана в файл JPG

• filePath - Строка, содержащая путь к файлу для сохранения скриншота
• screenRect - Необязательный hs.geometry прямоугольник (или аргументы для его создания) содержащий часть экрана для захвата. По умолчанию — весь экран

• Нет

Сохраняет изображение экрана в файл PNG

• filePath - Строка, содержащая путь к файлу для сохранения скриншота
• screenRect - Необязательный hs.geometry прямоугольник (или аргументы для его создания) содержащий часть экрана для захвата. По умолчанию — весь экран

• Нет

Захватывает изображение экрана

• rect - Необязательный rect-table прямоугольник, содержащий часть экрана для захвата. По умолчанию — весь экран

• Объект hs.image, или nil, если произошла ошибка

Возвращает первый экран, расположенный к востоку от текущего, упорядоченный по близости к его центру или заданной точке.

• from - Объект hs.geometry.rect или hs.geometry.point; если опущено, используется геометрический центр текущего экрана
• strict - Если true, игнорировать экраны, полностью расположенные выше или ниже текущего (в качестве альтернативы, установите hs.screen.strictScreenInDirection)

• Объект hs.screen, или nil, если не найден

Возвращает первый экран, расположенный к северу от текущего, упорядоченный по близости к его центру или заданной точке.

• from - Объект hs.geometry.rect или hs.geometry.point; если опущено, используется геометрический центр текущего экрана
• strict - Если true, игнорировать экраны, полностью расположенные слева или справа от текущего (в качестве альтернативы, установите hs.screen.strictScreenInDirection)

• Объект hs.screen, или nil, если не найден

Возвращает первый экран, расположенный к югу от текущего, упорядоченный по близости к его центру или заданной точке.

• from - Объект hs.geometry.rect или hs.geometry.point; если опущено, используется геометрический центр текущего экрана
• strict - Если true, игнорировать экраны, полностью расположенные слева или справа от текущего (в качестве альтернативы, установите hs.screen.strictScreenInDirection)

• Объект hs.screen, или nil, если не найден

Возвращает единичный прямоугольник заданного прямоугольника, относительно текущего экрана

• rect - прямоугольник hs.geometry или аргументы для его создания

• единичный прямоугольник hs.geometry, описывающий заданный прямоугольник относительно рамки текущего экрана

• Этот метод — просто удобная обертка для hs.geometry.toUnitRect(rect,this_screen:frame())

Возвращает первый экран, расположенный к западу от текущего, упорядоченный по близости к его центру или заданной точке.

• from - Объект hs.geometry.rect или hs.geometry.point; если опущено, используется геометрический центр текущего экрана
• strict - Если true, игнорировать экраны, полностью расположенные выше или ниже текущего (в качестве альтернативы, установите hs.screen.strictScreenInDirection)

• Объект hs.screen, или nil, если не найден