Тип QML WaylandCompositor

Управляет сервером отображения Wayland. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• additionalShmFormats : список<перечисление>
• created : bool
• defaultOutput : WaylandOutput
• defaultSeat : WaylandSeat
• extensions : список
• retainedSelection : bool
• socketName : строка
• useHardwareIntegrationExtension : bool

Сигналы

• void surfaceCreated(WaylandSurface surface)
• void surfaceRequested(WaylandClient client, int id, int version)

Методы

• addSocketDescriptor(fd)
• destroyClient(client)
• destroyClientForSurface(surface)

Подробное описание

WaylandCompositor управляет подключениями к клиентам, а также различными выходами и местами.

Обычно приложение-композитор имеет один экземпляр WaylandCompositor, который может иметь несколько выходов в качестве дочерних элементов. Когда клиент запрашивает у композитора создание поверхности, запрос обрабатывается обработчиком onSurfaceRequested.

Расширения, поддерживаемые композитором, должны быть созданы и добавлены в свойство extensions.

Документация по свойствам

[с момента 6.0] additionalShmFormats : список<перечисление>

Это свойство содержит список дополнительных форматов wl_shm, объявленных как поддерживаемые композитором.

По умолчанию перечислены только необходимые ShmFormat_ARGB8888 и ShmFormat_XRGB8888, а этот список будет пустым. Дополнительные форматы могут потребовать внутренней конвертации и, следовательно, повлиять на производительность.

Это свойство должно быть установлено до завершения компонента композитора. Последующие изменения не повлияют.

Это свойство было добавлено в Qt 6.0.

created : bool

Это свойство имеет значение true, если WaylandCompositor был инициализирован, в противном случае оно false.

defaultOutput : WaylandOutput

Это свойство содержит первый в списке выходов, добавленных в WaylandCompositor, или null, если выходы не были добавлены.

Установка нового значения для свойства defaultOutput добавляет его в начало списка выходов, делая его новым значением по умолчанию, но предыдущее значение по умолчанию не удаляется из списка.

defaultSeat : WaylandSeat

Это свойство содержит значение по умолчанию для места WaylandCompositor.

extensions : список

Список расширений, которые композитор рекламирует своим клиентам. Для любого расширения Wayland, которое должен поддерживать композитор, необходимо создать его компонент и добавить его в список расширений.

Например, следующий код позволит клиентам запросить wl_shell поверхности в композиторе, используя интерфейс wl_shell.

import QtWayland.Compositor

WaylandCompositor {
    WlShell {
        // ...
    }
}

retainedSelection : bool

Это свойство содержит значение true, если сохранение выделения включено.

socketName : строка

Это свойство содержит имя сокета, используемое WaylandCompositor для связи с клиентами. Его необходимо установить до завершения компонента.

Если socketName пустое (по умолчанию), вместо него используется содержимое аргумента start --wayland-socket-name. Если аргумент не задан, композитор пытается найти имя сокета, которое по умолчанию равно wayland-0.

useHardwareIntegrationExtension : bool

Это свойство содержит значение true, если для данного WaylandCompositor должно быть включено расширение аппаратной интеграции.

Это свойство должно быть установлено до завершения компонента композитора.

Документация по сигналам

void surfaceCreated(WaylandSurface surface)

Этот сигнал генерируется при создании нового экземпляра WaylandSurface surface.

Примечание: Соответствующий обработчик — onSurfaceCreated.

void surfaceRequested(WaylandClient client, int id, int version)

Этот сигнал генерируется при создании клиентом поверхности с идентификатором id. Также доступна версия интерфейса version.

Обработчик сигнала может создать и инициализировать экземпляр WaylandSurface в пределах обработчика. В противном случае создаётся поверхность по умолчанию.

Примечание: Соответствующий обработчик — onSurfaceRequested.

Документация по методам

[since 5.12] addSocketDescriptor(fd)

Прослушивает подключения клиентов по дескриптору файла fd, который относится к сокету сервера, уже привязанному и ожидающему подключений.

Не берет на себя ответственность за дескриптор файла; его необходимо явно закрыть, если это нужно.

Примечание: Этот метод доступен только с libwayland 1.10.0 или новее. Если сборка выполняется с более ранней версией libwayland, этот метод является пустым.

Этот метод был добавлен в Qt 5.12.

destroyClient(client)

Уничтожает указанный WaylandClient client.

destroyClientForSurface(surface)

Уничтожает клиента для WaylandSurface surface.