Tizen extension

tizen-extension

tizen_surface

version 1

get_tizen_resource(id: new_id<tizen_resource>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_resource>
surfaceobject<wl_surface>


destroy
Type: destructor
destroy()
resource_id(id: uint)
Argument
Type
Description
iduint

tizen_policy

version 4

get_visibility(id: new_id<tizen_visibility>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_visibility>
new visibility object
surfaceobject<wl_surface>
surface object
get_position(id: new_id<tizen_position>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_position>
new position object
surfaceobject<wl_surface>
surface object
activate(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
activate_below_by_res_id(res_id: uint, below_res_id: uint)
Argument
Type
Description
res_iduint
below_res_iduint
raise(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
lower(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
lower_by_res_id(res_id: uint)
Argument
Type
Description
res_iduint
set_focus_skip(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
unset_focus_skip(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
set_role(surface: object<wl_surface>, role: string)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
rolestring
set_type(surface: object<wl_surface>, win_type: uint)
Argument
Type
Description
surfaceobject<wl_surface>
win_typeuint
set_conformant(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
unset_conformant(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
get_conformant(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
set_notification_level(surface: object<wl_surface>, level: int)
Argument
Type
Description
surfaceobject<wl_surface>
levelint
set_transient_for(child_id: uint, parent_id: uint)
Argument
Type
Description
child_iduint
parent_iduint
unset_transient_for(child_id: uint)
Argument
Type
Description
child_iduint
set_window_screen_mode(surface: object<wl_surface>, mode: uint)
Argument
Type
Description
surfaceobject<wl_surface>
modeuint
place_subsurface_below_parent(subsurface: object<wl_subsurface>)
Argument
Type
Description
subsurfaceobject<wl_subsurface>
set_subsurface_stand_alone(subsurface: object<wl_subsurface>)
Argument
Type
Description
subsurfaceobject<wl_subsurface>
get_subsurface(id: new_id<wl_subsurface>, surface: object<wl_surface>, parent_id: uint)
Argument
Type
Description
idnew_id<wl_subsurface>
surfaceobject<wl_surface>
parent_iduint
set_opaque_state(surface: object<wl_surface>, state: int)
Argument
Type
Description
surfaceobject<wl_surface>
stateint
iconify(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
uniconify(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
add_aux_hint(surface: object<wl_surface>, id: int, name: string, value: string)
Argument
Type
Description
surfaceobject<wl_surface>
idint
namestring
valuestring
change_aux_hint(surface: object<wl_surface>, id: int, value: string)
Argument
Type
Description
surfaceobject<wl_surface>
idint
valuestring
del_aux_hint(surface: object<wl_surface>, id: int)
Argument
Type
Description
surfaceobject<wl_surface>
idint
get_supported_aux_hints(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
set_background_state(pid: uint)
Argument
Type
Description
piduint
unset_background_state(pid: uint)
Argument
Type
Description
piduint
set_floating_mode(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
unset_floating_mode(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
set_stack_mode(surface: object<wl_surface>, mode: uint)
Argument
Type
Description
surfaceobject<wl_surface>
modeuint
activate_above_by_res_id(res_id: uint, above_res_id: uint)
Argument
Type
Description
res_iduint
above_res_iduint
get_subsurface_watcher(id: new_id<tizen_subsurface_watcher>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_subsurface_watcher>
surfaceobject<wl_surface>
set_parent(child: object<wl_surface>, parent: object<wl_surface>)
Argument
Type
Description
childobject<wl_surface>
parentobject<wl_surface>
ack_conformant_region(surface: object<wl_surface>, serial: uint)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
serialuint
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.

conformant(surface: object<wl_surface>, is_conformant: uint)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
is_conformantuint
conformant_area(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
conformant_partuint
stateuint
xint
yint
wint
hint
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.

notification_done(surface: object<wl_surface>, level: int, error_state: uint)
Argument
Type
Description
surfaceobject<wl_surface>
levelint
error_stateuint
transient_for_done(child_id: uint)
Argument
Type
Description
child_iduint
window_screen_mode_done(surface: object<wl_surface>, mode: uint, error_state: uint)
Argument
Type
Description
surfaceobject<wl_surface>
modeuint
error_stateuint
iconify_state_changed(surface: object<wl_surface>, iconified: uint, force: uint)
Argument
Type
Description
surfaceobject<wl_surface>
iconifieduint
forceuint
supported_aux_hints(surface: object<wl_surface>, hints: array, num_hints: uint)
Argument
Type
Description
surfaceobject<wl_surface>
hintsarray
num_hintsuint
allowed_aux_hint(surface: object<wl_surface>, id: int)
Argument
Type
Description
surfaceobject<wl_surface>
idint
aux_message(surface: object<wl_surface>, key: string, value: string, options: array)
Argument
Type
Description
surfaceobject<wl_surface>
keystring
valuestring
optionsarray
conformant_region(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int, serial: uint)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
conformant_partuint
stateuint
xint
yint
wint
hint
serialuint
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.

error_state { none, permission_denied } 
Argument
Value
Description
none0
permission_denied1
level { 1, 2, 3, none, default, medium, high, top } 
Argument
Value
Description
10
21
32
none-1
default10
medium20
high30
top40
mode { default, always_on } 
Argument
Value
Description
default0
always_on1
stack_mode { none, above, below } 
Argument
Value
Description
none0
above1
below2


destroy
Type: destructor
destroy()
set(x: int, y: int)
Argument
Type
Description
xint
yint
changed(x: int, y: int)
Argument
Type
Description
xint
yint

tizen_gesture

version 1

grab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>)
Argument
Type
Description
fingersuint
edgeuint<tizen_gesture.edge>
ungrab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>)
Argument
Type
Description
fingersuint
edgeuint<tizen_gesture.edge>
grab_edge_swipe_notify(fingers: uint, edge: uint<tizen_gesture.edge>, error: uint)
Argument
Type
Description
fingersuint
edgeuint<tizen_gesture.edge>
erroruint
edge_swipe(mode: uint<tizen_gesture.mode>, fingers: uint, sx: int, sy: int, edge: uint<tizen_gesture.edge>)
Argument
Type
Description
modeuint<tizen_gesture.mode>
fingersuint
sxint
x coordinate of touch down point
syint
y coordinate of touch down point
edgeuint<tizen_gesture.edge>
type { edge_swipe } 
Argument
Value
Description
edge_swipe1
mode { begin, update, end, done } 
Argument
Value
Description
begin1
update2
end3
done4
edge { top, right, bottom, left } 
Argument
Value
Description
top1
right2
bottom4
left8

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.

set_keygrab(surface: object<wl_surface>, key: uint, mode: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
keyuint
modeuint
unset_keygrab(surface: object<wl_surface>, key: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
keyuint
get_keygrab_status(surface: object<wl_surface>, key: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
keyuint
set_keygrab_list(surface: object<wl_surface>, grab_list: array)
Argument
Type
Description
surfaceobject<wl_surface>allow null
grab_listarray
array of two integer variables pairs each pairs consist of keycode and keygrab mode
unset_keygrab_list(surface: object<wl_surface>, ungrab_list: array)
Argument
Type
Description
surfaceobject<wl_surface>allow null
ungrab_listarray
array of integer variables meaning keycode wanted to ungrab
get_keygrab_list(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>allow null
set_register_none_key(surface: object<wl_surface>, data: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
datauint
get_keyregister_status(data: uint)
Argument
Type
Description
datauint
set_input_config(surface: object<wl_surface>, config_mode: uint, value: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
config_modeuint
valueuint
keygrab_notify(surface: object<wl_surface>, key: uint, mode: uint, error: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
keyuint
modeuint
erroruint
keygrab_notify_list(surface: object<wl_surface>, grab_result: array)
Argument
Type
Description
surfaceobject<wl_surface>allow null
grab_resultarray
array of three integer variables pairs each pairs consist of keycode, keygrab mode and keygrab result
getgrab_notify_list(surface: object<wl_surface>, grab_result: array)
Argument
Type
Description
surfaceobject<wl_surface>allow null
grab_resultarray
array of two integer variables pairs each pairs consist of keycode, keygrab mode
set_register_none_key_notify(surface: object<wl_surface>, mode: uint)
Argument
Type
Description
surfaceobject<wl_surface>allow null
modeuint
keyregister_notify(status: uint)
Argument
Type
Description
statusuint
set_input_config_notify(status: uint)
Argument
Type
Description
statusuint
key_cancel(key: uint)
Argument
Type
Description
keyuint
Argument
Value
Description
none0
no error
invalid_surface1
Given surface is invalid.
invalid_key2
Given key is invalid.
invalid_mode3
Given mode is invalid.
grabbed_already4
The key has been grabbed already.
no_permission5
The wl client has no permission to grab the key.
no_system_resources6
System resources are insufficient.
invalid_array7
Given array has invalid pairs or data type.
Argument
Value
Description
none0
none
shared1
mode to get a key grab with the other client surfaces when the focused client surface gets the key
topmost2
mode to get a key grab when the client surface is the top most surface
overridable_exclusive3
mode to get a key grab exclusively, overridably regardless of the order in the surface stack
exclusive4
mode to get a key grab exclusively regardless of the order in surface stack
registered5
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.

Argument
Value
Description
none0
none
invisible_set1
mode to set window to enable send event to invisible window below in stack
invisible_get2
mode to set window to get event to invisible state if any top window has set register_set
num_key_focus3
mode to register for num keys for focus window
picture_off4
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.


Interface for tizen-screenshooter

Clients can get a screenmirror object from this interface.

get_screenmirror(id: new_id<tizen_screenmirror>, output: object<wl_output>)
Argument
Type
Description
idnew_id<tizen_screenmirror>
new screenmirror object
outputobject<wl_output>
output object for screenmirror
Create a screenmirror object

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

set_oneshot_auto_rotation(set: uint)
Argument
Type
Description
setuint
Set screen shot auto rotation value

Client can set auto rotation value for one shot.

format(format: uint)
Argument
Type
Description
formatuint
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.

screenshooter_notify(noti: uint)
Argument
Type
Description
notiuint
Send notification of screenshooter

Clients can get notification of screenshooter.


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.

destroy()
set_stretch(stretch: uint)
Argument
Type
Description
stretchuint
stretch type for screenmirror
queue(buffer: object<wl_buffer>)
Argument
Type
Description
bufferobject<wl_buffer>
buffer object for screenmirror
Queue a buffer
dequeue(buffer: object<wl_buffer>)
Argument
Type
Description
bufferobject<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.

dequeued(buffer: object<wl_buffer>)
Argument
Type
Description
bufferobject<wl_buffer>
dequeued buffer which contains a captured image
Dequeued event

occurs when drawing a captured image on a buffer is finished

content(content: uint)
Argument
Type
Description
contentuint
Content changed event

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

stop()
Stop event

occurs when the screenmirror is stopped eventually

content { normal, video } 
Argument
Value
Description
normal0
video1
stretch { keep_ratio, fully } 
Argument
Value
Description
keep_ratio0
fully1

tizen_video

version 1
Interface for tizen-video

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

get_object(id: new_id<tizen_video_object>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_video_object>
surfaceobject<wl_surface>
get_viewport(id: new_id<tizen_viewport>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<tizen_viewport>
surfaceobject<wl_surface>
format(format: uint)
Argument
Type
Description
formatuint
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.



destroy()
set_attribute(name: string, value: int)
Argument
Type
Description
namestring
valueint
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.

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.

attribute(name: string, value: uint)
Argument
Type
Description
namestring
valueuint
size(min_w: int, min_h: int, max_w: int, max_h: int, prefer_align: int)
Argument
Type
Description
min_wint
min_hint
max_wint
max_hint
prefer_alignint

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.

destroy
Type: destructor
destroy()
set_transform(transform: uint)
Argument
Type
Description
transformuint
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.

set_source(x: uint, y: uint, width: uint, height: uint)
Argument
Type
Description
xuint
yuint
widthuint
heightuint
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.

set_destination(x: int, y: int, width: uint, height: uint)
Argument
Type
Description
xint
yint
widthuint
heightuint
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.

set_destination_ratio(x: fixed, y: fixed, width: fixed, height: fixed)
Argument
Type
Description
xfixed
yfixed
widthfixed
heightfixed
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.

get_destination_mode(id: new_id<tizen_destination_mode>)
Argument
Type
Description
idnew_id<tizen_destination_mode>
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.

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.

destination_changed(transform: uint, x: int, y: int, width: uint, height: uint)
Argument
Type
Description
transformuint
xint
yint
widthuint
heightuint
parent_size(width: uint, height: uint)
Argument
Type
Description
widthuint
heightuint

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.

destroy()
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.

set_ratio(horizontal: fixed, vertical: fixed)
Argument
Type
Description
horizontalfixed
verticalfixed
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.

set_scale(horizontal: fixed, vertical: fixed)
Argument
Type
Description
horizontalfixed
verticalfixed
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.

set_align(horizontal: fixed, vertical: fixed)
Argument
Type
Description
horizontalfixed
verticalfixed
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.

set_offset(x: int, y: int, w: int, h: int)
Argument
Type
Description
xint
yint
wint
hint
error { invalid_type } 
Argument
Value
Description
invalid_type0

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.

get_socket()
Create new socket

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

socket(sock_fd: fd)
Argument
Type
Description
sock_fdfd
Socket fd

Sent immediately after get_socket request


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).

block_events(serial: uint, clas: uint<tizen_input_device_manager.clas>, duration: uint)
Argument
Type
Description
serialuint
clasuint<tizen_input_device_manager.clas>
durationuint
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.

unblock_events(serial: uint)
Argument
Type
Description
serialuint
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.

init_generator(clas: uint<tizen_input_device_manager.clas>)
Argument
Type
Description
clasuint<tizen_input_device_manager.clas>
Initialize input generator system
deinit_generator(clas: uint<tizen_input_device_manager.clas>)
Argument
Type
Description
clasuint<tizen_input_device_manager.clas>
Deinitialize input generator system
generate_key(keyname: string, pressed: uint)
Argument
Type
Description
keynamestring
presseduint
Generate a key event using specific or default device
generate_pointer(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, button: uint)
Argument
Type
Description
typeuint<tizen_input_device_manager.pointer_event_type>
xuint
yuint
buttonuint
Generate a pointer event using specific or default device
generate_touch(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, finger: uint)
Argument
Type
Description
typeuint<tizen_input_device_manager.pointer_event_type>
xuint
yuint
fingeruint
Generate a touch event using specific or default device
pointer_warp(surface: object<wl_surface>, x: fixed, y: fixed)
Argument
Type
Description
surfaceobject<wl_surface>
xfixed
yfixed
Warp pointer to the relative position to the given surface
device_add(serial: uint, identifier: string, device: new_id<tizen_input_device>, seat: object<wl_seat>)
Argument
Type
Description
serialuint
identifierstring
devicenew_id<tizen_input_device>
seatobject<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.

device_remove(serial: uint, identifier: string, device: object<tizen_input_device>, seat: object<wl_seat>)
Argument
Type
Description
serialuint
identifierstring
deviceobject<tizen_input_device>
seatobject<wl_seat>
Device removal 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.

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.

Argument
Value
Description
none0
none of class
mouse1
mouse class
keyboard2
keyboard class
touchscreen4
touchscreen class
Device class
Argument
Value
Description
none0
no error
no_permission1
no permission
invalid_class2
invalid class
blocked_already3
blocked already by the other client
no_system_resources4
no system resources such as memory lack
invalid_parameter5
argument is invalid
invalid_surface6
the given surface is not visible or pointer is not on the given surface
no_pointer_available7
there is no pointer available to warp
pointer_event_type { begin, update, end } 
Argument
Value
Description
begin0
update1
end2

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

select_axes(axes: array)
Argument
Type
Description
axesarray
array of axis num
Request for selecting some of axes among the axes supported by a tizen_input_device object
release()
Release the tizen_input_device object
device_info(name: string, clas: uint<tizen_input_device.clas>, subclas: uint<tizen_input_device.subclas>, axes: array)
Argument
Type
Description
namestring
clasuint<tizen_input_device.clas>
subclasuint<tizen_input_device.subclas>
axesarray
array of axis enum
Event contains device information
event_device(serial: uint, name: string, time: uint)
Argument
Type
Description
serialuint
namestring
timeuint
timestamp with millisecond granularity
Event indicates the source device associated with a wl_pointer/keyboard/touch event
Argument
Type
Description
axis_typeuint<tizen_input_device.axis_type>
valuefixed
axis value
Axis change event
Argument
Value
Description
none0
none of class
keyboard2
keyboard class
mouse3
mouse class
touchscreen4
touchscreen class
Device class
subclas { none } 
Argument
Value
Description
none0
none of subclass
Device subclass
Argument
Value
Description
none0
radius of x axis of an event area e.g. touching area with a finger or a pen
radius_x1
radius of x axis of an event area e.g. touching area with a finger or a pen
radius_y2
radius of y axis of an event area e.g. touching area with a finger or a pen
pressure3
pressure in an event area e.g. touching area with a finger or a pen
angle4
angle in an event area e.g. touching area with a finger or a pen
detent5
detent value e.g. moved distance with a rotary device
Axis type enums which can be supported by a device


create_img(id: new_id<tizen_launch_image>)
Argument
Type
Description
idnew_id<tizen_launch_image>
new tizen_launch_image object


destroy()
launch(file: string, file_type: uint, color_depth: uint, rotation: uint, indicator: uint, options: array)
Argument
Type
Description
filestring
file_typeuint
color_depthuint
rotationuint
indicatoruint
optionsarray
owner(pid: uint)
Argument
Type
Description
piduint
file_type { img, edj } 
Argument
Value
Description
img0
splash image file path
edj1
splash edj file path
indicator { off, on } 
Argument
Value
Description
off0
splash hide indicator
on1
splash show indicator
rotation { 0, 90, 180, 270 } 
Argument
Value
Description
00
rotation angle 0 degree
9090
rotation angle 90 degree
180180
rotation angle 180 degree
270270
rotation angle 270 degree

tizen_effect

version 1

destroy
Type: destructor
destroy()
start(surface: object<wl_surface>, type: uint)
Argument
Type
Description
surfaceobject<wl_surface>
typeuint
end(surface: object<wl_surface>, type: uint)
Argument
Type
Description
surfaceobject<wl_surface>
typeuint
type { none, show, hide, restack } 
Argument
Value
Description
none0
none
show1
show effect of window
hide2
hide effect of window
restack3
restack effect of window


set_window_brightness(surface: object<wl_surface>, brightness: int)
Argument
Type
Description
surfaceobject<wl_surface>
brightnessint
window_brightness_done(surface: object<wl_surface>, brightness: int, error_state: uint)
Argument
Type
Description
surfaceobject<wl_surface>
brightnessint
error_stateuint


destroy
Type: destructor
destroy()
set_state(surface: object<wl_surface>, state: int)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
stateint
set_opacity_mode(surface: object<wl_surface>, mode: int)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
modeint
set_visible_type(surface: object<wl_surface>, type: int)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
typeint
flick(surface: object<wl_surface>, type: int)
Argument
Type
Description
surfaceobject<wl_surface>
occur the flick event
typeint
state { unknown, off, on } 
Argument
Value
Description
unknown0
unknown
off1
can not show indicator
on2
can show indicator
Argument
Value
Description
unknown0
unknown
opaque1
opaque mode
translucent2
translucent mode
transparent3
transparent all mode
bg_transparent4
transparent only background mode
visible_type { hidden, shown } 
Argument
Value
Description
hidden0
hidden type indicator
shown1
shown type indicator

An interface for requests and event about clipboard

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

destroy
Type: destructor
destroy()
show(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
Request for show clipboard
hide(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
Request for hide clipboard
set_data_only(set: uint)
Argument
Type
Description
setuint
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.

data_selected(surface: object<wl_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
surface object
Announce data are selected by clipboard
allowed_data_only(allowed: uint)
Argument
Type
Description
alloweduint
Event to notify if data only set is allowed or not