Update README.md
[android/external-libkmsxx.git] / README.md
1 # libkms++ - C++ library for kernel mode setting
3 libkms++ is a C++11 library for kernel mode setting.
5 Also included are some simple utilities for KMS and python bindings for libkms++.
7 ## Utilities
9 - testpat - set modes and planes and show test pattern on crtcs/planes
10 - kmsprint - print information about DRM objects
11 - kmsview - view raw images
12 - db - simple double-buffering test
13 - kmscube - rotating 3D cube on crtcs/planes
14 - kmscapture - show captured frames from a camera on screen
16 ## Dependencies:
18 - libdrm
19 - Python 3.x (for python bindings)
21 ## Build instructions:
23 To build the Python bindings you need to set up the git-submodule for pybind11:
25 ```
26 git submodule update --init
27 ```
29 And to compile:
31 ```
32 $ mkdir build
33 $ cd build
34 $ cmake ..
35 $ make -j4
36 ```
38 ## Cross compiling instructions:
40 Directions for cross compiling depend on your environment.
42 These are for mine with buildroot:
44 ```
45 $ mkdir build
46 $ cd build
47 $ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/toolchainfile.cmake ..
48 $ make -j4
49 ```
51 ## Build options
53 You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
55 Option name           | Values        | Default  | Notes
56 --------------------- | ------------- | -------- | --------
57 CMAKE_BUILD_TYPE      | Release/Debug | Release  |
58 LIBKMS_ENABLE_PYTHON  | ON/OFF        | ON       |
59 LIBKMS_ENABLE_KMSCUBEĀ | ON/OFF        | OFF      |
61 ## Env variables
63 You can use the following runtime environmental variables to control the behavior of libkms.
65 Variable                          | Description
66 --------------------------------- | -------------
67 LIBKMSXX_DISABLE_UNIVERSAL_PLANES | Set to disable the use of universal planes
68 LIBKMSXX_DISABLE_ATOMIC           | Set to disable the use of atomic modesetting