add tbm surface as the Core api
[platform/core/uifw/libtbm.git] / doc / ui_tbm_surface_doc.h
1
2 #ifndef __SAMSUNG_UI_TBM_SURFACE_DOC_H__
3 #define __SAMSUNG_UI_TBM_SURFACE_DOC_H__
4
5 /**
6  * @defgroup CAPI_UI_TBM_SURFACE_MODULE TBM Surface
7  * @brief The tbm_surface stands for the surface in the tizen.
8  * @ingroup CAPI_UI_TBM_MODULE
9  *
10  * @section CAPI_UI_TBM_SURFACE_MODULE_HEADER Required Header
11  *   \#include <tbm_surface.h>
12  * @internal
13  *   \#include <tbm_surface_internal.h>
14  * @endinternal
15  * @section CAPI_UI_TBM_SURFACE_MODULE_OVERVIEW Overview
16  * TBM Surface API provides user interface for The TBM Surface.\n
17  * The user can get pointer of plane in the surface.\n
18  * The user can store data to low level graphic buffer by using pointer of each plane.\n\n
19  * Features :\n
20  *  - Support formats RGB format and YUV format.\n
21  *  - Get format list supported by the system.\n
22  *  - Access the surface with the access type.\n
23  *  - Support the multiple plane graphic buffer.\n
24  *  - Get the information of surface and planes.
25  */
26
27 #endif /* __SAMSUNG_UI_TBM_SURFACE_DOC_H__ */
28