Chromium aura shell

为给定的 wl_surface 实例化接口扩展，以提供 aura shell 功能。如果给定的 wl_surface 未关联 shell surface，则会引发 shell_surface_missing 协议错误。

为给定的 wl_output 实例化接口扩展，以提供 aura shell 功能。

[已弃用] 通知服务器在提交 surface 时，此客户端不会使用 wl_surface_set_buffer_scale 来报告缩放比例，也不会通过 vp_viewporter 应用缩放。相反，服务器应应用适当的缩放变换以使提交的 buffer 正确合成。

为给定的 xdg toplevel 接口检索 aura toplevel 接口

为给定的 xdg popup 接口检索 aura popup 接口

客户端使用此请求可以告诉服务器它将不再使用 zaura_shell 对象。这不会影响任何其他对象。

此处命名为 "release" 是因为 "destroy" 是用于释放 wl_proxy 对象的特殊命名函数。将其命名为 "destroy" 会在低版本主机上运行时导致编组错误。如果我们迁移到 aura-shell v2，此处所有的 "release" 请求应重命名为 "destroy"。

发送服务器使用的 layout_mode。

发送在 exo 服务器上修复的 bug 的 monorail ID，客户端可用于控制功能。

当全局桌面状态发生变化时发出通知。此事件在桌面名称更改、桌面添加/删除或桌面重新排序时发出。"desk_names" 参数包含以 null 结尾的字符串集合作为桌面名称。

当活动桌面发生变化时发出通知。

通知客户端活动 surface 已更改。

通知客户端服务器已进入概览模式。概览模式显示与当前桌面关联的所有应用窗口。

通知客户端服务器已退出概览模式。

发送 Exo compositor 版本信息。

通知客户端已在 exo 服务器上修复的所有 bug ID 已发送完毕。Bug 修复 ID 通过 `bug_fix` 事件逐个发送，而非数组。此事件用于确认所有 ID 已发送完毕。

以 dips 为单位向客户端发送窗口每个圆角的半径。

指定服务器的窗口布局模式。

[已弃用] 建议 surface 使用特定帧。自 M105 起弃用。请参阅 zaura_toplevel 和 zaura_popup 上的 set_decoration 方法。

设置此 surface 的 "父级"。"x" 和 "y" 参数指定 surface 相对于父级的初始位置。

设置帧颜色。必须在初始 commit 之前设置，否则后续请求可能不会被执行。

设置启动 ID。

设置应用程序 ID。

已弃用。请使用 set_client_surface_str_id 代替。 设置由客户端分配的 surface 标识符。

在此 surface 上设置遮挡跟踪。当此 surface 的遮挡量发生变化时，客户端将收到新的遮挡比例更新。

取消此 surface 的遮挡跟踪。

[已弃用] 使此窗口成为活动窗口。这通常意味着将此 surface 重新堆叠到前台。如果 compositor 认为客户端行为不当，可以忽略此请求。通常此请求仅在响应某些用户驱动事件时才会被执行，例如执行应用程序或在已存在的窗口中打开文件。

在不改变用户焦点的情况下吸引对此 surface 的注意。这通常意味着动画化窗口装饰或任务栏图标。如果 compositor 认为合适，仍可忽略此请求，但与 draw_focus 不同的是，这些请求预计来自后台任务，更可能被执行。

[已弃用] 使用 toplevel 接口中的 set_fullscreen_mode。 建议窗口系统在此 surface 进入全屏时的行为方式。不会使 surface 进入全屏。

通常默认模式为 "沉浸式"。

设置由客户端分配的 surface 标识符。

建议 surface 使用客户端装饰，但由服务器决定何时何地开始调整大小。服务器还可以应用视觉效果来指示调整大小操作正在进行中。

[已弃用] 使用 zaura_toplevel 上的 intent_to_snap。 通知（或告知）服务器客户端有吸附窗口的意图。要告知不再愿意吸附，请发送 'none'。

[已弃用] 使用 zaura_toplevel 上的 set_snap_primary。 请求将 surface 吸附到左侧。

[已弃用] 使用 zaura_toplevel 上的 set_snap_secondary。 请求将 surface 吸附到右侧。

[已弃用] 使用 zaura_toplevel 上的 unset_snap。 请求重置 surface 的吸附状态。

