WaylandCompositor QML 类型

管理 Wayland 显示服务器。更多...

导入语句	import QtWayland.Compositor
实例化	QWaylandCompositor

所有成员列表，包括继承成员

属性

additionalShmFormats : list<enum> (since 6.0)
created : bool
defaultOutput : WaylandOutput
defaultSeat : WaylandSeat
extensions : list
retainedSelection : bool
socketName : string
useHardwareIntegrationExtension : bool

信号

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

方法

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

详细描述

WaylandCompositor 管理与客户端的连接，以及不同的 outputs 和 seats。

通常，组合器应用程序将有一个单一的 WaylandCompositor 实例，该实例可以有几个输出作为子元素。当客户端请求组合器创建一个表面时，请求由 onSurfaceRequested 处理器处理。

组合器支持的可扩展性应该被实例化并添加到扩展属性中。

属性文档

additionalShmFormats : list<enum> [since 6.0]

此属性包含由组合器作为支持声明的额外 wl_shm 格式列表。

默认情况下，只有必需的 ShmFormat_ARGB8888 和 ShmFormat_XRGB8888 被列出，该列表为空。额外的格式可能需要内部转换，从而可能影响性能。

该属性必须在合成器组件完成之前设置。后续的更改将不会生效。

该属性是在Qt 6.0中引入的。

created : bool [只读]

如果WaylandCompositor 已初始化，则该属性为true，否则为false。

defaultOutput : WaylandOutput

该属性包含添加到WaylandCompositor 中的列表中的第一个输出，如果没有添加输出，则为null。

设置新的默认输出将其添加到输出列表，使其成为新的默认值，但之前的默认值不会被从列表中删除。

defaultSeat : WaylandSeat [只读]

该属性包含此WaylandCompositor 的默认会话。

extensions : list

列出合成器向其客户端广告的扩展。对于合成器应该支持的任何Wayland扩展，实例化其组件，并将其添加到扩展列表中。

例如，以下代码将允许客户端使用 wl_shell 接口在合成器中请求 wl_shell 接口。

import QtWayland.Compositor

WaylandCompositor {
    WlShell {
        // ...
    }
}

retainedSelection : bool

该属性指示是否启用了保留选择。

socketName : string

该属性包含 WaylandCompositor 用于与客户端通信的套接字名称。它必须在组件完成之前设置。

如果 socketName 为空（默认值），则使用启动参数 --wayland-socket-name 的内容。如果未设置参数，则合成器尝试查找套接字名称，默认为 wayland-0。

useHardwareIntegrationExtension : bool

该属性指示是否应为此 WaylandCompositor 启用硬件集成扩展。

该属性必须在合成器组件完成之前设置。

信号文档

void surfaceCreated(WaylandSurface surface)

当创建新的 WaylandSurface 实例 surface 时，会发出此信号。

注意：相应的处理程序是 onSurfaceCreated。

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

当 client 创建了一个 id 为 id 的表面时，会发出此信号。接口 version 同样可用。

连接到此信号的槽可以在槽的作用域中创建和初始化一个 WaylandSurface 实例。否则，将创建一个默认表面。

注意：相应的处理程序是 onSurfaceRequested。

方法文档

addSocketDescriptor(fd)

监听文件描述符 fd 上的客户端连接，该文件描述符引用了一个已绑定并正在监听的套接字。

不拥有文件描述符；如果需要，必须显式关闭。

注意：此方法仅在libwayland 1.10.0或更高版本中可用。如果针对较早的libwayland运行时构建，则此方法为空操作。

destroyClient(client)

销毁给定的 WaylandClient 客户端。

destroyClientForSurface(surface)

销毁 WaylandSurface 表面所对应的客户端。