Find a file
Simon Ser b5b921ea85 Introduce core properties
This is a set of well-known KMS standard properties, either used
by libliftoff itself or commonly used by compositors. Adding
special cases for these allows us to access them without having
to iterate over a list.

This roughly improves performance by ~50% when leaving out the
atomic test-only commits.

Closes: https://gitlab.freedesktop.org/emersion/libliftoff/-/issues/1
2024-05-27 23:46:20 +02:00
.builds ci: use alpine/latest instead of alpine/edge 2024-05-14 16:21:08 +02:00
doc Add needs_composition APIs 2021-08-09 11:56:55 +02:00
example Add option to set timeout for liftoff_output_apply() 2024-05-21 08:45:56 +00:00
include Introduce core properties 2024-05-27 23:46:20 +02:00
test test: Add intersection tests 2024-05-27 13:27:57 -04:00
.editorconfig editorconfig: increase max line length to 100 2023-02-16 19:56:31 +01:00
.gitignore Add build-* to .gitignore 2019-10-19 13:46:11 +03:00
.gitlab-ci.yml ci: add .gitlab-ci.yml 2021-12-14 17:05:49 +01:00
alloc.c Introduce core properties 2024-05-27 23:46:20 +02:00
device.c Introduce core properties 2024-05-27 23:46:20 +02:00
gcovr.cfg Add gcovr.cfg 2023-02-16 20:05:48 +01:00
layer.c Introduce core properties 2024-05-27 23:46:20 +02:00
LICENSE Add LICENSE 2019-08-21 23:13:35 +03:00
list.c Introduce liftoff_list_swap 2023-12-20 16:03:49 +00:00
log.c Turn on -Wdeclaration-after-statement 2023-02-16 20:03:42 +01:00
meson.build build: bump to 0.5.0-dev 2023-02-20 22:09:53 +01:00
output.c Keep output layers ordered by allocation priority 2023-12-20 16:03:49 +00:00
plane.c Introduce core properties 2024-05-27 23:46:20 +02:00
README.md Switch to "meson setup" 2023-02-22 10:57:03 +01:00

libliftoff

builds.sr.ht status

Lightweight KMS plane library.

libliftoff eases the use of KMS planes from userspace without standing in your way. Users create "virtual planes" called layers, set KMS properties on them, and libliftoff will pick hardware planes for these layers if possible.

Resources:

libliftoff is used in production by gamescope on Steam Deck devices, and work is underway to integrate it with wlroots.

Building

Depends on libdrm. Requires universal planes and atomic.

meson setup build/
ninja -C build/

Usage

See liftoff.h and the example/ directory. See doc/compositor.md for compositor guidelines.

Here's the general idea:

struct liftoff_device *device;
struct liftoff_output *output;
struct liftoff_layer *layer;
drmModeAtomicReq *req;
int ret;

device = liftoff_device_create(drm_fd);
output = liftoff_output_create(device, crtc_id);

liftoff_device_register_all_planes(device);

layer = liftoff_layer_create(output);
liftoff_layer_set_property(layer, "FB_ID", fb_id);
/* Probably setup more properties and more layers */

req = drmModeAtomicAlloc();
ret = liftoff_output_apply(output, req);
if (ret < 0) {
	perror("liftoff_output_apply");
	exit(1);
}

ret = drmModeAtomicCommit(drm_fd, req, DRM_MODE_ATOMIC_NONBLOCK, NULL);
if (ret < 0) {
	perror("drmModeAtomicCommit");
	exit(1);
}
drmModeAtomicFree(req);

Contributing

Report bugs and send pull requests on GitLab.

We use the Wayland/Weston style and contribution guidelines, see Weston's contributing document.

License

MIT