README.md

   1 # libkms++ - C++ library for kernel mode setting
   2
   3 libkms++ is a C++11 library for kernel mode setting.
   4
   5 Also included are some simple utilities for KMS and python bindings for libkms++.
   6
   7 ## Utilities
   8
   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
  15
  16 ## Dependencies:
  17
  18 - libdrm
  19 - Python 3.x (for python bindings)
  20
  21 ## Build instructions:
  22
  23 ```
  24 $ mkdir build
  25 $ cd build
  26 $ cmake ..
  27 $ make -j4
  28 ```
  29
  30 ## Cross compiling instructions:
  31
  32 Directions for cross compiling depend on your environment.
  33
  34 These are for mine with buildroot:
  35
  36 ```
  37 $ mkdir build
  38 $ cd build
  39 $ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/toolchainfile.cmake ..
  40 $ make -j4
  41 ```
  42
  43 ## Build options
  44
  45 You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
  46
  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      |
  52
  53 ## Env variables
  54
  55 You can use the following runtime environmental variables to control the behavior of libkms.
  56
  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