liftoff-dotnet 0.5.1

liftoff-dotnet

liftoff-dotnet are .NET bindings for libliftoff.

Usage

using Drm;
using Liftoff;

using var drm = DrmDevice.Open("/dev/dri/card0");
drm.SetClientCapability(DrmClientCapability.Atomic);

using var device = LiftoffDevice.Create(drm);
device.RegisterAllPlanes();

using var output = device.CreateOutput(crtcId);
using var layer = output.CreateLayer();
layer.SetFramebuffer(framebuffer);
layer.SetCrtcRect(0, 0, 1920, 1080);
layer.SetSourceRect(0, 0, 1920, 1080);
layer.SetZPos(1);

using var request = new DrmAtomicRequest();
output.Apply(request, DrmAtomicCommitFlags.Nonblock);
drm.AtomicCommit(request, DrmAtomicCommitFlags.Nonblock);

Console.WriteLine(layer.Plane is { } plane
    ? $"Scanned out directly on plane {plane.Id}"
    : "Needs composition");

layer.SetProperty(LiftoffProperty.SrcW, LiftoffLayer.ToFixed16(1.5));  // raw, 16.16 fixed point
layer.SetProperty("IN_FENCE_FD", (ulong)fenceFd);                      // any other plane property
layer.UnsetProperty("IN_FENCE_FD");

output.SetCompositionLayer(compositionLayer);
output.Apply(request, flags);

foreach (var layer in output.Layers)
{
    if (layer.NeedsComposition)
    {
        BlendIntoCompositionBuffer(layer);
    }
}

if (!output.TryApply(request, flags, out int errno))
{
    FallBackToFullComposition();
}

LiftoffLog.Priority = LiftoffLogPriority.Debug;
LiftoffLog.SetHandler((priority, message) => Console.Error.WriteLine($"[{priority}] {message}"));

using Liftoff.Native;

unsafe
{
    var plane = Libliftoff.liftoff_layer_get_plane((liftoff_layer*)layer.Handle);
    uint id = Libliftoff.liftoff_plane_get_id(plane);
}

Testing

sudo modprobe vkms
sudo chmod a+rw /dev/dri/card*   # or run as a user with access
dotnet test

Samples

dotnet run --project samples/Liftoff.NET.Sample -- /dev/dri/card0
dotnet run --project samples/Liftoff.NET.CompositorSample -- /dev/dri/card0 -l6
dotnet run --project samples/Liftoff.NET.DynamicSample -- /dev/dri/card0

Regenerating the bindings

src/Liftoff.NET/Native/Generated is checked-in ClangSharp output; regenerate it only when bumping the external/libliftoff submodule.

git submodule update --init
dotnet tool restore
sh eng/generate.sh