Find a file
Simon Ser 8d45eeae7f Bail out based on remaining compatible planes
If we've found a good previous allocation, it's possible that there
is no point trying to continue exploring the graph. In particular,
if we won't get a higher score even if we manage to make use of all
available planes, we can stop right away.

For instance, let's say that we've previously found a way to make use
of 3 out of 5 planes. We're exploring a different path where we've
populated 1 plane, we've skipped 1 plane because we couldn't find a
suitable layer for it, and out of the 3 remaining planes only 2 are
compatible with the CRTC we're interested in. Even if we manage to
make use of these 2 extra planes we would end up with 3 effectively
used planes thus no benefit over the previous solution.
2024-05-21 18:24:01 +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 Add option to set timeout for liftoff_output_apply() 2024-05-21 08:45:56 +00:00
test test/bench: disable timeout 2024-05-21 10:52:15 +02: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 Bail out based on remaining compatible planes 2024-05-21 18:24:01 +02:00
device.c Turn on -Wsign-conversion 2023-02-16 21:33:36 +01:00
gcovr.cfg Add gcovr.cfg 2023-02-16 20:05:48 +01:00
layer.c Use [0] to get element size when allocating arrays 2024-05-15 12:00:31 +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 Fix -Wsign-conversion on 32-bit 2023-02-22 10:45:05 +01: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