parallelize drawing of test pattern
[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 ```
24 $ mkdir build
25 $ cd build
26 $ cmake ..
27 $ make -j4
28 ```
30 ## Cross compiling instructions:
32 Directions for cross compiling depend on your environment.
34 These are for mine with buildroot:
36 ```
37 $ mkdir build
38 $ cd build
39 $ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/toolchainfile.cmake ..
40 $ make -j4
41 ```
43 ## Build options
45 You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
47 Option name           | Values        | Default  | Notes
48 --------------------- | ------------- | -------- | --------
49 CMAKE_BUILD_TYPE      | Release/Debug | Release  |
50 LIBKMS_ENABLE_PYTHON  | ON/OFF        | ON       |
51 LIBKMS_ENABLE_KMSCUBEĀ | ON/OFF        | OFF      |
53 ## Env variables
55 You can use the following runtime environmental variables to control the behavior of libkms.
57 Variable                          | Description
58 --------------------------------- | -------------
59 LIBKMSXX_DISABLE_UNIVERSAL_PLANES | Set to disable the use of universal planes
60 LIBKMSXX_DISABLE_ATOMIC           | Set to disable the use of atomic modesetting