为 surface 设置窗口会话 ID。

设置 surface 可以根据其导航列表返回。这允许服务器通过在系统范围的返回手势时最小化窗口来做出反应。

取消设置 surface 可以根据其导航列表返回。参见上文。

请求将 surface 设置为画中画（PIP）模式。

请求取消 surface 的画中画（PIP）模式。

设置 surface 的宽高比。

如果 |index| 等于 -1，请求服务器切换客户端是否在所有工作区可见。 如果 |index| 不是 -1，请求服务器将客户端移动到 |index| 处的桌面。

如果 |initial_workspace| 等于 '-1'，窗口将被恢复并在所有工作区可见；否则，设置初始工作区以将窗口恢复到相应的工作区。这不是双缓冲的，必须在附加 buffer 之前设置。

请求固定窗口，这意味着系统不允许用户离开该窗口，直到满足退出条件。

这是一个请求将窗口固定，使用户无法访问任何其他窗口/应用程序。有两种模式： A. trusted 为 0 - 限制较少，允许用户通过预定义的身份验证方式退出窗口。 B. trusted 不为 0，此时受信任的应用程序正在锁定系统并需要解锁。这用于例如学校考试。

请求允许用户离开先前固定的窗口。

这是一个请求取消固定先前固定的窗口。无论窗口是以受信任状态锁定还是不受信任状态锁定，都无关紧要。

销毁 zaura_surface 对象。当角色从 wl_surface 取消映射时，客户端应销毁此对象。

有关析构函数命名，请参阅 zaura_shell.release。

在服务器端显示工具提示。 `x` 和 `y` 指定工具提示在 surface 局部坐标中的位置。 `hide_delay` 和 `show_delay` 指定显示/隐藏工具提示前的等待时间，单位为毫秒。

隐藏由同一客户端在服务器端创建的工具提示。即使没有工具提示窗口可隐藏，也可以调用此方法。

为 surface 设置无障碍窗口 ID。负数将从 surface 中移除现有的无障碍 ID。

当此 surface 的遮挡量发生变化时发出通知。遮挡更新以 0 到 1 的定点数发送，表示遮挡比例。

通知客户端将窗口锁定在正常或还原状态。当窗口被锁定时，窗口框架应看起来处于还原状态，但实际上并非如此。锁定发生在拖动最大化窗口时。

通知客户端解锁窗口（如果先前已锁定）。解锁发生在拖动最大化窗口时。

通知客户端窗口的遮挡状态已更改。客户端只有在先前通过 set_occlusion_tracking 为特定 surface 请求遮挡跟踪时才会收到这些消息。

当窗口的桌面状态发生变化时发出通知。当窗口被移动到另一个桌面或其分配到所有桌面的状态发生变化时，会发出此事件。

通知客户端开始在 surface 上进行节流。

通知客户端结束在 surface 上的节流。

通知客户端工具提示已显示并带有状态。 `x` 和 `y` 指定工具提示在 surface 局部坐标中的位置。

通知客户端工具提示已隐藏。

可用于装饰 surface 的帧类型。

描述遮挡变化原因的枚举。由用户操作引起的遮挡变化可能包括用户移动窗口、改变遮挡、或打开/关闭窗口改变遮挡等情况。

[已弃用] 此 surface 进入全屏时可能的窗口系统行为。

Surface 吸附方向。

描述 surface 的遮挡状态。

描述触发工具提示的方式。

销毁此 zaura_shell 对象。

当由此 zaura_shell 对象实例创建的 zaura_surface 仍然存在时，销毁已绑定的 zaura_shell 对象是非法的，并将导致协议错误。

有关析构函数命名，请参阅 zaura_shell.release。

scale 事件描述输出的可用缩放比例。

绑定到 output 对象时发送该事件，始终会有一个缩放比例，即当前缩放比例。如果输出更改缩放比例，将再次发送该事件，表示当前的缩放比例。换句话说，当前缩放比例始终是最后收到的带有 current 标志的缩放比例。

connection 事件描述输出的连接方式。

绑定到 output 对象时发送该事件。

此事件描述输出的设备特定缩放因子。

