Tizen extension

tizen-extension

tizen_surface

version 1

tizen_surface::get_tizen_resource

get_tizen_resource(id: new_id<tizen_resource>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_resource>
surface	object<wl_surface>

tizen_resource

version 1

tizen_resource::destroy

Type: destructor

destroy()

tizen_resource::resource_id

resource_id(id: uint)

Argument	Type	Description
id	uint

tizen_policy

version 4

tizen_policy::get_visibility

get_visibility(id: new_id<tizen_visibility>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_visibility>	new visibility object
surface	object<wl_surface>	surface object

tizen_policy::get_position

get_position(id: new_id<tizen_position>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_position>	new position object
surface	object<wl_surface>	surface object

tizen_policy::activate

activate(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::activate_below_by_res_id

activate_below_by_res_id(res_id: uint, below_res_id: uint)

Argument	Type	Description
res_id	uint
below_res_id	uint

tizen_policy::raise

raise(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::lower

lower(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::lower_by_res_id

lower_by_res_id(res_id: uint)

Argument	Type	Description
res_id	uint

tizen_policy::set_focus_skip

set_focus_skip(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::unset_focus_skip

unset_focus_skip(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::set_role

set_role(surface: object<wl_surface>, role: string)

Argument	Type	Description
surface	object<wl_surface>	surface object
role	string

tizen_policy::set_type

set_type(surface: object<wl_surface>, win_type: uint)

Argument	Type	Description
surface	object<wl_surface>
win_type	uint

tizen_policy::set_conformant

set_conformant(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::unset_conformant

unset_conformant(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::get_conformant

get_conformant(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::set_notification_level

set_notification_level(surface: object<wl_surface>, level: int)

Argument	Type	Description
surface	object<wl_surface>
level	int

tizen_policy::set_transient_for

set_transient_for(child_id: uint, parent_id: uint)

Argument	Type	Description
child_id	uint
parent_id	uint

tizen_policy::unset_transient_for

unset_transient_for(child_id: uint)

Argument	Type	Description
child_id	uint

tizen_policy::set_window_screen_mode

set_window_screen_mode(surface: object<wl_surface>, mode: uint)

Argument	Type	Description
surface	object<wl_surface>
mode	uint

tizen_policy::place_subsurface_below_parent

place_subsurface_below_parent(subsurface: object<wl_subsurface>)

Argument	Type	Description
subsurface	object<wl_subsurface>

tizen_policy::set_subsurface_stand_alone

set_subsurface_stand_alone(subsurface: object<wl_subsurface>)

Argument	Type	Description
subsurface	object<wl_subsurface>

tizen_policy::get_subsurface

get_subsurface(id: new_id<wl_subsurface>, surface: object<wl_surface>, parent_id: uint)

Argument	Type	Description
id	new_id<wl_subsurface>
surface	object<wl_surface>
parent_id	uint

tizen_policy::set_opaque_state

set_opaque_state(surface: object<wl_surface>, state: int)

Argument	Type	Description
surface	object<wl_surface>
state	int

tizen_policy::iconify

iconify(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::uniconify

uniconify(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::add_aux_hint

add_aux_hint(surface: object<wl_surface>, id: int, name: string, value: string)

Argument	Type	Description
surface	object<wl_surface>
id	int
name	string
value	string

tizen_policy::change_aux_hint

change_aux_hint(surface: object<wl_surface>, id: int, value: string)

Argument	Type	Description
surface	object<wl_surface>
id	int
value	string

tizen_policy::del_aux_hint

del_aux_hint(surface: object<wl_surface>, id: int)

Argument	Type	Description
surface	object<wl_surface>
id	int

tizen_policy::get_supported_aux_hints

get_supported_aux_hints(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>

tizen_policy::set_background_state

set_background_state(pid: uint)

Argument	Type	Description
pid	uint

tizen_policy::unset_background_state

unset_background_state(pid: uint)

Argument	Type	Description
pid	uint

tizen_policy::set_floating_mode

set_floating_mode(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::unset_floating_mode

unset_floating_mode(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

tizen_policy::set_stack_mode

set_stack_mode(surface: object<wl_surface>, mode: uint)

Argument	Type	Description
surface	object<wl_surface>
mode	uint

tizen_policy::activate_above_by_res_id

activate_above_by_res_id(res_id: uint, above_res_id: uint)

Argument	Type	Description
res_id	uint
above_res_id	uint

tizen_policy::get_subsurface_watcher

since 2

get_subsurface_watcher(id: new_id<tizen_subsurface_watcher>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_subsurface_watcher>
surface	object<wl_surface>

tizen_policy::set_parent

since 3

set_parent(child: object<wl_surface>, parent: object<wl_surface>)

Argument	Type	Description
child	object<wl_surface>
parent	object<wl_surface>

tizen_policy::ack_conformant_region

since 4

ack_conformant_region(surface: object<wl_surface>, serial: uint)

Argument	Type	Description
surface	object<wl_surface>	surface object
serial	uint

Ack for tizen_policy@conformant_region

A client can refresh its surface for applying new conformant region which is from tizen_policy@conformant_region event. The client has to ack after complete of its updates by this request.

tizen_policy::conformant

conformant(surface: object<wl_surface>, is_conformant: uint)

Argument	Type	Description
surface	object<wl_surface>	surface object
is_conformant	uint

tizen_policy::conformant_area

conformant_area(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int)

Argument	Type	Description
surface	object<wl_surface>	surface object
conformant_part	uint
state	uint
x	int
y	int
w	int
h	int

Notify of conformant area

Notify of conformant area to client. Sending this event does NOT guarantee perfect compositing of conformant owner client surface and conformant part client surface.

tizen_policy::notification_done

notification_done(surface: object<wl_surface>, level: int, error_state: uint)

Argument	Type	Description
surface	object<wl_surface>
level	int
error_state	uint

tizen_policy::transient_for_done

transient_for_done(child_id: uint)

Argument	Type	Description
child_id	uint

tizen_policy::window_screen_mode_done

window_screen_mode_done(surface: object<wl_surface>, mode: uint, error_state: uint)

Argument	Type	Description
surface	object<wl_surface>
mode	uint
error_state	uint

tizen_policy::iconify_state_changed

iconify_state_changed(surface: object<wl_surface>, iconified: uint, force: uint)

Argument	Type	Description
surface	object<wl_surface>
iconified	uint
force	uint

tizen_policy::supported_aux_hints

supported_aux_hints(surface: object<wl_surface>, hints: array, num_hints: uint)

Argument	Type	Description
surface	object<wl_surface>
hints	array
num_hints	uint

tizen_policy::allowed_aux_hint

allowed_aux_hint(surface: object<wl_surface>, id: int)

Argument	Type	Description
surface	object<wl_surface>
id	int

tizen_policy::aux_message

aux_message(surface: object<wl_surface>, key: string, value: string, options: array)

Argument	Type	Description
surface	object<wl_surface>
key	string
value	string
options	array

tizen_policy::conformant_region

since 4

conformant_region(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int, serial: uint)

Argument	Type	Description
surface	object<wl_surface>	surface object
conformant_part	uint
state	uint
x	int
y	int
w	int
h	int
serial	uint

Notify of geometry values of conformant region(area)

The server can notify of conformant region(area) using this event. If client is received this event, client should ack for it using tizen_policy@ack_conformant_region request.

tizen_policy::win_type

win_type { none, toplevel, fullscreen, maximized, transient, menu, dnd, custom, notification, utility, dialog, dock, splash }

Argument	Value	Description
none	0
toplevel	1
fullscreen	2
maximized	3
transient	4
menu	5
dnd	6
custom	7
notification	8
utility	9
dialog	10
dock	11
splash	12

tizen_policy::conformant_part

conformant_part { indicator, keyboard, clipboard }

Argument	Value	Description
indicator	0
keyboard	1
clipboard	2

tizen_policy::error_state

error_state { none, permission_denied }

Argument	Value	Description
none	0
permission_denied	1

tizen_policy::level

level { 1, 2, 3, none, default, medium, high, top }

Argument	Value	Description
1	0
2	1
3	2
none	-1
default	10
medium	20
high	30
top	40

tizen_policy::mode

mode { default, always_on }

Argument	Value	Description
default	0
always_on	1

tizen_policy::stack_mode

stack_mode { none, above, below }

Argument	Value	Description
none	0
above	1
below	2

tizen_visibility

version 1

tizen_visibility::destroy

Type: destructor

destroy()

tizen_visibility::notify

notify(visibility: uint)

Argument	Type	Description
visibility	uint

tizen_visibility::visibility

visibility { unobscured, partially_obscured, fully_obscured }

Argument	Value	Description
unobscured	0
partially_obscured	1
fully_obscured	2

tizen_position

version 1

tizen_position::destroy

Type: destructor

destroy()

tizen_position::set

set(x: int, y: int)

Argument	Type	Description
x	int
y	int

tizen_position::changed

changed(x: int, y: int)

Argument	Type	Description
x	int
y	int

tizen_gesture

version 1

tizen_gesture::grab_edge_swipe

grab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>)

Argument	Type	Description
fingers	uint
edge	uint<tizen_gesture.edge>

tizen_gesture::ungrab_edge_swipe

ungrab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>)

Argument	Type	Description
fingers	uint
edge	uint<tizen_gesture.edge>

tizen_gesture::grab_edge_swipe_notify

grab_edge_swipe_notify(fingers: uint, edge: uint<tizen_gesture.edge>, error: uint)

Argument	Type	Description
fingers	uint
edge	uint<tizen_gesture.edge>
error	uint

tizen_gesture::edge_swipe

edge_swipe(mode: uint<tizen_gesture.mode>, fingers: uint, sx: int, sy: int, edge: uint<tizen_gesture.edge>)

Argument	Type	Description
mode	uint<tizen_gesture.mode>
fingers	uint
sx	int	x coordinate of touch down point
sy	int	y coordinate of touch down point
edge	uint<tizen_gesture.edge>

tizen_gesture::error

error { none, invalid_data, no_permission, no_system_resources, grabbed_already }

Argument	Value	Description
none	0
invalid_data	1
no_permission	2
no_system_resources	3
grabbed_already	4

tizen_gesture::type

type { edge_swipe }

Argument	Value	Description
edge_swipe	1

tizen_gesture::mode

mode { begin, update, end, done }

Argument	Value	Description
begin	1
update	2
end	3
done	4

tizen_gesture::edge

edge { top, right, bottom, left }

Argument	Value	Description
top	1
right	2
bottom	4
left	8

tizen_keyrouter

version 1

An interface to set each focus for each key

In tradition, all the keys in a keyboard and a device on which some keys are attached will be sent to focus surface by default. Currently it's possible to set up each focus for each key in a keyboard and a device. Therefore, by setting a key grab for a surface, the owner of the surface will get the key event when it has the key grab for the key.

tizen_keyrouter::set_keygrab

set_keygrab(surface: object<wl_surface>, key: uint, mode: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
key	uint
mode	uint

tizen_keyrouter::unset_keygrab

unset_keygrab(surface: object<wl_surface>, key: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
key	uint

tizen_keyrouter::get_keygrab_status

get_keygrab_status(surface: object<wl_surface>, key: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
key	uint

tizen_keyrouter::set_keygrab_list

set_keygrab_list(surface: object<wl_surface>, grab_list: array)

Argument	Type	Description
surface	object<wl_surface>allow null
grab_list	array	array of two integer variables pairs each pairs consist of keycode and keygrab mode

tizen_keyrouter::unset_keygrab_list

unset_keygrab_list(surface: object<wl_surface>, ungrab_list: array)

Argument	Type	Description
surface	object<wl_surface>allow null
ungrab_list	array	array of integer variables meaning keycode wanted to ungrab

tizen_keyrouter::get_keygrab_list

get_keygrab_list(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>allow null

tizen_keyrouter::set_register_none_key

set_register_none_key(surface: object<wl_surface>, data: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
data	uint

tizen_keyrouter::get_keyregister_status

get_keyregister_status(data: uint)

Argument	Type	Description
data	uint

tizen_keyrouter::set_input_config

set_input_config(surface: object<wl_surface>, config_mode: uint, value: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
config_mode	uint
value	uint

tizen_keyrouter::keygrab_notify

keygrab_notify(surface: object<wl_surface>, key: uint, mode: uint, error: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
key	uint
mode	uint
error	uint

tizen_keyrouter::keygrab_notify_list

keygrab_notify_list(surface: object<wl_surface>, grab_result: array)

Argument	Type	Description
surface	object<wl_surface>allow null
grab_result	array	array of three integer variables pairs each pairs consist of keycode, keygrab mode and keygrab result

tizen_keyrouter::getgrab_notify_list

getgrab_notify_list(surface: object<wl_surface>, grab_result: array)

Argument	Type	Description
surface	object<wl_surface>allow null
grab_result	array	array of two integer variables pairs each pairs consist of keycode, keygrab mode

tizen_keyrouter::set_register_none_key_notify

set_register_none_key_notify(surface: object<wl_surface>, mode: uint)

Argument	Type	Description
surface	object<wl_surface>allow null
mode	uint

tizen_keyrouter::keyregister_notify

keyregister_notify(status: uint)

Argument	Type	Description
status	uint

tizen_keyrouter::set_input_config_notify

set_input_config_notify(status: uint)

Argument	Type	Description
status	uint

tizen_keyrouter::key_cancel

key_cancel(key: uint)

Argument	Type	Description
key	uint

tizen_keyrouter::error

error { none, invalid_surface, invalid_key, invalid_mode, grabbed_already, no_permission, no_system_resources, invalid_array }

Argument	Value	Description
none	0	no error
invalid_surface	1	Given surface is invalid.
invalid_key	2	Given key is invalid.
invalid_mode	3	Given mode is invalid.
grabbed_already	4	The key has been grabbed already.
no_permission	5	The wl client has no permission to grab the key.
no_system_resources	6	System resources are insufficient.
invalid_array	7	Given array has invalid pairs or data type.

tizen_keyrouter::mode

mode { none, shared, topmost, overridable_exclusive, exclusive, registered }

Argument	Value	Description
none	0	none
shared	1	mode to get a key grab with the other client surfaces when the focused client surface gets the key
topmost	2	mode to get a key grab when the client surface is the top most surface
overridable_exclusive	3	mode to get a key grab exclusively, overridably regardless of the order in the surface stack
exclusive	4	mode to get a key grab exclusively regardless of the order in surface stack
registered	5	mode to get a key grab only when a requesting surface is on top among the registering surfaces for the key

Mode for a key grab

This value is used to set a mode for a key grab. With this mode and the order of the surface between surfaces' stack, the compositor will determine the destination client surface.

tizen_keyrouter::config_mode

config_mode { none, invisible_set, invisible_get, num_key_focus, picture_off }

Argument	Value	Description
none	0	none
invisible_set	1	mode to set window to enable send event to invisible window below in stack
invisible_get	2	mode to set window to get event to invisible state if any top window has set register_set
num_key_focus	3	mode to register for num keys for focus window
picture_off	4	mode to set picture off for particular key

Mode for setting specific property for Key delivery

This value is used to set a mode for a window. With this mode and the order of the surface between surfaces' stack, the compositor will determine the destination client surface.

tizen_screenshooter

version 1

Interface for tizen-screenshooter

Clients can get a screenmirror object from this interface.

tizen_screenshooter::get_screenmirror

get_screenmirror(id: new_id<tizen_screenmirror>, output: object<wl_output>)

Argument	Type	Description
id	new_id<tizen_screenmirror>	new screenmirror object
output	object<wl_output>	output object for screenmirror

Create a screenmirror object

Before using screenmirror, a client should get a screenmirror object from display server.

tizen_screenshooter::set_oneshot_auto_rotation

set_oneshot_auto_rotation(set: uint)

Argument	Type	Description
set	uint

Set screen shot auto rotation value

Client can set auto rotation value for one shot.

tizen_screenshooter::format

format(format: uint)

Argument	Type	Description
format	uint

Supported format for screenshooter

The tbm format codes match the #defines in tbm_surface.h. The formats actually supported by the compositor will be reported by the format event.

tizen_screenshooter::screenshooter_notify

screenshooter_notify(noti: uint)

Argument	Type	Description
noti	uint

Send notification of screenshooter

Clients can get notification of screenshooter.

tizen_screenmirror

version 1

Interface for screenmirror

A client can use this interface to get stream images of screen. Before starting, queue all buffers. Then, start a screenmirror. After starting, a dequeued event will occur when drawing a captured image on a buffer is finished. You might need to queue the dequeued buffer again to get a new image from display server.

tizen_screenmirror::destroy

Type: destructor

destroy()

tizen_screenmirror::set_stretch

set_stretch(stretch: uint)

Argument	Type	Description
stretch	uint	stretch type for screenmirror

tizen_screenmirror::queue

queue(buffer: object<wl_buffer>)

Argument	Type	Description
buffer	object<wl_buffer>	buffer object for screenmirror

Queue a buffer

tizen_screenmirror::dequeue

dequeue(buffer: object<wl_buffer>)

Argument	Type	Description
buffer	object<wl_buffer>	buffer object for screenmirror

Dequeue a buffer

A user can dequeue a buffer from display server when he wants to take back it from server.

tizen_screenmirror::start

start()

tizen_screenmirror::stop

stop()

tizen_screenmirror::dequeued

dequeued(buffer: object<wl_buffer>)

Argument	Type	Description
buffer	object<wl_buffer>	dequeued buffer which contains a captured image

Dequeued event

occurs when drawing a captured image on a buffer is finished

tizen_screenmirror::content

content(content: uint)

Argument	Type	Description
content	uint

Content changed event

occurs when the content of a captured image is changed. (normal or video)

tizen_screenmirror::stop

stop()

Stop event

occurs when the screenmirror is stopped eventually

tizen_screenmirror::content

content { normal, video }

Argument	Value	Description
normal	0
video	1

tizen_screenmirror::stretch

stretch { keep_ratio, fully }

Argument	Value	Description
keep_ratio	0
fully	1

tizen_video

version 1

Interface for tizen-video

Clients can get the video information that the compositor can handle from this interface.

tizen_video::get_object

get_object(id: new_id<tizen_video_object>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_video_object>
surface	object<wl_surface>

tizen_video::get_viewport

get_viewport(id: new_id<tizen_viewport>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<tizen_viewport>
surface	object<wl_surface>

tizen_video::format

format(format: uint)

Argument	Type	Description
format	uint

Supported format for video

The tbm format codes match the #defines in tbm_surface.h. The formats actually supported by the compositor will be reported by the format event.

tizen_video::error

error { none, object_exists, viewport_exists }

Argument	Value	Description
none	0
object_exists	1
viewport_exists	2

tizen_video_object

version 1

tizen_video_object::destroy

Type: destructor

destroy()

tizen_video_object::set_attribute

set_attribute(name: string, value: int)

Argument	Type	Description
name	string
value	int

tizen_video_object::follow_topmost_visibility

follow_topmost_visibility()

Follow mute control change of a topmost surface

If tizen_video_object.follow_topmost_visibility is applied to a video_object, It will be video mute control based on topmost visibility.

tizen_video_object::unfollow_topmost_visibility

unfollow_topmost_visibility()

Unfollow mute control change of a topmost surface

If tizen_video_object.unfollow_topmost_visibility is applied to a video_object, It will not be video mute control based on topmost visibility.

tizen_video_object::attribute

attribute(name: string, value: uint)

Argument	Type	Description
name	string
value	uint

tizen_video_object::size

size(min_w: int, min_h: int, max_w: int, max_h: int, prefer_align: int)

Argument	Type	Description
min_w	int
min_h	int
max_w	int
max_h	int
prefer_align	int

tizen_subsurface_watcher

version 1

tizen_subsurface_watcher::message

message(value: uint)

Argument	Type	Description
value	uint

tizen_subsurface_watcher::msg

msg { success, parent_id_invalid, parent_id_destroyed }

Argument	Value	Description
success	0
parent_id_invalid	1
parent_id_destroyed	2

tizen_viewport

version 1

The viewport for a surface

This is the alternative and convenient solution of wl_viewport to present a surface on screen.

The below five functions can be replaced with this interface. The below functions will be ignored after applying this interface to a 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 is very complicated especially when the buffer of wl_surface is transformed by wl_surface.set_buffer_transform. And when the parent is resized, if we want to change the geometry of a subsurface also, wl_subsurface.set_position and wl_viewport.set_destination should be called everytime the parent is resized in client side. This makes difficult to synchronize a parent surface and a subsurface on screen.

tizen_viewport allows clients to set the relative geometry to a subsurface in a parent surface. Whenever a parent surface is resized, the geometry of a subsurface will be calculated, moved and resized automatically by a compositor. The tizen_viewport is specified in the coordinates of a subsurface's parent.

If tizen_viewport is applied to a shell surface(toplevel), the all value related with x, y pos of tizen_viewport and tizen_destination_mode interface will be ignored.

The below 3 functions don't consider the transform of a parent's surface. - tizen_viewport.set_source - tizen_viewport.set_destination - tizen_viewport.set_destination_ratio

Furthermore, tizen_destination_mode.follow_parent_transform is called, tizen_viewport will consider the transform of a parent surface when applying the destination mode to a subsurface. If tizen_destination_mode.follow_parent_transform is applied to a shell surface, it will be ignored.

The destination will be cropped by a parent surface.

The change will be applied when wl_surface.commit is called.

tizen_viewport::destroy

Type: destructor

destroy()

tizen_viewport::set_transform

set_transform(transform: uint)

Argument	Type	Description
transform	uint

Set the transform of a surface

The accepted values for the transform parameter are the values for wl_output.transform according to the output transform.

The tizen_viewport.set_transform is applied only to itself. Basically it doesn't effect the transform of its subsurfaces. That is, if 90 transform is setted and its subsurface still has 0 transform, its subsurface won't be rotated.

If needed to rotate the subsurface depended on a parent surface, tizen_destination_mode.follow_parent_transform will make it possible.

tizen_viewport::set_source

set_source(x: uint, y: uint, width: uint, height: uint)

Argument	Type	Description
x	uint
y	uint
width	uint
height	uint

Set the source rectalge of a wl_buffer

The source rectangle won't be changed when a parent is resized. If it needs to be changed, tizen_viewport.set_source should be called with new values.

tizen_viewport::set_destination

set_destination(x: int, y: int, width: uint, height: uint)

Argument	Type	Description
x	int
y	int
width	uint
height	uint

Set the destination geometry of a surface

The destination geometry won't be changed when a parent is resized. If it needs to be changed, tizen_viewport.set_destination should be called with new values.

If tizen_viewport is applied to a shell surface(toplevel), the x, y value of tizen_viewport.set_destination will be ignored.

tizen_viewport::set_destination_ratio

set_destination_ratio(x: fixed, y: fixed, width: fixed, height: fixed)

Argument	Type	Description
x	fixed
y	fixed
width	fixed
height	fixed

Set the ratio destination rectalge in a parent surface

The destination rectangle of a subsurface will be automatically changed when a parent is resized. This allows the real number between 0.0 and 1.0. See wl_fixed_from_double and wl_fixed_to_double.

If tizen_viewport is applied to a shell surface(toplevel), the x, y value of tizen_viewport.set_destination_ratio will be ignored.

tizen_viewport::get_destination_mode

get_destination_mode(id: new_id<tizen_destination_mode>)

Argument	Type	Description
id	new_id<tizen_destination_mode>

tizen_viewport::query_parent_size

since 1

query_parent_size()

Set the ratio destination rectalge in a parent surface

A client can asks the display server to send the size of tizen_viewport object's parent surface. Once a client requests it, the "parent_size" event will be sent whenever the parent surface's size is changed.

tizen_viewport::follow_parent_transform

follow_parent_transform()

Follow the transform change of a parent surface

The real transform of a subsurface is (parent's transform + subsurface's transform). The subsurface will be rotated automatically when the parent is rotated.

If tizen_viewport.follow_parent_transform is applied to a shell surface(toplevel), it will be ignored.

tizen_viewport::unfollow_parent_transform

unfollow_parent_transform()

tizen_viewport::destination_changed

destination_changed(transform: uint, x: int, y: int, width: uint, height: uint)

Argument	Type	Description
transform	uint
x	int
y	int
width	uint
height	uint

tizen_viewport::parent_size

parent_size(width: uint, height: uint)

Argument	Type	Description
width	uint
height	uint

tizen_destination_mode

version 1

The destination mode for a surface

The destination rectangle will be automatically changed when a parent is resized. When tizen_destination_mode.set is called, the value of tizen_viewport.set_destination and tizen_viewport.set_destination_ratio will be ignored.

The destination of a surface is decided by the mode, ratio, scale, offset and align values. The ratio, scale, offset and align will be applied sequentially.

The change will be applied when wl_surface.commit is called.

tizen_destination_mode::destroy

Type: destructor

destroy()

tizen_destination_mode::follow_parent_transform

follow_parent_transform()

Follow the transform change of a parent surface

The real transform of a subsurface is (parent's transform + subsurface's transform). That is, the subsurface will be rotated automatically when the parent is rotated.

If tizen_destination_mode.follow_parent_transform is applied to a shell surface(toplevel), it will be ignored.

tizen_destination_mode::unfollow_parent_transform

unfollow_parent_transform()

tizen_destination_mode::set

set(mode: uint<tizen_destination_mode.type>)

Argument	Type	Description
mode	uint<tizen_destination_mode.type>

tizen_destination_mode::set_ratio

set_ratio(horizontal: fixed, vertical: fixed)

Argument	Type	Description
horizontal	fixed
vertical	fixed

Set the ratio of the destination rectangle of a subsurface

This allows the real number. See wl_fixed_from_double and wl_fixed_to_double.

tizen_destination_mode::set_scale

set_scale(horizontal: fixed, vertical: fixed)

Argument	Type	Description
horizontal	fixed
vertical	fixed

Set the scale of the destination rectangle of a subsurface

This allows the real number. See wl_fixed_from_double and wl_fixed_to_double.

tizen_destination_mode::set_align

set_align(horizontal: fixed, vertical: fixed)

Argument	Type	Description
horizontal	fixed
vertical	fixed

Set the align of the destination rectangle of a subsurface

This allows the real number between 0.0 and 1.0. See wl_fixed_from_double and wl_fixed_to_double.

tizen_destination_mode::set_offset

set_offset(x: int, y: int, w: int, h: int)

Argument	Type	Description
x	int
y	int
w	int
h	int

tizen_destination_mode::error

error { invalid_type }

Argument	Value	Description
invalid_type	0

tizen_destination_mode::type

type { none, letter_box, origin, full, cropped_full, origin_or_letter }

Argument	Value	Description
none	0
letter_box	1
origin	2
full	3
cropped_full	4
origin_or_letter	5

tizen_embedded_compositor

version 1

Global embedded compositor object

The global obejct. Wayland has 3 type of compositor, embedded compositor is one of them. But tizen application is sendboxing by smack, then a application not allow commutication to other application by socket. So system or session compositor create socket and send to embedded compostior.

tizen_embedded_compositor::get_socket

get_socket()

Create new socket

The get_socket request ask the server to create socket and emit socket event.

tizen_embedded_compositor::socket

socket(sock_fd: fd)

Argument	Type	Description
sock_fd	fd

Socket fd

Sent immediately after get_socket request

tizen_input_device_manager

version 1

Global input device manager object

Tizen input device manager is a global interface. This object has device add/remove events to provide tizen input device object to a client. This allows for a client to get the con

Be sure to bind this interface after binding wl_seat interface. Tizen input device manager interface will only provide device add/remove event for devices which belongs to the wl_seat object(s) bound by the client. Therefore, the compositor needs to create/send the device add/remove event only for the current client's seat(s).

tizen_input_device_manager::block_events

block_events(serial: uint, clas: uint<tizen_input_device_manager.clas>, duration: uint)

Argument	Type	Description
serial	uint
clas	uint<tizen_input_device_manager.clas>
duration	uint	time duration with millisecond granularity

Request to block sending event(s)

This request allows a client to request to block one or more events for its purpose. By specifying class as an argument in the request, the events belongs to the class will be blocked during the given duration. Note that an error event will be sent if there is any error.

tizen_input_device_manager::unblock_events

unblock_events(serial: uint)

Argument	Type	Description
serial	uint

Request to unblock sending event(s)

This request allows a client to request to release the existing block for the client. Note that no error event will be sent if there is no existing block for the client.

tizen_input_device_manager::init_generator

init_generator(clas: uint<tizen_input_device_manager.clas>)

Argument	Type	Description
clas	uint<tizen_input_device_manager.clas>

Initialize input generator system

tizen_input_device_manager::deinit_generator

deinit_generator(clas: uint<tizen_input_device_manager.clas>)

Argument	Type	Description
clas	uint<tizen_input_device_manager.clas>

Deinitialize input generator system

tizen_input_device_manager::generate_key

generate_key(keyname: string, pressed: uint)

Argument	Type	Description
keyname	string
pressed	uint

Generate a key event using specific or default device

tizen_input_device_manager::generate_pointer

generate_pointer(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, button: uint)

Argument	Type	Description
type	uint<tizen_input_device_manager.pointer_event_type>
x	uint
y	uint
button	uint

Generate a pointer event using specific or default device

tizen_input_device_manager::generate_touch

generate_touch(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, finger: uint)

Argument	Type	Description
type	uint<tizen_input_device_manager.pointer_event_type>
x	uint
y	uint
finger	uint

Generate a touch event using specific or default device

tizen_input_device_manager::pointer_warp

pointer_warp(surface: object<wl_surface>, x: fixed, y: fixed)

Argument	Type	Description
surface	object<wl_surface>
x	fixed
y	fixed

Warp pointer to the relative position to the given surface

tizen_input_device_manager::device_add

device_add(serial: uint, identifier: string, device: new_id<tizen_input_device>, seat: object<wl_seat>)

Argument	Type	Description
serial	uint
identifier	string
device	new_id<tizen_input_device>
seat	object<wl_seat>

Device addition event

The device add/remove notification is going to be sent when a physical/logical device is added/removed to/from the given seat. Note that a tizen input device object can be assigned to a wl_seat and can also be assigned to the other wl_seat at any time. Whenever a relationship between a tizen input device object changes, device remove event from the current wl_seat object will be made and device add event to the other wl_seat object will also be mode.

tizen_input_device_manager::device_remove

device_remove(serial: uint, identifier: string, device: object<tizen_input_device>, seat: object<wl_seat>)

Argument	Type	Description
serial	uint
identifier	string
device	object<tizen_input_device>
seat	object<wl_seat>

Device removal event

tizen_input_device_manager::error

error(errorcode: uint<tizen_input_device_manager.error>)

Argument	Type	Description
errorcode	uint<tizen_input_device_manager.error>

Error event

tizen_input_device_manager::block_expired

block_expired()

Block expiration event

This event will be sent if the duration of existing block is expired. Note that no block expired event will be sent if there is no block for the client.

tizen_input_device_manager::clas

clas { none, mouse, keyboard, touchscreen }

Argument	Value	Description
none	0	none of class
mouse	1	mouse class
keyboard	2	keyboard class
touchscreen	4	touchscreen class

Device class

tizen_input_device_manager::error

error { none, no_permission, invalid_class, blocked_already, no_system_resources, invalid_parameter, invalid_surface, no_pointer_available }

Argument	Value	Description
none	0	no error
no_permission	1	no permission
invalid_class	2	invalid class
blocked_already	3	blocked already by the other client
no_system_resources	4	no system resources such as memory lack
invalid_parameter	5	argument is invalid
invalid_surface	6	the given surface is not visible or pointer is not on the given surface
no_pointer_available	7	there is no pointer available to warp

tizen_input_device_manager::pointer_event_type

pointer_event_type { begin, update, end }

Argument	Value	Description
begin	0
update	1
end	2

tizen_input_device

version 1

Tizen input device object

The tizen_input_device interface represents one or more input devices associated with a physical/logical input device. This interface provides device specific information/events to allows for client to identify the source device of an event or to get the additional axes/attributes of a device. Note that a tizen_input_device object can be used for a physical input device and can also be used for a group of input devices. e.g. a group of mouse devices

tizen_input_device::select_axes

select_axes(axes: array)

Argument	Type	Description
axes	array	array of axis num

Request for selecting some of axes among the axes supported by a tizen_input_device object

tizen_input_device::release

Type: destructor

release()

Release the tizen_input_device object

tizen_input_device::device_info

device_info(name: string, clas: uint<tizen_input_device.clas>, subclas: uint<tizen_input_device.subclas>, axes: array)

Argument	Type	Description
name	string
clas	uint<tizen_input_device.clas>
subclas	uint<tizen_input_device.subclas>
axes	array	array of axis enum

Event contains device information

tizen_input_device::event_device

event_device(serial: uint, name: string, time: uint)

Argument	Type	Description
serial	uint
name	string
time	uint	timestamp with millisecond granularity

Event indicates the source device associated with a wl_pointer/keyboard/touch event

tizen_input_device::axis

axis(axis_type: uint<tizen_input_device.axis_type>, value: fixed)

Argument	Type	Description
axis_type	uint<tizen_input_device.axis_type>
value	fixed	axis value

Axis change event

tizen_input_device::clas

clas { none, keyboard, mouse, touchscreen }

Argument	Value	Description
none	0	none of class
keyboard	2	keyboard class
mouse	3	mouse class
touchscreen	4	touchscreen class

Device class

tizen_input_device::subclas

subclas { none }

Argument	Value	Description
none	0	none of subclass

Device subclass

tizen_input_device::axis_type

axis_type { none, radius_x, radius_y, pressure, angle, detent }

Argument	Value	Description
none	0	radius of x axis of an event area e.g. touching area with a finger or a pen
radius_x	1	radius of x axis of an event area e.g. touching area with a finger or a pen
radius_y	2	radius of y axis of an event area e.g. touching area with a finger or a pen
pressure	3	pressure in an event area e.g. touching area with a finger or a pen
angle	4	angle in an event area e.g. touching area with a finger or a pen
detent	5	detent value e.g. moved distance with a rotary device

Axis type enums which can be supported by a device

tizen_launchscreen

version 1

tizen_launchscreen::create_img

create_img(id: new_id<tizen_launch_image>)

Argument	Type	Description
id	new_id<tizen_launch_image>	new tizen_launch_image object

tizen_launch_image

version 1

tizen_launch_image::destroy

Type: destructor

destroy()

tizen_launch_image::launch

launch(file: string, file_type: uint, color_depth: uint, rotation: uint, indicator: uint, options: array)

Argument	Type	Description
file	string
file_type	uint
color_depth	uint
rotation	uint
indicator	uint
options	array

tizen_launch_image::owner

owner(pid: uint)

Argument	Type	Description
pid	uint

tizen_launch_image::show

show()

tizen_launch_image::hide

hide()

tizen_launch_image::file_type

file_type { img, edj }

Argument	Value	Description
img	0	splash image file path
edj	1	splash edj file path

tizen_launch_image::indicator

indicator { off, on }

Argument	Value	Description
off	0	splash hide indicator
on	1	splash show indicator

tizen_launch_image::rotation

rotation { 0, 90, 180, 270 }

Argument	Value	Description
0	0	rotation angle 0 degree
90	90	rotation angle 90 degree
180	180	rotation angle 180 degree
270	270	rotation angle 270 degree

tizen_effect

version 1

tizen_effect::destroy

Type: destructor

destroy()

tizen_effect::start

start(surface: object<wl_surface>, type: uint)

Argument	Type	Description
surface	object<wl_surface>
type	uint

tizen_effect::end

end(surface: object<wl_surface>, type: uint)

Argument	Type	Description
surface	object<wl_surface>
type	uint

tizen_effect::type

type { none, show, hide, restack }

Argument	Value	Description
none	0	none
show	1	show effect of window
hide	2	hide effect of window
restack	3	restack effect of window

tizen_display_policy

version 1

tizen_display_policy::set_window_brightness

set_window_brightness(surface: object<wl_surface>, brightness: int)

Argument	Type	Description
surface	object<wl_surface>
brightness	int

tizen_display_policy::window_brightness_done

window_brightness_done(surface: object<wl_surface>, brightness: int, error_state: uint)

Argument	Type	Description
surface	object<wl_surface>
brightness	int
error_state	uint

tizen_display_policy::error_state

error_state { none, permission_denied }

Argument	Value	Description
none	0
permission_denied	1

tizen_indicator

version 1

tizen_indicator::destroy

Type: destructor

destroy()

tizen_indicator::set_state

set_state(surface: object<wl_surface>, state: int)

Argument	Type	Description
surface	object<wl_surface>	surface object
state	int

tizen_indicator::set_opacity_mode

set_opacity_mode(surface: object<wl_surface>, mode: int)

Argument	Type	Description
surface	object<wl_surface>	surface object
mode	int

tizen_indicator::set_visible_type

set_visible_type(surface: object<wl_surface>, type: int)

Argument	Type	Description
surface	object<wl_surface>	surface object
type	int

tizen_indicator::flick

flick(surface: object<wl_surface>, type: int)

Argument	Type	Description
surface	object<wl_surface>	occur the flick event
type	int

tizen_indicator::state

state { unknown, off, on }

Argument	Value	Description
unknown	0	unknown
off	1	can not show indicator
on	2	can show indicator

tizen_indicator::opacity_mode

opacity_mode { unknown, opaque, translucent, transparent, bg_transparent }

Argument	Value	Description
unknown	0	unknown
opaque	1	opaque mode
translucent	2	translucent mode
transparent	3	transparent all mode
bg_transparent	4	transparent only background mode

tizen_indicator::visible_type

visible_type { hidden, shown }

Argument	Value	Description
hidden	0	hidden type indicator
shown	1	shown type indicator

tizen_clipboard

version 2

An interface for requests and event about clipboard

This interface provides some requests and events about clipboard for other clients.

tizen_clipboard::destroy

Type: destructor

destroy()

tizen_clipboard::show

show(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

Request for show clipboard

tizen_clipboard::hide

hide(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

Request for hide clipboard

tizen_clipboard::set_data_only

since 2

set_data_only(set: uint)

Argument	Type	Description
set	uint

Request for setting data only mode for this wl_client

A wayland client can notify of that the client is data only mode. The data only mode means that this wayland client doesn't have any wl_surfaces at all but it wants to use wl_data_device for some data operations.

tizen_clipboard::data_selected

data_selected(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>	surface object

Announce data are selected by clipboard

tizen_clipboard::allowed_data_only

since 2

allowed_data_only(allowed: uint)

Argument	Type	Description
allowed	uint

Event to notify if data only set is allowed or not

Compositor Support

No compositor support found