2 * Copyright (c) 2011-2015 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef __TIZEN_UI_EFL_UTIL_H__
18 #define __TIZEN_UI_EFL_UTIL_H__
22 #include <tbm_surface.h>
31 # define API __attribute__ ((visibility("default")))
41 * @addtogroup CAPI_EFL_UTIL_MODULE
46 * @brief Enumeration for EFL UTIL ERROR.
47 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
51 EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
52 EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
53 EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
54 EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
55 EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: $TZ_CFG_VER_24_OR_30$) */
56 EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: $TZ_CFG_VER_24_OR_30$) */
57 EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: $TZ_CFG_VER_24_OR_30$) */
58 EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01, /**< Window type not supported */
59 EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL = TIZEN_ERROR_EFL_UTIL | 0x02, /**< @platform Screenshot initialization fail (@b Since: $TZ_CFG_VER_24_OR_30$) */
60 EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03 /**< @platform Screenshot execution fail (@b Since: $TZ_CFG_VER_24_OR_30$) */
64 * @brief Enumeration of notification window's priority level.
65 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
69 EFL_UTIL_NOTIFICATION_LEVEL_1, /**< Default notification level. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT instead.) */
70 EFL_UTIL_NOTIFICATION_LEVEL_2, /**< Higher notification level than default. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM instead.) */
71 EFL_UTIL_NOTIFICATION_LEVEL_3, /**< The highest notification level. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_TOP instead.) */
72 EFL_UTIL_NOTIFICATION_LEVEL_NONE = -1, /**< No (reset) notification level. This value makes the window place in normal layer. (@b Since: $TZ_CFG_VER_24_OR_30$) */
73 EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: $TZ_CFG_VER_24_OR_30$) */
74 EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM = 20, /**< Higher notification level than default. (@b Since: $TZ_CFG_VER_24_OR_30$) */
75 EFL_UTIL_NOTIFICATION_LEVEL_HIGH = 30, /**< Higher notification level than medium. (@b Since: $TZ_CFG_VER_24_OR_30$) */
76 EFL_UTIL_NOTIFICATION_LEVEL_TOP = 40 /**< The highest notification level. (@b Since: $TZ_CFG_VER_24_OR_30$) */
77 } efl_util_notification_level_e;
80 * @brief Enumeration of screen mode.
81 * @since_tizen $TZ_CFG_VER_24_OR_30$
85 EFL_UTIL_SCREEN_MODE_DEFAULT, /**< The mode which turns the screen off after a timeout. */
86 EFL_UTIL_SCREEN_MODE_ALWAYS_ON, /**< The mode which keeps the screen turned on. */
87 } efl_util_screen_mode_e;
90 * @brief Sets the priority level for the specified notification window.
91 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
93 * @privilege %http://tizen.org/privilege/window.priority.set
94 * @remarks This API can be used for a notification type window only.
95 * Up to the version $TZ_CFG_VER_24_OR_231$, it supports as async APIs.
96 * But it is synchronous call since Tizen 3.0
97 * @param[in] window The EFL window
98 * @param[in] level The notification window level
99 * @return @c 0 on success, otherwise a negative error value
100 * @retval #EFL_UTIL_ERROR_NONE Successful
101 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
102 * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
103 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
105 API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_notification_level_e level);
108 * @brief Gets the priority level for the specified notification window.
109 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
111 * @remarks This API can be used for a notification type window only.
112 * Up to the version $TZ_CFG_VER_24_OR_231$, it supports as async APIs.
113 * But it is synchronous call since Tizen 3.0
114 * @param[in] window The EFL window
115 * @param[out] level The notification window level
116 * @return @c 0 on success, otherwise a negative error value
117 * @retval #EFL_UTIL_ERROR_NONE Successful
118 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
119 * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
121 API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_notification_level_e *level);
124 * @deprecated Deprecated since 3.0.
125 * @brief Called when an error occurs for setting notification window level
126 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
127 * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
128 * @param[in] window The EFL window
129 * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
130 * @param[in] user_data The user data passed from the callback registration function
131 * @see efl_util_set_notification_window_level_error_cb()
132 * @see efl_util_unset_notification_window_level_error_cb()
134 typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data);
137 * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_notification_window_level() instead.
138 * @brief Registers a callback function to be invoked when an error which set the notification level occurs.
139 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
140 * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
141 * @param[in] window The EFL window
142 * @param[in] callback The callback function to register
143 * @param[in] user_data The user data to be passed to the callback function
144 * @return @c 0 on success, otherwise a negative error value
145 * @retval #EFL_UTIL_ERROR_NONE Successful
146 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
147 * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
148 * @post efl_util_notification_window_level_error_cb() will be invoked.
149 * @see efl_util_unset_notification_window_level_error_cb()
150 * @see efl_util_notification_window_level_error_cb()
152 API int efl_util_set_notification_window_level_error_cb(Evas_Object *window, efl_util_notification_window_level_error_cb callback, void *user_data) TIZEN_DEPRECATED_API;
155 * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_notification_window_level() instead.
156 * @brief Unregisters the callback function.
157 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
158 * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
159 * @param[in] window The EFL window
160 * @return @c 0 on success, otherwise a negative error value
161 * @retval #EFL_UTIL_ERROR_NONE Successful
162 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
163 * @see efl_util_set_notification_window_level_error_cb()
165 API int efl_util_unset_notification_window_level_error_cb(Evas_Object *window) TIZEN_DEPRECATED_API;
168 * @brief Sets the alpha window's visual state to opaque state
169 * @details This API sets the alpha window's visual state to opaque state.
170 * If the alpha window sets the visual state to the opaque,
171 * then the window manager could handle it as the opaque window while calculating visibility.
172 * This API will have no effect when used by a non-alpha window.
173 * @since_tizen $TZ_CFG_VER_24_OR_30$
174 * @param[in] window The EFL window
175 * @param[in] opaque The value that indicates whether the window has set a visual state to opaque (0: unset, 1: set)
176 * @return @c 0 on success, otherwise a negative error value
177 * @retval #EFL_UTIL_ERROR_NONE Successful
178 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
180 API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
183 * @brief Sets the window's screen mode.
184 * @details This API is useful when the application need to keep the display turned on.
185 * If the application set the mode to #EFL_UTIL_SCREEN_MODE_ALWAYS_ON to its window and the window is shown wholly or partially,
186 * the window manager requests the display system to keep the display on as long as the window is shown.
187 * If the window is no longer shown, then the window manger request the display system to go back to normal operation.
188 * Default screen mode of window is #EFL_UTIL_SCREEN_MODE_DEFAULT.
189 * @since_tizen $TZ_CFG_VER_24_OR_30$
191 * @privilege %http://tizen.org/privilege/display
192 * @remarks This API needs the privilege.
193 * If the application which is not get the privilege use this API, the window manager generates the permission deny error.
195 * The application can notice this error if it set the callback function using the efl_util_set_window_screen_mode_error_cb().
197 * @param[in] window The EFL window
198 * @param[in] mode The screen mode
199 * @return @c 0 on success, otherwise a negative error value
200 * @retval #EFL_UTIL_ERROR_NONE Successful
201 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
202 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
204 API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
207 * @brief Gets the screen mode of the specified window.
208 * @since_tizen $TZ_CFG_VER_24_OR_30$
209 * @param[in] window The EFL window
210 * @param[out] mode The screen mode
211 * @return @c 0 on success, otherwise a negative error value
212 * @retval #EFL_UTIL_ERROR_NONE Successful
213 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
215 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
219 * @deprecated Deprecated since 3.0.
220 * @brief Called when an error occurs for setting window's screen mode
222 * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
223 * @param[in] window The EFL window
224 * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
225 * @param[in] user_data The user data passed from the callback registration function
226 * @see efl_util_set_window_screen_mode_error_cb()
227 * @see efl_util_unset_window_screen_mode_error_cb()
229 typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int error_code, void *user_data);
232 * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_window_screen_mode() instead.
233 * @brief Registers a callback function to be invoked when an error which set the screen mode.
235 * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
236 * @param[in] window The EFL window
237 * @param[in] callback The callback function to register
238 * @param[in] user_data The user data to be passed to the callback function
239 * @return @c 0 on success, otherwise a negative error value
240 * @retval #EFL_UTIL_ERROR_NONE Successful
241 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
242 * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
243 * @post efl_util_window_screen_mode_error_cb() will be invoked.
244 * @see efl_util_unset_window_screen_mode_error_cb()
245 * @see efl_util_window_screen_mode_error_cb()
247 API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_window_screen_mode_error_cb callback, void *user_data) TIZEN_DEPRECATED_API;
250 * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_window_screen_mode() instead.
251 * @brief Unregisters the callback function.
253 * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
254 * @param[in] window The EFL window
255 * @return @c 0 on success, otherwise a negative error value
256 * @retval #EFL_UTIL_ERROR_NONE Successful
257 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
258 * @see efl_util_set_window_screen_mode_error_cb()
260 API int efl_util_unset_window_screen_mode_error_cb(Evas_Object *window) TIZEN_DEPRECATED_API;
264 * @brief Sets the user's preferred brightness of the specified window.
265 * @details This API is useful when the application need to change the brightness of the screen when it is appeared on the screen.
266 * If the application sets the brightness 0 to 100 to its window and the application window is shown wholly or partially,
267 * the window manager requests the display system to change the brightness of the screen using user's preferred brightness.
268 * If the window is no longer shown, then the window manger request the display system to go back to default brightness.
269 * If the brightness is less than 0, this means to use the default screen brightness.
272 * @privilege %http://tizen.org/privilege/display
273 * @remarks This API needs the privilege.
274 * If the application which is not get the privilege use this API, the window manager generates the permission deny error.
275 * @param[in] window The EFL window
276 * @param[in] brightness The preferred brightness
277 * @return @c 0 on success, otherwise a negative error value
278 * @retval #EFL_UTIL_ERROR_NONE Successful
279 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
280 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
281 * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
282 * @see efl_util_get_window_brightness()
284 API int efl_util_set_window_brightness(Evas_Object *window, int brightness);
287 * @brief Gets the user's preferred brightness of the specified window.
289 * @param[in] window The EFL window
290 * @param[out] brightness The preferred brightness
291 * @return @c 0 on success, otherwise a negative error value
292 * @retval #EFL_UTIL_ERROR_NONE Successful
293 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
294 * @see efl_util_set_window_brightness()
296 API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
304 * @addtogroup CAPI_EFL_UTIL_INPUT_MODULE
310 * @brief Definition for the input generator handle.
311 * @since_tizen $TZ_CFG_VER_24_OR_30$
314 typedef struct _efl_util_inputgen_h * efl_util_inputgen_h;
318 * @brief Enumeration of device type generated events.
319 * @since_tizen $TZ_CFG_VER_24_OR_30$
323 EFL_UTIL_INPUT_DEVTYPE_NONE = 0x0, /**< (Deprecated since 3.0.) */
324 EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN = (1 << 0), /**< Touch Screen device */
325 EFL_UTIL_INPUT_DEVTYPE_KEYBOARD = (1 << 1), /**< Keyboard device */
326 EFL_UTIL_INPUT_DEVTYPE_POINTER = (1 << 2), /**< Mouse device (Since 3.0) */
327 EFL_UTIL_INPUT_DEVTYPE_ALL = EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN |
328 EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, /**< Both of touch screen and keyboard device (Deprecated since 3.0. Check all enumerations using OR operand instead) */
329 EFL_UTIL_INPUT_DEVTYPE_MAX = (1 << 10) /**< (Deprecated since 3.0.) */
330 } efl_util_input_device_type_e;
334 * @brief Enumeration of touch event types.
335 * @since_tizen $TZ_CFG_VER_24_OR_30$
339 EFL_UTIL_INPUT_TOUCH_NONE, /**< (Deprecated since 3.0.) */
340 EFL_UTIL_INPUT_TOUCH_BEGIN, /**< Finger press. It is same a behavior put your finger on touch screen */
341 EFL_UTIL_INPUT_TOUCH_UPDATE, /**< Finger move. It is same a behavior move your finger on touch screen */
342 EFL_UTIL_INPUT_TOUCH_END, /**< Finger release. It is same a behavior release your finger on touch screen */
343 EFL_UTIL_INPUT_TOUCH_MAX = 10 /**< (Deprecated since 3.0.) */
344 } efl_util_input_touch_type_e;
348 * @brief Enumeration of pointer event types.
353 EFL_UTIL_INPUT_POINTER_BUTTON_DOWN, /**< Mouse button press. */
354 EFL_UTIL_INPUT_POINTER_BUTTON_UP, /**< Mouse move. */
355 EFL_UTIL_INPUT_POINTER_MOVE, /**< Mouse button release. */
356 } efl_util_input_pointer_type_e;
360 * @brief Initializes system and check input generate functions are supported, open devices generated events.
361 * @since_tizen $TZ_CFG_VER_24_OR_30$
362 * @privlevel platform
363 * @privilege %http://tizen.org/privilege/inputgenerator
364 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
365 * @remarks The dev_type is changed into the unsigned int to perform bitwise operations. (Since 3.0)
366 * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
367 * @return #efl_util_inputgen_h on success, otherwise @c NULL
368 * @retval #efl_util_inputgen_h The input generator handle
369 * @exception #EFL_UTIL_ERROR_NONE Successful
370 * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
371 * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
372 * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
373 * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
374 * @see efl_util_input_deinitialize_generator()
376 API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_type);
380 * @brief Deinitializes system and close opened devices.
381 * @since_tizen $TZ_CFG_VER_24_OR_30$
382 * @privlevel platform
383 * @privilege %http://tizen.org/privilege/inputgenerator
384 * @param[in] inputgen_h The #efl_util_inputgen_h handle
385 * @return @c 0 on success, otherwise a negative error value
386 * @retval #EFL_UTIL_ERROR_NONE Successful
387 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
388 * @see efl_util_input_initialize_generator()
390 API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h);
394 * @brief Generates all of key events using a opened device.
395 * @since_tizen $TZ_CFG_VER_24_OR_30$
396 * @privlevel platform
397 * @privilege %http://tizen.org/privilege/inputgenerator
398 * @param[in] inputgen_h The #efl_util_inputgen_h handle
399 * @param[in] key_name The key name want to generate
400 * @param[in] pressed The value that select key press or release (0: release, 1: press)
401 * @return @c 0 on success, otherwise a negative error value
402 * @retval #EFL_UTIL_ERROR_NONE Successful
403 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
404 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate key
406 API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *key_name, int pressed);
410 * @brief Generates a touch event using a opened device.
411 * @since_tizen $TZ_CFG_VER_24_OR_30$
412 * @privlevel platform
413 * @privilege %http://tizen.org/privilege/inputgenerator
414 * @param[in] inputgen_h The #efl_util_inputgen_h handle
415 * @param[in] idx The index of touched finger
416 * @param[in] touch_type The touch type (ex> #EFL_UTIL_INPUT_TOUCH_BEGIN, #EFL_UTIL_INPUT_TOUCH_UPDATE, #EFL_UTIL_INPUT_TOUCH_END)
417 * @param[in] x The x axis of touch point
418 * @param[in] y The y axis of touch point
419 * @return @c 0 on success, otherwise a negative error value
420 * @retval #EFL_UTIL_ERROR_NONE Successful
421 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
422 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate touch
424 API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, efl_util_input_touch_type_e touch_type, int x, int y);
428 * @brief Generate a pointer event using a opened device.
430 * @privlevel platform
431 * @privilege %http://tizen.org/privilege/inputgenerator
432 * @param[in] inputgen_h The #efl_util_inputgen_h handle
433 * @param[in] buttons The number of button
434 * @param[in] pointer_type The pointer type (ex> EFL_UTIL_INPUT_POINTER_BUTTON_PRESS, EFL_UTIL_INPUT_POINTER_BUTTON_UP, EFL_UTIL_INPUT_POINTER_MOVE)
435 * @param[in] x x coordination to move
436 * @param[in] y y coordination to move
437 * @return @c 0 on success, otherwise a negative error value
438 * @retval #EFL_UTIL_ERROR_NONE Successful
439 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
440 * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate pointer
441 * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
442 * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
444 API int efl_util_input_generate_pointer(efl_util_inputgen_h inputgen_h, int buttons, efl_util_input_pointer_type_e pointer_type, int x, int y);
451 * @addtogroup CAPI_EFL_UTIL_SCREENSHOT_MODULE
457 * @brief Definition for the screenshot handle.
458 * @since_tizen $TZ_CFG_VER_24_OR_30$
460 typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
464 * @brief Initializes the screenshot.
465 * @since_tizen $TZ_CFG_VER_24_OR_30$
466 * @privlevel platform
467 * @privilege %http://tizen.org/privilege/screenshot
468 * @remarks The specific error code can be obtained using the get_last_result()
469 * method. Error codes are described in Exception section.
470 * @param[in] width width of the screenshot surface
471 * @param[in] height height of the screenshot surface
472 * @return #efl_util_screenshot_h on success, otherwise @c NULL
473 * @retval #efl_util_screenshot_h The screenshot handle
474 * @exception #EFL_UTIL_ERROR_NONE Successful
475 * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
476 * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
477 * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure
478 * @see efl_util_screenshot_deinitialize()
480 API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
484 * @brief Takes a screenshot and get a tbm_surface handle.
485 * @since_tizen $TZ_CFG_VER_24_OR_30$
486 * @privlevel platform
487 * @privilege %http://tizen.org/privilege/screenshot
488 * @remarks The specific error code can be obtained using the get_last_result()
489 * The #tbm_surface_h must be free by caller
490 * @param[in] screenshot efl_util_screenshot_h handle
491 * @return #tbm_surface_h on success, otherwise @c NULL
492 * @retval #tbm_surface_h The TBM surface handle
493 * @exception #EFL_UTIL_ERROR_NONE Successful
494 * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
495 * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure
496 * @see efl_util_screenshot_initialize()
497 * @see efl_util_screenshot_deinitialize()
499 API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h screenshot);
503 * @brief Deinitializes the screenshot.
504 * @since_tizen $TZ_CFG_VER_24_OR_30$
505 * @privlevel platform
506 * @privilege %http://tizen.org/privilege/screenshot
507 * @param[in] screenshot efl_util_screenshot_h handle
508 * @return @c 0 on success, otherwise a negative error value
509 * @retval #EFL_UTIL_ERROR_NONE Successful
510 * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
511 * @see efl_util_screenshot_initialize()
513 API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot);
522 #endif /* __TIZEN_UI_EFL_UTIL_H__ */