设备特定缩放因子在输出的生命周期内不会改变。它不像 wl_output 接口提供的缩放因子那样仅限于整数值。通过将此设备缩放因子与当前输出缩放相结合，可以确定 compositor 使用的精确内容缩放。

绑定到 output 对象时发送该事件。

此事件以逻辑屏幕坐标描述输出的内边距，据此可以计算工作区域。

此事件在 wl_output.done 之前发送，客户端将在之后应用更改。

此事件描述输出的逻辑变换。wl_output.geometry 的变换对应于显示器面板的旋转，而逻辑变换对应于显示器的逻辑旋转。

此事件在 wl_output.done 之前发送，客户端将在之后应用更改。

此事件描述 ChromeOS 分配给每个显示器的 64 位显示 ID。该值是不透明的，不应进行解释。

通知此输出现在是活动输出。通常在没有特定边界的情况下创建新窗口时用作目标显示器。

这些标志描述输出缩放的属性。用于 scale 事件的标志位域中。

当此 surface 处于全屏状态时请求特定的方向行为。

通知服务器在提交此 surface 时，此客户端不会使用 wl_surface_set_buffer_scale 来报告缩放比例，也不会通过 vp_viewporter 应用缩放。相反，服务器应应用适当的缩放变换以使提交的 buffer 正确合成。

请求此操作将启用与 aura_toplevel 关联的 surface 中的屏幕坐标，包括子 surface 和将此 toplevel 作为父级添加的弹出窗口。应在首次 commit 之前设置。

以 DP 屏幕坐标请求 surface 的新位置和边界。大小将应用于 set_geometry 中使用的可见边界。输出是 compositor 用于确定窗口应移动到哪个输出的提示。如果输出为 null，compositor 应仅根据给定边界做出决定。这些参数只是一个请求，compositor 可能会忽略、根据窗口管理器施加的规则调整大小和位置，或为将来的操作保留它。例如，compositor 不允许位置超出输出范围，或者如果 toplevel surface 处于最大化状态，compositor 可能只存储它，并在取消最大化时使用它。

请求新创建的浏览器窗口的会话 ID 和恢复 ID。设置 compositor 用于在创建时恢复 toplevel surface 状态（如窗口位置、窗口状态）的信息。这不是双缓冲的，必须在发送首次 commit 之前设置。

请求 toplevel surface 成为系统模态。compositor 将阻止其他窗口接收事件。如果有多个系统模态 surface，compositor 将决定哪个接收事件。

请求取消 toplevel surface 的系统模态状态。compositor 将允许其他窗口接收事件。

请求窗口的会话 ID 和恢复 ID。设置 compositor 用于在创建时恢复 toplevel surface 状态（如窗口位置、窗口状态）的信息。这不是双缓冲的，必须在发送首次 commit 之前设置。这与 set_restore_info 不同，用于创建多个与 restore_id_source 关联的窗口的客户端。

允许客户端为 zaura_toplevel 请求特定装饰。服务器不必遵守此请求。有关可用选项，请参阅 decoration_type。必须在首次 commit 之前设置，否则后续请求可能不会被执行。自 M105 起可用。

销毁此 zaura_toplevel 对象。当角色从 wl_surface 取消映射时，客户端应调用销毁。

有关析构函数命名，请参阅 zaura_shell.release。

[已弃用] 使用 set_float_to_location。 这是一个将 surface 置于其他 surface 之上的请求。

请求重置 surface 的浮动状态。

设置 toplevel surface 的 z 序。有关可用选项，请参阅 z_order_level。

以设备无关像素（DP）请求 surface 的新位置，相对于给定输出的左上角。

空输出表示当前包含 surface 的任何输出。

这些参数只是一个请求，compositor 可能会忽略它们，由于窗口管理器施加的规则而调整它们，或为将来的操作保留它们。例如，compositor 不允许位置超出输出范围；或者如果 toplevel surface 处于最大化状态，compositor 可能只存储它，并在取消最大化时使用它。

激活此窗口。这相当于将窗口带到前台。如果 compositor 认为客户端行为不当，可以忽略此请求。

停用此窗口。这相当于请求该窗口不成为前台窗口。确切行为由 compositor 定义。如果 compositor 认为客户端行为不当，可以忽略此请求。

