Merge branch 'tizen' into sandbox/cyeon/devel
[platform/core/uifw/libtdm.git] / README
1 libtdm - Tizen Display Manager
2
3 It's the display HAL layer for tizen display server. It offers the frontend
4 APIs(tdm.h) for a frontend user and the abstraction interface(tdm_backend.h)
5 for a hardware vendor.
6
7 TDM consists of display/output/layer/pp/capture objects. A frontend user can
8 get the output/layer/pp/capture hardware information with each object.
9 Basically, TDM supposes that all hardware devices have fixed outputs and layers.
10
11 All changes of output/layer/pp/capture objects are applied when committed.
12
13 TDM has its own buffer release mechanism to let an user know when a TDM buffer
14 becomes available for a next job.
15
16 Doxygen document
17 ----------------
18 - The doxygen document is created in the "doc/html" directory.
19 - How to create the doxygen document
20   $ doxygen doc/Doxyfile
21 - How to view the doxygen document
22   $ firefox doc/html/index.html