remove lua bindings
[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 simple test tools for KMS and python wrapper for libkms++.
7 ## Dependencies:
9 - libdrm
10 - SWIG 3.x (for python bindings)
11 - Python 3.x (for python bindings)
13 ## Build instructions:
15 ```
16 $ mkdir build
17 $ cd build
18 $ cmake ..
19 $ make -j4
20 ```
22 ## Cross compiling instructions:
24 Directions for cross compiling depend on your environment. These are for mine (buildroot):
26 As above, but specify `-DCMAKE_TOOLCHAIN_FILE=<path>/your-toolchain.cmake` for cmake, where your-toolchain.cmake is something similar to:
28 ```
29 SET(CMAKE_SYSTEM_NAME Linux)
31 SET(BROOT "<buildroot>/output/")
33 # specify the cross compiler
34 SET(CMAKE_C_COMPILER   ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-gcc)
35 SET(CMAKE_CXX_COMPILER ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-g++)
37 # where is the target environment
38 SET(CMAKE_FIND_ROOT_PATH ${BROOT}/target ${BROOT}/host)
40 SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
41 SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
42 SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
43 ```
45 ## Build options
47 You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
49 Option name          | Values        | Default
50 -------------------- | ------------- | --------
51 CMAKE_BUILD_TYPE     | Release/Debug | Release
52 LIBKMS_ENABLE_PYTHON | ON/OFF        | ON
53 LIBKMS_ENABLE_KMSCUBEĀ | ON/OFF       | OFF
55 ## Env variables
57 You can use the following environmental variables to control the behavior of libkms.
59 Variable                          | Description
60 --------------------------------- | -------------
61 LIBKMSXX_DISABLE_UNIVERSAL_PLANES | Set to disable the use of universal planes
62 LIBKMSXX_DISABLE_ATOMIC           | Set to disable the use of atomic modesetting