建议窗口管理器在此 surface 进入全屏时的行为方式。不会使 surface 进入全屏。

确切地说，如果 surface 尚未处于全屏状态，切换模式从客户端角度来看不会立即产生影响，但会改变下次请求使 surface 进入全屏时的行为。 如果 surface 已经处于全屏状态，则此请求会立即生效，在普通和沉浸式全屏模式之间切换。

客户端有一个与每个 zaura toplevel 关联的 32 位浮点缩放因子。此缩放因子必须精确传播到 exo。为此，我们 reinterpret_cast 为 32 位 uint，稍后再转换回 float。这是因为 wayland 不支持浮点数的原生传输。由于不同的 CPU 架构可能对 IEEE 754 浮点数使用不同的字节序表示，此协议隐式假设调用方和接收方是同一台机器。为避免冗余消息，此请求仅需在 zaura toplevel 缩放因子更改时调用一次。这是双缓冲状态，将在下一次 commit 中应用。

请求将 surface 吸附到左侧或顶部（如果是主布局），否则吸附到右侧或底部。

请求将 surface 吸附到右侧或底部（如果是主布局），否则吸附到左侧或顶部。

通知（或告知）服务器客户端有吸附窗口的意图。要告知不再愿意吸附，请发送 'none'。

请求取消窗口的吸附状态。

请求窗口的可持久化状态。在窗口属性中设置窗口的可持久化状态。应在首次 commit 之前调用。

以 DP 为单位设置 toplevel 窗口的形状。传入 NULL 将重置窗口的形状。

此方法仅应用于支持现有的（已弃用的）Chrome Apps SetShape API，不应用于任何其他目的。

为 surface 设置顶部内边距。这表示标题栏高度，应为非负值。

如果焦点已成功在 surface 内部的 UI 元素之间旋转，客户端回复 'handled'。如果焦点未旋转，客户端回复 'not_handled'。服务器可使用此信息将焦点移动到下一个可聚焦的 surface。

请注意，客户端处理中的延迟可能导致服务器收到过时的确认。

向窗口管理器提示 toplevel surface 可以最大化。

向窗口管理器提示 toplevel surface 不应被最大化。请注意，窗口管理器仍可能请求客户端最大化。在这种情况下，客户端应尊重窗口管理器的请求并最大化。之后可以取消最大化状态。

向窗口管理器提示 toplevel surface 可以进入全屏。

向窗口管理器提示 toplevel surface 不应进入全屏。请注意，窗口管理器仍可能请求客户端进入全屏。在这种情况下，客户端应尊重窗口管理器的请求并进入全屏。之后可以退出全屏。

这是一个将 surface 置于其他 surface 之上的请求。

客户端以 DP（设备无关像素）为单位指定要应用于窗口的每个圆角的半径。

窗口圆角半径是双缓冲的，将在调用相应 wl_surface 的 wl_surface.commit 时应用。

注意：圆角半径会影响 wl_surface 树，包括子 surface。一旦调用此协议，surface 将无法设置自己的圆角边界，因为圆角窗口边界将应用于整个 surface 树。

客户端以设备无关像素（DP）为单位指定要应用于与 aura toplevel surface 关联的阴影的每个圆角半径。

阴影圆角半径是双缓冲的，将在调用相应 wl_surface 的 wl_surface.commit 时应用。

配置更改，还包括以屏幕坐标表示的窗口原点。

当窗口原点发生变化时发送的通知。与 configure 不同，这不意味着客户端需要调整大小。值以屏幕坐标表示。

设置此窗口的光栅缩放比例。应在 configure 事件序列期间调用。为此，我们 reinterpret_cast 为 32 位 uint，稍后再转换回 float。这是因为 wayland 不支持浮点数的原生传输。由于不同的 CPU 架构可能对 IEEE 754 浮点数使用不同的字节序表示，此协议隐式假设调用方和接收方是同一台机器。

在 toplevel 窗口内旋转焦点。窗口必须将其可聚焦视图排序为稳定且线性可遍历的顺序。在旋转焦点之前，surface 应已被激活并拥有键盘焦点。如果 surface 未被激活或没有键盘焦点，服务器应首先激活并为窗口输入键盘焦点。事件顺序示例可能是：

