LogoWayland Explorer

Tizen extension

tizen_surface

版本 1
Tizen 平台特有的 surface

tizen_surface 为给定的 surface 提供 Tizen 平台特有的功能。

get_tizen_resource
get_tizen_resource(id: new_id<tizen_resource>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_resource>
the new tizen_resource object
surfaceobject<wl_surface>
the surface object
获取一个 tizen_resource 对象

为给定的 surface 创建一个 tizen_resource 接口。

destroy
类型: destructor
destroy()
销毁 tizen_surface

销毁此 tizen_surface 对象。

tizen_resource

版本 1
全局资源 ID

此 tizen_resource 提供一个全局资源 ID。它是由 display server 提供的唯一标识符。

destroy
类型: destructor
destroy()
销毁 tizen_resource

销毁此 tizen_resource 对象。

resource_id
resource_id(id: uint)
参数
类型
描述
iduint
the global resource id
一个全局资源 ID

resource_id 事件在 display server 创建 tizen_resource 对象后立即发送。该 ID 是由 display server 生成的唯一标识符。

tizen_policy

版本 13
Tizen 平台特有的窗口管理策略

tizen_policy 为 Tizen 平台上的窗口管理提供 Tizen 平台特有的请求和事件。

[TODO] 解释 display server 中的窗口层。需要解释窗口层以理解 tizen_policy 接口中的请求和事件。

get_visibility
get_visibility(id: new_id<tizen_visibility>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_visibility>
the new visibility object
surfaceobject<wl_surface>
the surface object
获取一个可见性对象

为给定的 surface 创建一个可见性接口。

get_position
get_position(id: new_id<tizen_position>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_position>
the new position object
surfaceobject<wl_surface>
the surface object
获取一个位置对象

为给定的 surface 创建一个位置接口。 [TODO]: 需要解释与 zxdg_positioner_v6 的关系

activate
activate(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
激活 surface

激活给定的 surface。当客户端希望将窗口提升到窗口层中窗口栈的顶部，并希望从 display server 获取键盘焦点时，会发送此请求。但 display server 并不总是在请求的 surface 上设置焦点，这取决于 display server 的焦点策略。客户端仅通过此请求表达获取键盘焦点的意愿。

activate_below_by_res_id
activate_below_by_res_id(res_id: uint, below_res_id: uint)
参数
类型
描述
res_iduint
the global resource id
below_res_iduint
the global resource id
激活 res_id 并定位在 below_res_id 下方

激活与给定 res_id 关联的 surface，并将其定位在与 below_res_id 关联的 surface 下方。当客户端希望使用属于不同进程的全局资源 ID 来更改窗口栈顺序时，可以使用此请求。但当与 below_res_id 关联的 surface 是与 res_id 关联的 surface 的父级时，此请求不起作用。

raise
raise(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
提升 surface

此请求将给定的 surface 提升到窗口层中窗口栈的顶部。客户端可以通过 tizen_policy 接口的 set_type 请求为给定的 surface 设置 window_type 来决定窗口层。该 surface 将位于窗口层的顶部。

lower
lower(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
降低 surface

此请求将给定的 surface 降低到窗口层中窗口栈的底部。该 surface 将位于窗口层的底部。

lower_by_res_id
lower_by_res_id(res_id: uint)
参数
类型
描述
res_iduint
the global resource id
降低 res_id

此请求将与给定 res_id 关联的 surface 降低到窗口层中窗口栈的底部。该 surface 将位于窗口层的底部。

set_focus_skip
set_focus_skip(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
使 surface 无法获得焦点

此请求使给定的 surface 无法成为焦点 surface。display server 不得将焦点授予该 surface。

unset_focus_skip
unset_focus_skip(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
使 surface 能够获得焦点

此请求使给定的 surface 能够成为焦点 surface。

set_role
set_role(surface: object<wl_surface>, role: string)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
rolestring
the name of the role
设置 surface 的角色

为给定的 surface 设置角色。客户端可以设置 Tizen 平台特有的 surface 角色，但不包括 xdg_surface 接口的角色，如 xdg_toplevel、xdg_popup 等。

set_type
set_type(surface: object<wl_surface>, win_type: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
win_typeuint
the window type
设置 surface 的类型

设置给定 surface 的类型。display server 使用窗口类型来决定窗口管理策略，包括焦点管理、可见性管理、栈管理等。

set_conformant
set_conformant(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
设置 conformant（适配）surface

设置 conformant surface。conformant surface 可以接收事件，通过该事件 display server 通知由 conformant_part（即另一个客户端中的 surface）覆盖的区域。

unset_conformant
unset_conformant(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消设置 conformant（适配）surface

取消设置 conformant surface。

get_conformant
get_conformant(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
检查 conformant surface

查询给定的 surface 是否为 conformant surface。display server 通过 conformant 事件发送结果。

set_notification_level
set_notification_level(surface: object<wl_surface>, level: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
levelint
the z-order value
设置通知中的级别

此请求设置通知层中的级别。display server 根据给定的级别决定通知层中的 z 轴顺序。

set_transient_for
set_transient_for(child_id: uint, parent_id: uint)
参数
类型
描述
child_iduint
the global resource id for the child surface
parent_iduint
the globacl resource is for the parent surface
为 parent_id 设置 transient 父级

此请求为与 parent_id 关联的 surface 设置 transient 父级。与给定 child_id 关联的 surface 成为与 parent_id 关联的 surface 的 transient 子级。

unset_transient_for
unset_transient_for(child_id: uint)
参数
类型
描述
child_iduint
the global resource id for the child surface
取消 transient 父子关系

此请求取消与 child_id 关联的 surface 上的 transient 父级关系。

set_window_screen_mode
set_window_screen_mode(surface: object<wl_surface>, mode: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
modeuint
the screen mode
为 surface 设置屏幕模式

客户端设置屏幕模式，只要给定的 surface 显示在屏幕上，屏幕就会保持该模式。

place_subsurface_below_parent
place_subsurface_below_parent(subsurface: object<wl_subsurface>)
参数
类型
描述
subsurfaceobject<wl_subsurface>
the subsurface object
将子 surface 放置在父 surface 下方

此请求将子 surface 的 surface 放置在其父 surface 的下方。

set_subsurface_stand_alone
set_subsurface_stand_alone(subsurface: object<wl_subsurface>)
参数
类型
描述
subsurfaceobject<wl_subsurface>
the subsurface object
使子 surface 进入独立模式

此请求使与给定子 surface 关联的 surface 不再遵循由父 surface 触发的窗口管理策略。与给定子 surface 关联的 surface 的窗口策略不受其父 surface 的影响。

get_subsurface
get_subsurface(id: new_id<wl_subsurface>, surface: object<wl_surface>, parent_id: uint)
参数
类型
描述
idnew_id<wl_subsurface>
the new subsurface object
surfaceobject<wl_surface>
the surface object
parent_iduint
the global reosurce id
通过 parent_id 获取 surface 的子 surface

通过全局资源 parent_id 获取给定 surface 的子 surface。

set_opaque_state
set_opaque_state(surface: object<wl_surface>, state: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
stateint
为 surface 设置不透明状态

为给定 surface 设置不透明状态。display server 使此 surface 不透明，即使附加到该 surface 的缓冲区颜色深度为 32 位。

iconify
iconify(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
为 surface 设置最小化状态

为给定 surface 设置最小化状态。最小化状态是一种窗口状态，此时 surface 不显示在屏幕上。

uniconify
uniconify(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
为 surface 设置取消最小化状态

为给定 surface 设置取消最小化状态。取消最小化状态是一种窗口状态，此时最小化的 surface 重新显示在屏幕上。

add_aux_hint
add_aux_hint(surface: object<wl_surface>, id: int, name: string, value: string)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
idint
the id of the auxiliary hint
namestring
the name of the auxiliary hint
valuestring
the vaule of the auxiliary hint
为 surface 添加辅助提示信息

为给定的 surface 添加辅助提示信息。当 display server 已经拥有客户端发送此请求时使用的相同 ID 时，名称和值会被更改。

change_aux_hint
change_aux_hint(surface: object<wl_surface>, id: int, value: string)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
idint
the id of the auxiliary hint
valuestring
the vaule of the auxiliary hint
更改 surface 的辅助提示值

更改 surface 拥有的辅助提示 ID 的值。

del_aux_hint
del_aux_hint(surface: object<wl_surface>, id: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
idint
the id of the auxiliary hint
删除辅助提示信息

删除与给定 surface 拥有的提示 ID 关联的辅助提示信息。

get_supported_aux_hints
get_supported_aux_hints(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
获取辅助提示

获取给定 surface 支持的辅助提示 ID。display server 发送 supported_aux_hints 事件作为此请求的回复。

set_background_state
set_background_state(pid: uint)
参数
类型
描述
piduint
the process id
设置后台状态

将与给定 PID 关联的所有 surface 设置为后台状态。这些 surface 被设置为隐藏状态，即使客户端发送显示请求和激活请求，也无法在屏幕上显示。

unset_background_state
unset_background_state(pid: uint)
参数
类型
描述
piduint
the process id
取消后台状态

将与给定 PID 关联的所有 surface 取消后台状态。这些 surface 可以根据客户端的请求进行显示和激活。

set_floating_mode
set_floating_mode(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
设置浮动模式

为给定的 surface 设置浮动模式。设置为浮动模式的 surface 可以作为浮动窗口，并可以定位在其他顶层窗口之上。

unset_floating_mode
unset_floating_mode(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消浮动模式

取消给定 surface 的浮动模式。surface 的几何形状不会改变，其 z 轴顺序与顶层窗口相同。

set_stack_mode
set_stack_mode(surface: object<wl_surface>, mode: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
modeuint
the stack mode
设置栈模式

为给定的 surface 设置栈模式。surface 可以通过栈模式在同一层中更改 z 轴顺序。

activate_above_by_res_id
activate_above_by_res_id(res_id: uint, above_res_id: uint)
参数
类型
描述
res_iduint
the global resource id
above_res_iduint
the globacl resource id
激活并定位在上方资源 ID 之上

激活与给定 res_id（全局资源 ID）关联的 surface，并将其定位在与 above_res_id 关联的 surface 之上。

get_subsurface_watcher
起始版本 2
get_subsurface_watcher(id: new_id<tizen_subsurface_watcher>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_subsurface_watcher>
new tizen_subsurface_watcher object
surfaceobject<wl_surface>
the surface object
获取子 surface 监视器

获取与给定 surface 关联的子 surface 监视器。客户端可以获取与该 surface 关联的子 surface 的信息。

set_parent
起始版本 3
set_parent(child: object<wl_surface>, parent: object<wl_surface>)
参数
类型
描述
childobject<wl_surface>
the surface object
parentobject<wl_surface>
the surface object
设置父级

设置父子关系。子 surface 位于父 surface 之上。

ack_conformant_region
起始版本 4
ack_conformant_region(surface: object<wl_surface>, serial: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
serialuint
serial number
确认 tizen_policy@conformant_region

客户端可以刷新其 surface 以应用来自 tizen_policy@conformant_region 事件的新 conformant 区域。客户端必须在此请求完成更新后进行确认。

destroy
类型: destructor起始版本 6
destroy()
销毁 tizen_policy

销毁此 tizen_policy 对象。

has_video
起始版本 7
has_video(surface: object<wl_surface>, has: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
hasuint
1 is the tizen_video_object, or 0
检查 tizen_video_object

客户端向 display server 发送信息，表明其拥有 tizen_video_object。

set_appid
起始版本 7
set_appid(pid: int, appid: string)
参数
类型
描述
pidint
process id
appidstring
application id
设置应用程序 ID

设置与给定 PID 关联的应用程序 ID。

show
起始版本 8
show(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
通知显示 surface

通知显示给定的 surface。此请求表示客户端将向给定的 surface 附加缓冲区。当客户端发送此请求时，display server 不执行任何操作。

hide
起始版本 8
hide(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
通知隐藏 surface

通知隐藏给定的 surface。此请求表示客户端将向给定的 surface 附加空缓冲区。当客户端发送此请求时，display server 不执行任何操作。

set_transient_for_below
起始版本 9
set_transient_for_below(child_id: uint, parent_id: uint)
参数
类型
描述
child_iduint
parent_iduint
设置 transient_for 并放置在 transient_for 父级下方

建立父子关系。子级始终放置在父级下方。

set_parent_with_below
起始版本 9
set_parent_with_below(child: object<wl_surface>, parent: object<wl_surface>)
参数
类型
描述
childobject<wl_surface>
the surface object
parentobject<wl_surface>允许为空
设置父级并放置在父级下方

建立父子关系。子级始终放置在父级下方。为子窗口设置空父级将移除该子级的任何父子关系。

set_maximize_direction
起始版本 12
set_maximize_direction(surface: object<wl_surface>, direction: uint<tizen_policy.maximize_direction>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
directionuint<tizen_policy.maximize_direction>
maximize direction
设置最大化方向

设置 surface 的最大化方向。

set_pin_mode
起始版本 12
set_pin_mode(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
设置固定模式

设置 surface 的固定模式。

unset_pin_mode
起始版本 12
unset_pin_mode(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消固定模式

取消 surface 的固定模式。

set_layout
起始版本 12
set_layout(surface: object<wl_surface>, num_cols: uint, num_rows: uint, column: uint, row: uint, cols_span: uint, rows_span: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
num_colsuint
the total number of columns
num_rowsuint
the total number of rows
columnuint
the column number to be positioned
rowuint
the row number to be positioned
cols_spanuint
the columns span
rows_spanuint
the rows span
设置 surface 的布局

使用传入的坐标设置 surface 的布局。

set_modal
起始版本 13
set_modal(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
设置模态状态

设置 surface 的模态状态。

unset_modal
起始版本 13
unset_modal(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消模态状态

取消 surface 的模态状态。

conformant
conformant(surface: object<wl_surface>, is_conformant: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
is_conformantuint
if the surface is conformant or not, 0 or 1
conformant 事件

当客户端发送 get_conformant 请求时通知客户端。

conformant_area
conformant_area(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
conformant_partuint
the name of the conformant part
stateuint
visible(1) or not(0)
xint
x position of the hiding area by conformant part
yint
y position of the hiding area by conformant part
wint
width of the hiding area by conformant part
hint
height of the hiding area by conformant part
conformant 区域事件

当 conformant 区域由另一个 surface 作为 conformant_part 计算时通知客户端。此事件不保证 conformant surface 和 conformant part 的 surface 之间的完美组合。

notification_done
notification_done(surface: object<wl_surface>, level: int, error_state: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
levelint
the z-order value
error_stateuint
the error type
set_notification 请求的完成事件

当 surface 位于通过 set_notification_level 请求请求的 z 轴顺序位置时通知客户端。

transient_for_done
transient_for_done(child_id: uint)
参数
类型
描述
child_iduint
the global resource id for the child surface
set/unset transient_for 的完成事件

当与 child_id 关联的 surface 设置或取消 transient 父级时通知客户端。

window_screen_mode_done
window_screen_mode_done(surface: object<wl_surface>, mode: uint, error_state: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
modeuint
the screen mode
error_stateuint
the error type
set_window_screen_mode 请求的完成事件

当客户端请求的 screen_mode 在 display server 中激活时通知客户端。

iconify_state_changed
iconify_state_changed(surface: object<wl_surface>, iconified: uint, force: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
iconifieduint
the iconfied or uniconified state, 1 or 0
forceuint
the iconfied is forced or not, 1 or 0
最小化状态变更事件

当 surface 的最小化状态发生变化时通知客户端。最小化状态不仅在客户端请求最小化和取消最小化时改变，也会在 display server 决定最小化状态时改变。

supported_aux_hints
supported_aux_hints(surface: object<wl_surface>, hints: array, num_hints: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
hintsarray
the id array of the auxiliary hints
num_hintsuint
the number of hints
get_supported_aux_hints 请求的回复事件

当 display server 收到 get_supported_aux_hints 请求时通知客户端。display server 发送该 surface 支持的辅助提示 ID 数组。

allowed_aux_hint
allowed_aux_hint(surface: object<wl_surface>, id: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
idint
the id of the auxiliary hint
允许的辅助提示事件

当给定 surface 的辅助提示被添加和更改时通知客户端。

aux_message
aux_message(surface: object<wl_surface>, key: string, value: string, options: array)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
keystring
the key string
valuestring
the vaule of the key
optionsarray
the array of option information
辅助消息事件

当 display server 发送辅助消息时通知客户端。当 display server 需要向客户端通知附加信息时，可以使用此事件。

conformant_region
起始版本 4
conformant_region(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int, serial: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
conformant_partuint
the name of the conformant part
stateuint
visible(1) or not(0)
xint
x position of the hiding area by conformant part
yint
y position of the hiding area by conformant part
wint
width of the hiding area by conformant part
hint
height of the hiding area by conformant part
serialuint
serail number
通知 conformant 区域（面积）的几何值

服务器可以使用此事件通知 conformant 区域（面积）。如果客户端收到此事件，应使用 tizen_policy@ack_conformant_region 请求进行确认。

interactive_move_done
起始版本 10
interactive_move_done(surface: object<wl_surface>, x: int, y: int, w: uint, h: uint, angle: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
xint
x-position after move
yint
y-position after move
wuint
width after move
huint
height after move
angleint
current angle of surface
交互式移动完成

当 display server 完成交互式移动窗口时发送此事件。窗口更改后的几何信息会一起发送。

interactive_resize_done
起始版本 10
interactive_resize_done(surface: object<wl_surface>, x: int, y: int, w: uint, h: uint, angle: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
xint
x-position after resize
yint
y-position after resize
wuint
width after resize
huint
height after resize
angleint
current angle of surface
交互式调整大小完成

当 display server 完成交互式调整窗口大小时发送此事件。窗口更改后的几何信息会一起发送。

win_type
win_type { none, toplevel, fullscreen, maximized, transient, menu, dnd, custom, notification, utility, dialog, dock, splash, desktop }
参数
值
描述
none0
无
toplevel1
顶层
fullscreen2
全屏状态
maximized3
最大化状态
transient4
transient 关系状态
menu5
菜单
dnd6
拖放
custom7
自定义
notification8
通知
utility9
工具
dialog10
对话框
dock11
停靠栏
splash12
启动画面
desktop起始版本 1113
桌面
surface 的窗口类型

客户端可以通过 set_type 请求使用 win_type 值设置窗口类型。该值赋予 surface 窗口状态、窗口层中窗口栈的 z 轴顺序以及 display server 中的其他类型。

以下是按 z 轴顺序降序排列的窗口类型值。依次为：notification、dnd、dock、splash、fullscreen、toplevel 或 maximized、desktop。 menu、dnd、notification、utility、dialog、dock、splash 和 desktop 是 netwm 规范中定义的窗口类型。 https://specifications.freedesktop.org/wm-spec/wm-spec-1.4.html#idm46148902270160

conformant_part
conformant_part { indicator, keyboard, clipboard }
参数
值
描述
indicator0
指示器 surface
keyboard1
键盘 surface
clipboard2
剪贴板 surface
conformant part 的名称

此值表示 Tizen 平台上的 surface 名称。

error_state
error_state { none, permission_denied }
参数
值
描述
none0
成功
permission_denied1
权限被拒绝
错误状态

描述错误状态。

level
level { 1, 2, 3, none, default, medium, high, top }
参数
值
描述
10
底部默认 z 轴顺序
21
底部中等 z 轴顺序
32
底部高 z 轴顺序
none-1
底部最低 z 轴顺序
default10
默认 z 轴顺序
medium20
中等 z 轴顺序
high30
高 z 轴顺序
top40
顶部 z 轴顺序
通知级别

这是通知类型的级别。此级别代表 display server 中通知层的 z 轴顺序。none、1、2、3、default、medium、high 和 top 按 z 轴顺序升序排列。数值越小表示 z 轴顺序越低。

mode
mode { default, always_on }
参数
值
描述
default0
默认屏幕模式
always_on1
保持屏幕常亮
屏幕模式

此值表示屏幕的运行方式。

stack_mode
stack_mode { none, above, below }
参数
值
描述
none0
above1
below2
相对栈顺序的模式

set_stack_mode 请求使用此模式值。

maximize_direction
maximize_direction { none, all, left, right, top, bottom }
参数
值
描述
none0
无，等同于取消最大化
all1
全屏大小
left2
屏幕左侧
right3
屏幕右侧
top4
屏幕顶部
bottom5
屏幕底部
方向值

这些值由 set_maximize_direction 作为参数使用。

tizen_visibility

版本 5
Tizen 平台特有的可见性

客户端希望了解 surface 的可见性信息。

destroy
类型: destructor
destroy()
销毁 tizen_visibility

销毁此 tizen_visibility 对象。

notify
notify(visibility: uint)
参数
类型
描述
visibilityuint
visiblity type
通知可见性状态

当 surface 的可见性发生变化时通知客户端。

changed
起始版本 5
changed(type: uint<tizen_visibility.visibility>, option: uint)
参数
类型
描述
typeuint<tizen_visibility.visibility>
changed visibility type
optionuint
extra value
通知变更的可见性类型

当 surface 的可见性发生变化并带有额外值时通知客户端。

visibility
visibility { unobscured, partially_obscured, fully_obscured, pre_unobscured }
参数
值
描述
unobscured0
完全显示在屏幕上
partially_obscured1
部分显示在屏幕上
fully_obscured2
不显示在屏幕上
pre_unobscured起始版本 53
准备变为完全可见
可见性类型

这些是可见性类型，用于说明与 tizen_visibility 资源关联的 surface 在屏幕上的显示状态。

tizen_position

版本 1
Tizen 平台特有的位置

客户端可以设置 surface 的位置信息。

destroy
类型: destructor
destroy()
销毁 tizen_position

销毁此 tizen_position 对象。

set
set(x: int, y: int)
参数
类型
描述
xint
x position
yint
y position
设置位置

设置位置。

changed
changed(x: int, y: int)
参数
类型
描述
xint
x position
yint
y position
位置变更事件

当位置发生变化时通知客户端。

tizen_move_resize

版本 1

destroy
类型: destructor
destroy()
set_geometry
set_geometry(surface: object<wl_surface>, serial: uint, x: int, y: int, w: int, h: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
serialuint
xint
yint
wint
hint
geometry_done
geometry_done(surface: object<wl_surface>, serial: uint, x: int, y: int, w: int, h: int, error_state: uint<tizen_move_resize.error_state>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
serialuint
xint
yint
wint
hint
error_stateuint<tizen_move_resize.error_state>
通知 set_geometry 请求的结果

tizen_gesture

版本 2

grab_tap
起始版本 2
grab_tap(fingers: uint, repeats: uint)
参数
类型
描述
fingersuint
repeatsuint
ungrab_tap
起始版本 2
ungrab_tap(fingers: uint, repeats: uint)
参数
类型
描述
fingersuint
repeatsuint
grab_palm_cover
起始版本 2
grab_palm_cover()
ungrab_palm_cover
起始版本 2
ungrab_palm_cover()
select_palm_cover
起始版本 2
select_palm_cover(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
deselect_palm_cover
起始版本 2
deselect_palm_cover(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
activate_set
起始版本 2
activate_set(surface: object<wl_surface>, type: uint<tizen_gesture.type>, active: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
typeuint<tizen_gesture.type>
activeuint
destroy
类型: destructor起始版本 2
destroy()
销毁 tizen_gesture

销毁 tizen_gesture。

edge_swipe
edge_swipe(mode: uint<tizen_gesture.mode>, fingers: uint, sx: int, sy: int, edge: uint<tizen_gesture.edge>)
参数
类型
描述
modeuint<tizen_gesture.mode>
fingersuint
sxint
x coordinate of touch down point
syint
y coordinate of touch down point
edgeuint<tizen_gesture.edge>
edge_drag
edge_drag(mode: uint<tizen_gesture.mode>, fingers: uint, cx: int, cy: int, edge: uint<tizen_gesture.edge>)
参数
类型
描述
modeuint<tizen_gesture.mode>
fingersuint
cxint
x coordinate of center touch point
cyint
y coordinate of center touch point
edgeuint<tizen_gesture.edge>
tap_notify
起始版本 2
tap_notify(fingers: uint, repeats: uint, error: uint)
参数
类型
描述
fingersuint
repeatsuint
erroruint
tap
起始版本 2
tap(mode: uint<tizen_gesture.mode>, fingers: uint, repeats: uint)
参数
类型
描述
modeuint<tizen_gesture.mode>
fingersuint
repeatsuint
palm_cover_notify
起始版本 2
palm_cover_notify(surface: object<wl_surface>, error: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
erroruint
palm_cover
起始版本 2
palm_cover(surface: object<wl_surface>, mode: uint<tizen_gesture.mode>, duration: uint, cx: int, cy: int, size: uint, pressure: fixed)
参数
类型
描述
surfaceobject<wl_surface>允许为空
modeuint<tizen_gesture.mode>
durationuint
cxint
x coordinate of center touch point
cyint
y coordinate of center touch point
sizeuint
pressurefixed
activate_notify
起始版本 2
activate_notify(surface: object<wl_surface>, type: uint<tizen_gesture.type>, active: uint, error: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
typeuint<tizen_gesture.type>
activeuint
erroruint
type
type { edge_swipe, edge_drag, tap, palm_cover, pan, pinch, palm_swipe }
参数
值
描述
edge_swipe1
edge_drag起始版本 22
tap起始版本 24
palm_cover起始版本 28
pan起始版本 216
pinch起始版本 232
palm_swipe起始版本 264
edge_size
edge_size { none, full, partial }
参数
值
描述
none0
full1
partial2

tizen_keyrouter

版本 2
为每个按键设置单独焦点的接口

传统上，键盘和附加了某些按键的设备上的所有按键默认发送到焦点 surface。目前可以为键盘和设备上的每个按键设置单独的焦点。因此，通过为 surface 设置按键捕获，当该 surface 拥有某个按键的捕获时，其所有者将收到该按键事件。

set_keygrab
set_keygrab(surface: object<wl_surface>, key: uint, mode: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
keyuint
modeuint
unset_keygrab
unset_keygrab(surface: object<wl_surface>, key: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
keyuint
get_keygrab_status
get_keygrab_status(surface: object<wl_surface>, key: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
keyuint
set_keygrab_list
set_keygrab_list(surface: object<wl_surface>, grab_list: array)
参数
类型
描述
surfaceobject<wl_surface>允许为空
grab_listarray
array of two integer variables pairs each pairs consist of keycode and keygrab mode
unset_keygrab_list
unset_keygrab_list(surface: object<wl_surface>, ungrab_list: array)
参数
类型
描述
surfaceobject<wl_surface>允许为空
ungrab_listarray
array of integer variables meaning keycode wanted to ungrab
get_keygrab_list
get_keygrab_list(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>允许为空
set_register_none_key
set_register_none_key(surface: object<wl_surface>, data: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
datauint
get_keyregister_status
get_keyregister_status(data: uint)
参数
类型
描述
datauint
set_input_config
set_input_config(surface: object<wl_surface>, config_mode: uint, value: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
config_modeuint
valueuint
destroy
类型: destructor
destroy()
销毁 tizen_keyrouter

销毁 tizen_keyrouter。

keygrab_notify
keygrab_notify(surface: object<wl_surface>, key: uint, mode: uint, error: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
keyuint
modeuint
erroruint
keygrab_notify_list
keygrab_notify_list(surface: object<wl_surface>, grab_result: array)
参数
类型
描述
surfaceobject<wl_surface>允许为空
grab_resultarray
array of three integer variables pairs each pairs consist of keycode, keygrab mode and keygrab result
getgrab_notify_list
getgrab_notify_list(surface: object<wl_surface>, grab_result: array)
参数
类型
描述
surfaceobject<wl_surface>允许为空
grab_resultarray
array of two integer variables pairs each pairs consist of keycode, keygrab mode
set_register_none_key_notify
set_register_none_key_notify(surface: object<wl_surface>, mode: uint)
参数
类型
描述
surfaceobject<wl_surface>允许为空
modeuint
keyregister_notify
keyregister_notify(status: uint)
参数
类型
描述
statusuint
set_input_config_notify
set_input_config_notify(status: uint)
参数
类型
描述
statusuint
key_cancel
key_cancel(key: uint)
参数
类型
描述
keyuint
event_surface
起始版本 2
event_surface(surface: object<wl_surface>, key: uint, mode: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
keyuint
modeuint
error
error { none, invalid_surface, invalid_key, invalid_mode, grabbed_already, no_permission, no_system_resources, invalid_array }
参数
值
描述
none0
无错误
invalid_surface1
给定的 surface 无效
invalid_key2
给定的按键无效
invalid_mode3
给定的模式无效
grabbed_already4
该按键已被捕获
no_permission5
wl 客户端没有捕获按键的权限
no_system_resources6
系统资源不足
invalid_array7
给定的数组包含无效的配对或数据类型
mode
mode { none, shared, topmost, overridable_exclusive, exclusive, registered }
参数
值
描述
none0
无
shared1
当焦点客户端 surface 获取按键时，与其他客户端 surface 共享按键捕获的模式
topmost2
当客户端 surface 位于最顶层时获取按键捕获的模式
overridable_exclusive3
无论 surface 栈中的顺序如何，独占且可覆盖地获取按键捕获的模式
exclusive4
无论 surface 栈中的顺序如何，独占地获取按键捕获的模式
registered5
仅当请求 surface 位于注册该按键的 surface 顶部时才获取按键捕获的模式
按键捕获模式

此值用于设置按键捕获的模式。合成器将根据此模式和 surface 在 surface 栈中的顺序来确定目标客户端 surface。

config_mode
config_mode { none, invisible_set, invisible_get, num_key_focus, picture_off }
参数
值
描述
none0
无
invisible_set1
设置窗口以将事件发送到栈中下方不可见窗口的模式
invisible_get2
当任何顶层窗口已设置 register_set 时，设置窗口以获取不可见状态事件的模式
num_key_focus3
为焦点窗口注册数字键的模式
picture_off4
为特定按键设置关闭画面的模式
设置按键传递特定属性的模式

此值用于为窗口设置模式。合成器将根据此模式和 surface 在 surface 栈中的顺序来确定目标客户端 surface。

tizen_screenshooter

版本 3
tizen-screenshooter 接口

客户端可以从此接口获取 screenmirror 对象。

get_screenmirror
get_screenmirror(id: new_id<tizen_screenmirror>, output: object<wl_output>)
参数
类型
描述
idnew_id<tizen_screenmirror>
new screenmirror object
outputobject<wl_output>
output object for screenmirror
创建 screenmirror 对象

在使用 screenmirror 之前，客户端应从 display server 获取 screenmirror 对象。

set_oneshot_auto_rotation
set_oneshot_auto_rotation(set: uint)
参数
类型
描述
setuint
设置截图自动旋转值

客户端可以设置单次截图的自动旋转值。

destroy
类型: destructor
destroy()
销毁 tizen_screenshooter

销毁 tizen_screenshooter。

shoot
起始版本 3
shoot(output: object<wl_output>, buffer: object<wl_buffer>)
参数
类型
描述
outputobject<wl_output>
bufferobject<wl_buffer>
format
format(format: uint)
参数
类型
描述
formatuint
screenshooter 支持的格式

tbm 格式代码与 tbm_surface.h 中的 #define 匹配。合成器实际支持的格式将通过 format 事件报告。

screenshooter_notify
screenshooter_notify(noti: uint)
参数
类型
描述
notiuint
发送 screenshooter 通知

客户端可以获取 screenshooter 的通知。

done
起始版本 3
done()

tizen_screenmirror

版本 3
screenmirror 接口

客户端可以使用此接口获取屏幕的流图像。启动前，先排队所有缓冲区。然后启动 screenmirror。启动后，当在缓冲区上绘制捕获的图像完成后，将发生出队事件。您可能需要将出队的缓冲区重新排队以从 display server 获取新图像。

destroy
类型: destructor
destroy()
set_stretch
set_stretch(stretch: uint)
参数
类型
描述
stretchuint
stretch type for screenmirror
queue
queue(buffer: object<wl_buffer>)
参数
类型
描述
bufferobject<wl_buffer>
buffer object for screenmirror
排队缓冲区
dequeue
dequeue(buffer: object<wl_buffer>)
参数
类型
描述
bufferobject<wl_buffer>
buffer object for screenmirror
出队缓冲区

当用户希望从服务器取回缓冲区时，可以从 display server 出队缓冲区。

set_auto_rotation
起始版本 2
set_auto_rotation(set: uint)
参数
类型
描述
setuint
设置 screenmirror 自动旋转值

客户端可以为 screenmirror 设置自动旋转值。

dequeued
dequeued(buffer: object<wl_buffer>)
参数
类型
描述
bufferobject<wl_buffer>
dequeued buffer which contains a captured image
出队事件

当在缓冲区上绘制捕获的图像完成时发生。

content
content(content: uint)
参数
类型
描述
contentuint
内容变更事件

当捕获图像的内容发生变化时发生（普通或视频）。

stop
stop()
停止事件

当 screenmirror 最终停止时发生。

tizen_video

版本 1
tizen-video 接口

客户端可以从此接口获取合成器能够处理的视频信息。

get_object
get_object(id: new_id<tizen_video_object>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_video_object>
surfaceobject<wl_surface>
the surface object
get_viewport
get_viewport(id: new_id<tizen_viewport>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_viewport>
surfaceobject<wl_surface>
the surface object
destroy
类型: destructor
destroy()
销毁 tizen_video

销毁 tizen_video。

format
format(format: uint)
参数
类型
描述
formatuint
视频支持的格式

tbm 格式代码与 tbm_surface.h 中的 #define 匹配。合成器实际支持的格式将通过 format 事件报告。

tizen_video_object

版本 1

destroy
类型: destructor
destroy()
set_attribute
set_attribute(name: string, value: int)
参数
类型
描述
namestring
valueint
follow_topmost_visibility
follow_topmost_visibility()
跟随最顶层 surface 的静音控制变更

如果 tizen_video_object.follow_topmost_visibility 应用于 video_object，将基于最顶层可见性进行视频静音控制。

unfollow_topmost_visibility
unfollow_topmost_visibility()
取消跟随最顶层 surface 的静音控制变更

如果 tizen_video_object.unfollow_topmost_visibility 应用于 video_object，将不基于最顶层可见性进行视频静音控制。

allowed_attribute
allowed_attribute()
允许的属性

如果 tizen_video_object.allowed_attribute 应用于 video_object，set_attribute 请求将直接传递到 tdm 后端。

disallowed_attribute
disallowed_attribute()
不允许的属性

如果 tizen_video_object.disallowed_attribute 应用于 video_object，当最顶层显示时将调用 tdm_attribute。

attribute
attribute(name: string, value: uint)
参数
类型
描述
namestring
valueuint
size
size(min_w: int, min_h: int, max_w: int, max_h: int, prefer_align: int)
参数
类型
描述
min_wint
min_hint
max_wint
max_hint
prefer_alignint

tizen_subsurface_watcher

版本 1

destroy
类型: destructor
destroy()
销毁 tizen_subsurface_watcher

销毁 tizen_subsurface_watcher。

message
message(value: uint)
参数
类型
描述
valueuint

tizen_viewport

版本 1
surface 的视口

这是 wl_viewport 的替代且便捷的解决方案，用于在屏幕上呈现 surface。

以下五个功能可以被此接口替代。将此接口应用于 surface 后，以下功能将被忽略：

  • wl_surface.set_buffer_transform
  • wl_surface.set_buffer_scale
  • wl_subsurface.set_position
  • wl_viewport.set_source
  • wl_viewport.set_destination

wl_viewport.set_source 非常复杂，特别是当 wl_surface 的缓冲区通过 wl_surface.set_buffer_transform 进行变换时。当父级调整大小时，如果我们也想更改子 surface 的几何形状，需要在客户端每次调整父级大小时调用 wl_subsurface.set_position 和 wl_viewport.set_destination。这使得父 surface 和子 surface 在屏幕上的同步变得困难。

tizen_viewport 允许客户端在父 surface 中为子 surface 设置相对几何形状。每当父 surface 调整大小时，子 surface 的几何形状将由合成器自动计算、移动和调整大小。tizen_viewport 在子 surface 的父级坐标中指定。

如果 tizen_viewport 应用于 shell surface（toplevel），则与 x、y 位置相关的 tizen_viewport 和 tizen_destination_mode 接口的所有值将被忽略。

以下 3 个功能不考虑父 surface 的变换：

  • tizen_viewport.set_source
  • tizen_viewport.set_destination
  • tizen_viewport.set_destination_ratio

此外，如果调用 tizen_destination_mode.follow_parent_transform，tizen_viewport 在将目标模式应用于子 surface 时将考虑父 surface 的变换。如果 tizen_destination_mode.follow_parent_transform 应用于 shell surface，它将被忽略。

目标将被父 surface 裁剪。

更改将在调用 wl_surface.commit 时生效。

destroy
类型: destructor
destroy()
set_transform
set_transform(transform: uint)
参数
类型
描述
transformuint
设置 surface 的变换

transform 参数的可接受值是根据输出变换的 wl_output.transform 值。

tizen_viewport.set_transform 仅应用于自身。基本上它不影响其子 surface 的变换。也就是说，如果设置了 90 度变换，而其子 surface 仍然具有 0 度变换，则其子 surface 不会被旋转。

如果需要根据父 surface 旋转子 surface，tizen_destination_mode.follow_parent_transform 将使其成为可能。

set_source
set_source(x: uint, y: uint, width: uint, height: uint)
参数
类型
描述
xuint
yuint
widthuint
heightuint
设置 wl_buffer 的源矩形

当父级调整大小时，源矩形不会改变。如果需要更改，应使用新值调用 tizen_viewport.set_source。

set_destination
set_destination(x: int, y: int, width: uint, height: uint)
参数
类型
描述
xint
yint
widthuint
heightuint
设置 surface 的目标几何形状

当父级调整大小时，目标几何形状不会改变。如果需要更改，应使用新值调用 tizen_viewport.set_destination。

如果 tizen_viewport 应用于 shell surface（toplevel），tizen_viewport.set_destination 的 x、y 值将被忽略。

set_destination_ratio
set_destination_ratio(x: fixed, y: fixed, width: fixed, height: fixed)
参数
类型
描述
xfixed
yfixed
widthfixed
heightfixed
在父 surface 中设置目标矩形的比例

当父级调整大小时，子 surface 的目标矩形将自动更改。这允许使用 0.0 到 1.0 之间的实数。参见 wl_fixed_from_double 和 wl_fixed_to_double。

如果 tizen_viewport 应用于 shell surface（toplevel），tizen_viewport.set_destination_ratio 的 x、y 值将被忽略。

get_destination_mode
get_destination_mode(id: new_id<tizen_destination_mode>)
参数
类型
描述
idnew_id<tizen_destination_mode>
query_parent_size
起始版本 1
query_parent_size()
在父 surface 中设置目标矩形的比例

客户端可以请求 display server 发送 tizen_viewport 对象的父 surface 的大小。一旦客户端请求，每当父 surface 的大小发生变化时，"parent_size" 事件将被发送。

follow_parent_transform
follow_parent_transform()
跟随父 surface 的变换变更

子 surface 的实际变换是（父级的变换 + 子 surface 的变换）。当父级旋转时，子 surface 将自动旋转。

如果 tizen_viewport.follow_parent_transform 应用于 shell surface（toplevel），它将被忽略。

destination_changed
destination_changed(transform: uint, x: int, y: int, width: uint, height: uint)
参数
类型
描述
transformuint
xint
yint
widthuint
heightuint
parent_size
parent_size(width: uint, height: uint)
参数
类型
描述
widthuint
heightuint

tizen_destination_mode

版本 1
surface 的目标模式

当父级调整大小时，目标矩形将自动更改。当调用 tizen_destination_mode.set 时，tizen_viewport.set_destination 和 tizen_viewport.set_destination_ratio 的值将被忽略。

surface 的目标由模式、比例、缩放、偏移和对齐值决定。比例、缩放、偏移和对齐将按顺序应用。

更改将在调用 wl_surface.commit 时生效。

destroy
类型: destructor
destroy()
follow_parent_transform
follow_parent_transform()
跟随父 surface 的变换变更

子 surface 的实际变换是（父级的变换 + 子 surface 的变换）。也就是说，当父级旋转时，子 surface 将自动旋转。

如果 tizen_destination_mode.follow_parent_transform 应用于 shell surface（toplevel），它将被忽略。

set_ratio
set_ratio(horizontal: fixed, vertical: fixed)
参数
类型
描述
horizontalfixed
verticalfixed
设置子 surface 目标矩形的比例

这允许使用实数。参见 wl_fixed_from_double 和 wl_fixed_to_double。

set_scale
set_scale(horizontal: fixed, vertical: fixed)
参数
类型
描述
horizontalfixed
verticalfixed
设置子 surface 目标矩形的缩放

这允许使用实数。参见 wl_fixed_from_double 和 wl_fixed_to_double。

set_align
set_align(horizontal: fixed, vertical: fixed)
参数
类型
描述
horizontalfixed
verticalfixed
设置子 surface 目标矩形的对齐

这允许使用 0.0 到 1.0 之间的实数。参见 wl_fixed_from_double 和 wl_fixed_to_double。

set_offset
set_offset(x: int, y: int, w: int, h: int)
参数
类型
描述
xint
yint
wint
hint
error
error { invalid_type }
参数
值
描述
invalid_type0
无效类型

tizen_embedded_compositor

版本 1
全局嵌入式合成器对象

全局对象。Wayland 有 3 种类型的合成器，嵌入式合成器是其中之一。但 Tizen 应用程序被 smack 沙箱化，因此应用程序不允许通过套接字与其他应用程序通信。所以系统或会话合成器创建套接字并发送给嵌入式合成器。

get_socket
get_socket()
创建新套接字

get_socket 请求要求服务器创建套接字并触发 socket 事件。

destroy
类型: destructor
destroy()
socket
socket(sock_fd: fd)
参数
类型
描述
sock_fdfd
套接字文件描述符

在 get_socket 请求后立即发送。

tizen_input_device_manager

版本 7
全局输入设备管理器对象

Tizen 输入设备管理器是一个全局接口。此对象具有设备添加/移除事件，用于向客户端提供 Tizen 输入设备对象。这允许客户端获取设备信息。

请确保在绑定 wl_seat 接口之后绑定此接口。 Tizen 输入设备管理器接口仅会为属于客户端绑定的 wl_seat 对象的设备提供设备添加/移除事件。因此，合成器只需要为当前客户端的 seat 创建/发送设备添加/移除事件。

block_events
block_events(serial: uint, clas: uint<tizen_input_device_manager.clas>, duration: uint)
参数
类型
描述
serialuint
clasuint<tizen_input_device_manager.clas>
durationuint
time duration with millisecond granularity
请求阻止发送事件

此请求允许客户端请求为其目的阻止一个或多个事件。通过在请求中指定 class 作为参数，属于该 class 的事件将在给定持续时间内被阻止。请注意，如果出现任何错误，将发送错误事件。

unblock_events
unblock_events(serial: uint)
参数
类型
描述
serialuint
请求取消阻止发送事件

此请求允许客户端请求释放客户端的现有阻止。请注意，如果客户端没有现有阻止，则不会发送错误事件。

init_generator
init_generator(clas: uint<tizen_input_device_manager.clas>)
参数
类型
描述
clasuint<tizen_input_device_manager.clas>
初始化输入生成器系统
deinit_generator
deinit_generator(clas: uint<tizen_input_device_manager.clas>)
参数
类型
描述
clasuint<tizen_input_device_manager.clas>
反初始化输入生成器系统
generate_key
generate_key(keyname: string, pressed: uint)
参数
类型
描述
keynamestring
presseduint
使用特定或默认设备生成按键事件
generate_pointer
generate_pointer(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, button: uint)
参数
类型
描述
typeuint<tizen_input_device_manager.pointer_event_type>
xuint
yuint
buttonuint
使用特定或默认设备生成指针事件
generate_touch
generate_touch(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, finger: uint)
参数
类型
描述
typeuint<tizen_input_device_manager.pointer_event_type>
xuint
yuint
fingeruint
使用特定或默认设备生成触摸事件
pointer_warp
pointer_warp(surface: object<wl_surface>, x: fixed, y: fixed)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
xfixed
yfixed
将指针移动到相对于给定 surface 的位置
init_generator_with_name
起始版本 2
init_generator_with_name(clas: uint<tizen_input_device_manager.clas>, name: string)
参数
类型
描述
clasuint<tizen_input_device_manager.clas>
namestring
使用名称初始化输入生成器系统
destroy
类型: destructor起始版本 2
destroy()
销毁 tizen_input_device_manager

销毁 tizen_input_device_manager。

generate_axis
起始版本 3
generate_axis(type: uint<tizen_input_device_manager.axis_type>, value: fixed)
参数
类型
描述
typeuint<tizen_input_device_manager.axis_type>
valuefixed
axis value
使用特定或默认设备生成指针/触摸轴事件

当服务器收到此请求时，服务器选择直接生成事件或仅保存值。指针轴（如滚轮/水平滚轮）独立于指针事件传递给客户端，但触摸轴传递给普通触摸事件（begin/update/end）。因此服务器在生成触摸请求之前仅保存触摸轴，并发送包含已保存触摸轴值的触摸事件。

set_touch_count
起始版本 4
set_touch_count(max_count: int)
参数
类型
描述
max_countint
设置触摸的最大插槽数

此请求仅更改系统的触摸数量。因此此请求不会更改已连接触摸设备的最大数量。这将影响用户使用输入生成器创建的设备。输入生成器创建仅支持默认触摸数量的触摸设备。但如果用户在创建输入生成器设备之前设置触摸数量，用户可以创建具有所需触摸数量的触摸设备。但某些系统有自己的最大触摸数量。在这种情况下，此请求返回 not_allowed 错误。

init_generator_with_sync
起始版本 5
init_generator_with_sync(clas: uint<tizen_input_device_manager.clas>, name: string)
参数
类型
描述
clasuint<tizen_input_device_manager.clas>
namestring
使用名称同步初始化输入生成器系统
keyboard_grab
起始版本 6
keyboard_grab(surface: object<wl_surface>, subclas: uint<tizen_input_device_manager.subclas>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
subclasuint<tizen_input_device_manager.subclas>
如果设备是特定子类则捕获键盘事件
keyboard_ungrab
起始版本 6
keyboard_ungrab(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消捕获键盘事件
grab_relative_motion
起始版本 7
grab_relative_motion(surface: object<wl_surface>, boundary: uint<tizen_input_device_manager.boundary>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
boundaryuint<tizen_input_device_manager.boundary>
捕获相对运动
ungrab_relative_motion
起始版本 7
ungrab_relative_motion(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
取消捕获相对运动
device_add
device_add(serial: uint, identifier: string, device: new_id<tizen_input_device>, seat: object<wl_seat>)
参数
类型
描述
serialuint
identifierstring
devicenew_id<tizen_input_device>
seatobject<wl_seat>
设备添加事件

当物理/逻辑设备添加到给定 seat 时，将发送设备添加/移除通知。请注意，Tizen 输入设备对象可以分配给一个 wl_seat，也可以随时分配给另一个 wl_seat。每当 Tizen 输入设备对象的关系发生变化时，将从当前 wl_seat 对象生成设备移除事件，并从另一个 wl_seat 对象生成设备添加事件。

device_remove
device_remove(serial: uint, identifier: string, device: object<tizen_input_device>, seat: object<wl_seat>)
参数
类型
描述
serialuint
identifierstring
deviceobject<tizen_input_device>
seatobject<wl_seat>
设备移除事件

当物理/逻辑设备从给定 seat 移除时，将发送设备添加/移除通知。请注意，Tizen 输入设备对象可以分配给一个 wl_seat，也可以随时分配给另一个 wl_seat。每当 Tizen 输入设备对象的关系发生变化时，将从当前 wl_seat 对象生成设备移除事件，并从另一个 wl_seat 对象生成设备添加事件。

block_expired
block_expired()
阻止到期事件

如果现有阻止的持续时间到期，将发送此事件。请注意，如果客户端没有阻止，则不会发送阻止到期事件。

max_touch_count
起始版本 4
max_touch_count(serial: uint, max_count: int, seat: object<wl_seat>)
参数
类型
描述
serialuint
max_countint
seatobject<wl_seat>
通知触摸设备的最大插槽数已更新

每个触摸设备都有其支持的触摸数量。因此服务器控制系统中的最大触摸数量以有效维护资源。有时服务器使用预定义的配置选项控制最大触摸数量。有时服务器确保触摸设备支持的最大触摸数量。如果服务器不使用配置选项，当新的触摸设备连接时，最大触摸数量可能会更新。因此，当第一个触摸设备被添加或最大触摸数量发生变化时，此事件可以发送给客户端。

event_boundary
起始版本 7
event_boundary(serial: uint, boundary: uint<tizen_input_device_manager.boundary>)
参数
类型
描述
serialuint
boundaryuint<tizen_input_device_manager.boundary>
指示哪个边界与 relative_motion 事件关联的事件
clas
clas { none, mouse, keyboard, touchscreen }
参数
值
描述
none0
无类别
mouse1
鼠标类别
keyboard2
键盘类别
touchscreen4
触摸屏类别
设备类别
error
error { none, no_permission, invalid_class, blocked_already, no_system_resources, invalid_parameter, invalid_surface, no_pointer_available, not_allowed }
参数
值
描述
none0
无错误
no_permission1
无权限
invalid_class2
无效类别
blocked_already3
已被其他客户端阻止
no_system_resources4
系统资源不足（如内存不足）
invalid_parameter5
参数无效
invalid_surface6
给定的 surface 不可见或指针不在给定的 surface 上
no_pointer_available7
没有可用的指针进行移动
not_allowed8
此系统不允许此请求
axis_type
起始版本 3
axis_type { none, wheel, hwheel, radius_x, radius_y, pressure, angle, palm }
参数
值
描述
none0
无轴类型
wheel1
指针垂直滚轮轴
hwheel2
指针水平滚轮轴
radius_x3
事件区域的 x 轴触摸半径（如用手指或触笔触摸的区域）
radius_y4
事件区域的 y 轴触摸半径（如用手指或触笔触摸的区域）
pressure5
事件区域的触摸压力（如用手指或触笔触摸的区域）
angle6
事件区域的触摸角度（如用手指或触笔触摸的区域）
palm7
事件区域的触摸手掌（如用手指或触笔触摸的区域）
subclas
subclas { none, remocon, virtual_keyboard }
参数
值
描述
none1
无子类
remocon2
遥控器子类
virtual_keyboard4
虚拟键盘子类
设备子类

tizen_input_device

版本 1
Tizen 输入设备对象

tizen_input_device 接口表示与物理/逻辑输入设备关联的一个或多个输入设备。此接口提供设备特定的信息/事件，允许客户端识别事件的源设备或获取设备的额外轴/属性。请注意，tizen_input_device 对象可以用于物理输入设备，也可以用于一组输入设备，例如一组鼠标设备。

select_axes
select_axes(axes: array)
参数
类型
描述
axesarray
array of axis num
请求选择 tizen_input_device 对象支持的轴中的一部分
release
类型: destructor
release()
释放 tizen_input_device 对象
device_info
device_info(name: string, clas: uint<tizen_input_device.clas>, subclas: uint<tizen_input_device.subclas>, axes: array)
参数
类型
描述
namestring
clasuint<tizen_input_device.clas>
subclasuint<tizen_input_device.subclas>
axesarray
array of axis enum
包含设备信息的事件
event_device
event_device(serial: uint, name: string, time: uint)
参数
类型
描述
serialuint
namestring
timeuint
timestamp with millisecond granularity
指示与 wl_pointer/keyboard/touch 事件关联的源设备的事件
axis
axis(axis_type: uint<tizen_input_device.axis_type>, value: fixed)
参数
类型
描述
axis_typeuint<tizen_input_device.axis_type>
valuefixed
axis value
轴变更事件
clas
clas { none, keyboard, mouse, touchscreen }
参数
值
描述
none0
无类别
keyboard2
键盘类别
mouse3
鼠标类别
touchscreen4
触摸屏类别
设备类别
subclas
subclas { none }
参数
值
描述
none0
无子类
设备子类
axis_type
axis_type { none, radius_x, radius_y, pressure, angle, detent }
参数
值
描述
none0
事件区域的 x 轴半径（如用手指或触笔触摸的区域）
radius_x1
事件区域的 x 轴半径（如用手指或触笔触摸的区域）
radius_y2
事件区域的 y 轴半径（如用手指或触笔触摸的区域）
pressure3
事件区域的压力（如用手指或触笔触摸的区域）
angle4
事件区域的角度（如用手指或触笔触摸的区域）
detent5
棘轮值（如旋转设备的移动距离）
设备可支持的轴类型枚举

tizen_launchscreen

版本 1

create_img
create_img(id: new_id<tizen_launch_image>)
参数
类型
描述
idnew_id<tizen_launch_image>
new tizen_launch_image object
destroy
类型: destructor
destroy()
销毁 tizen_launchscreen

销毁 tizen_launchscreen。

tizen_launch_image

版本 1

destroy
类型: destructor
destroy()
launch
launch(file: string, file_type: uint, color_depth: uint, rotation: uint, indicator: uint, options: array)
参数
类型
描述
filestring
file_typeuint
color_depthuint
rotationuint
indicatoruint
optionsarray
owner
owner(pid: uint)
参数
类型
描述
piduint
file_type
file_type { img, edj }
参数
值
描述
img0
启动画面图像文件路径
edj1
启动画面 edj 文件路径
indicator
indicator { off, on }
参数
值
描述
off0
启动画面隐藏指示器
on1
启动画面显示指示器
rotation
rotation { 0, 90, 180, 270 }
参数
值
描述
00
旋转角度 0 度
9090
旋转角度 90 度
180180
旋转角度 180 度
270270
旋转角度 270 度

tizen_effect

版本 1

destroy
类型: destructor
destroy()
start
start(surface: object<wl_surface>, type: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
typeuint
end
end(surface: object<wl_surface>, type: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
typeuint
type
type { none, show, hide, restack }
参数
值
描述
none0
无
show1
窗口显示效果
hide2
窗口隐藏效果
restack3
窗口重排效果

tizen_display_policy

版本 1

set_window_brightness
set_window_brightness(surface: object<wl_surface>, brightness: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
brightnessint
destroy
类型: destructor
destroy()
销毁 tizen_display_policy

销毁 tizen_display_policy。

window_brightness_done
window_brightness_done(surface: object<wl_surface>, brightness: int, error_state: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
brightnessint
error_stateuint

tizen_indicator

版本 1

destroy
类型: destructor
destroy()
set_state
set_state(surface: object<wl_surface>, state: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
stateint
set_opacity_mode
set_opacity_mode(surface: object<wl_surface>, mode: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
modeint
set_visible_type
set_visible_type(surface: object<wl_surface>, type: int)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
typeint
flick
flick(surface: object<wl_surface>, type: int)
参数
类型
描述
surfaceobject<wl_surface>
occur the flick event
typeint
state
state { unknown, off, on }
参数
值
描述
unknown0
未知
off1
无法显示指示器
on2
可以显示指示器
opacity_mode
opacity_mode { unknown, opaque, translucent, transparent, bg_transparent }
参数
值
描述
unknown0
未知
opaque1
不透明模式
translucent2
半透明模式
transparent3
完全透明模式
bg_transparent4
仅背景透明模式
visible_type
visible_type { hidden, shown }
参数
值
描述
hidden0
隐藏类型指示器
shown1
显示类型指示器

tizen_clipboard

版本 2
剪贴板请求和事件的接口

此接口为其他客户端提供有关剪贴板的一些请求和事件。

destroy
类型: destructor
destroy()
show
show(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
请求显示剪贴板
hide
hide(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
请求隐藏剪贴板
set_data_only
起始版本 2
set_data_only(set: uint)
参数
类型
描述
setuint
请求为此 wl_client 设置仅数据模式

Wayland 客户端可以通知该客户端处于仅数据模式。仅数据模式意味着此 Wayland 客户端没有任何 wl_surface，但希望使用 wl_data_device 进行某些数据操作。

data_selected
data_selected(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
宣布数据已被剪贴板选中
allowed_data_only
起始版本 2
allowed_data_only(allowed: uint)
参数
类型
描述
alloweduint
通知是否允许设置仅数据模式的事件

tizen_screen_rotation

版本 1

get_ignore_output_transform
get_ignore_output_transform(surface: object<wl_surface>)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
destroy
类型: destructor
destroy()
销毁 tizen_screen_rotation

销毁 tizen_screen_rotation。

ignore_output_transform
ignore_output_transform(surface: object<wl_surface>, ignore: uint)
参数
类型
描述
surfaceobject<wl_surface>
the surface object
ignoreuint

tizen_renderer

版本 1

get_renderer_surface
get_renderer_surface(id: new_id<tizen_renderer_surface>, surface: object<wl_surface>)
参数
类型
描述
idnew_id<tizen_renderer_surface>
surfaceobject<wl_surface>
the surface object
destroy
类型: destructor
destroy()
销毁 tizen_renderer

销毁 tizen_renderer。

tizen_renderer_surface

版本 1

destroy
类型: destructor
destroy()
销毁 tizen_renderer_surface

销毁 tizen_renderer_surface。

合成器支持

未发现合成器支持

Footer

GitHub

© 2026 Wayland Explorer

本网站与 Wayland 官方项目无任何关联。网站所有内容均根据 Wayland 协议 XML 文件自动生成。

本网站使用的 Visual Studio Code - Codicons 遵循 CC BY 4.0 许可。