2 * Copyright (c) 2011-2017 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_SCREENSHOT_DOC_H__
18 #define __TIZEN_UI_EFL_UTIL_SCREENSHOT_DOC_H__
21 * @ingroup CAPI_EFL_UTIL_MODULE
22 * @defgroup CAPI_EFL_UTIL_SCREENSHOT_MODULE EFL UTIL SCREENSHOT
23 * @brief Provides functions to capture screen shot
25 * @section CAPI_EFL_UTIL_SCREENSHOT_MODULE_HEADER Required Header
26 * \#include <efl_util.h>
28 * @section CAPI_EFL_UTIL_SCREENSHOT_MODULE_OVERVIEW Overview
29 * The EFL UTIL SCREENSHOT API provides functions to capture screenshot.
30 * Client can get screenshot image by efl_util_screenshot_take_tbm_surface
31 * API with tbm_surface handler.<br>
33 * To take a screenshot, use the following steps:<br>
34 * 1. Create the efl_util_screenshot_h handle<br>
35 * 2. Initialize the handle information using the efl_util_screenshot_initialize() function<br>
36 * 3. Call the efl_util_screenshot_take_tbm_surface() function with the argument efl_util_screenshot_h<br>
37 * Then the captured screen data will be returned to tbm_surface_h handle<br>
38 * 4. If no longer needed, call the efl_util_screenshot_deinitialize() function to free the efl_util_screenshot_h<br>
41 #endif /* __TIZEN_UI_EFL_UTIL_SCREENSHOT_DOC_H__ */