1. 激活 surface 2. 输入键盘焦点 3. 旋转焦点

如果窗口未被激活或没有键盘焦点，客户端应回复 "not handled" 且不执行任何操作。

要开始新的旋转序列，服务器将 "restart" 参数设置为 true。如果 "restart" 参数为 true，窗口应将焦点设置在给定方向的第一个 UI 元素上，不执行任何旋转。

客户端应通过 "ack_rotate_focus" 请求中的 "handled" 字段回复旋转是否成功。客户端应在确认消息中传递事件序列号和方向。

窗口正在概览模式中显示。请注意，这与 shell 概览状态不同，因为并非所有窗口都是概览网格的一部分。

设置此窗口的遮挡状态。应在 configure 事件序列期间调用。当遮挡状态需要作为同步操作设置时使用此事件，与非同步的 occlusion_state_changed 不同。例如，可用于将窗口标记为隐藏以便释放资源。当再次使其可见时，可能需要一些时间来重新创建 buffer，这就是为什么此操作需要同步。

定义 surface 处于全屏状态时的方向请求。

此处包含的状态是对 XDG shell 和特定 aura 窗口中定义的状态的补充。

装饰类型用于修改 surface（例如投影阴影）。

用于设置 toplevel surface 的不同 z 序级别。

此 surface 进入全屏时可能的窗口系统行为。

窗口吸附方向。

二进制枚举映射为布尔值，描述值是否可持久化。

surface 被浮动时可能的起始位置。

二进制枚举映射为布尔值，描述值是否在概览中。

通知服务器在提交此 surface 时，此客户端不会使用 wl_surface_set_buffer_scale 来报告缩放比例，也不会通过 vp_viewporter 应用缩放。相反，服务器应应用适当的缩放变换以使提交的 buffer 正确合成。

允许客户端为 zaura_toplevel 请求特定装饰。服务器不必遵守此请求。有关可用选项，请参阅 decoration_type。自 M105 起可用。

将弹出类型设置为菜单。

此请求销毁 zaura_popup。当角色从 wl_surface 取消映射时，客户端应调用销毁。

有关析构函数命名，请参阅 zaura_shell.release。

客户端有一个与每个 zaura popup 关联的 32 位浮点缩放因子。此缩放因子必须精确传播到 exo。为此，我们 reinterpret_cast 为 32 位 uint，稍后再转换回 float。这是因为 wayland 不支持浮点数的原生传输。由于不同的 CPU 架构可能对 IEEE 754 浮点数使用不同的字节序表示，此协议隐式假设调用方和接收方是同一台机器。为避免冗余消息，此请求仅需在 zaura popup 的缩放因子更改时调用一次。

装饰类型用于修改 surface（例如投影阴影）。

此事件在给定 wl_output 的所有 zaura_output_manager 相关属性发送完毕后发送。

此事件描述 ChromeOS 分配给每个显示器的 64 位显示 ID。该值是不透明的，不应进行解释。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

position 事件描述 wl_output 在全局 compositor 空间中的位置。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

logical_size 事件描述输出在全局 compositor 空间中的逻辑大小。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

显示器的物理分辨率（以像素为单位）。该值不应包含任何过扫描内边距或显示旋转（面板方向调整除外）。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

此事件以逻辑屏幕坐标描述输出的内边距，据此可以计算工作区域。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

输出设备的缩放因子。我们将浮点缩放因子 reinterpret_cast 为 32 位 uint，稍后再转换回 float。这是因为 wayland 不支持浮点数的原生传输。由于不同的 CPU 架构可能对 IEEE 754 浮点数使用不同的字节序表示，此协议隐式假设调用方和接收方是同一台机器。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

此事件描述输出的逻辑变换。面板变换对应于显示器面板的旋转，而逻辑变换对应于显示器的逻辑旋转。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

此事件描述输出的面板变换，即关联显示器的面板旋转。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

name 是一个 UTF-8 字符串，其内容没有定义的约定。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

description 是一个 UTF-8 字符串，其内容没有定义的约定。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。

通知此输出现在是活动输出。通常在没有特定边界的情况下创建新窗口时用作目标显示器。

此事件以物理像素描述输出的过扫描内边距。

绑定到 output 对象时发送该事件，随后在输出状态更改时发送。