Bug: 116741782

Clone this repo:
  1. 6a0335f Upgrade libkmsxx to a5545df02b40414c2bf3abc60cf629c5f59d00ec by Haibo Huang · 4 weeks ago master
  2. a5545df README: add KMSXX_DEVICE & KMSXX_DRIVER by Tomi Valkeinen · 4 weeks ago upstream-master
  3. 332019d kmsprint: add missing --device from usage by Tomi Valkeinen · 4 weeks ago
  4. 98c04ac Upgrade libkmsxx by Haibo Huang · 6 weeks ago
  5. 626edbe add support for more pixel formats by Tomi Valkeinen · 5 months ago

Build Status

kms++ - C++ library for kernel mode setting

kms++ is a C++11 library for kernel mode setting.

Also included are some simple utilities for KMS and python bindings for kms++.


  • kmstest - set modes and planes and show test pattern on crtcs/planes, and test page flips
  • kmsprint - print information about DRM objects
  • kmsview - view raw images
  • kmscube - rotating 3D cube on crtcs/planes
  • kmscapture - show captured frames from a camera on screen


  • libdrm
  • Python 3.x (for python bindings)

Build instructions:

To build the Python bindings you need to set up the git-submodule for pybind11:

git submodule update --init

And to compile:

$ mkdir build
$ cd build
$ cmake ..
$ make -j4

Cross compiling instructions:

Directions for cross compiling depend on your environment.

These are for mine with buildroot:

$ mkdir build
$ cd build
$ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/toolchainfile.cmake ..
$ make -j4

Your environment may provide similar toolchainfile. If not, you can create a toolchainfile of your own, something along these lines:


SET(BROOT "<buildroot>/output/")

# specify the cross compiler
SET(CMAKE_C_COMPILER   ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-gcc)
SET(CMAKE_CXX_COMPILER ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-g++)

# where is the target environment


Build options

You can use the following cmake flags to control the build. Use -DFLAG=VALUE to set them.

Option nameValuesDefaultNotes
KMSXX_PYTHON_VERSIONpython3/python2python3;python2Name of the python pkgconfig file

Env variables

You can use the following runtime environmental variables to control the behavior of kms++.

KMSXX_DISABLE_UNIVERSAL_PLANESSet to disable the use of universal planes
KMSXX_DISABLE_ATOMICSet to disable the use of atomic modesetting
KMSXX_DEVICEPath to the card device node to use
KMSXX_DRIVERName of the driver to use. The format is either “drvname” or “drvname:idx”

Python notes

You can run the python code directly from the build dir by defining PYTHONPATH env variable. For example:

PYTHONPATH=build/py py/tests/hpd.py