louvre: init at 1.1.0-1

[dblsaiko]

Description of changes

Adds the Louvre library for building Wayland compositors. It comes with a few demo compositors.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 23.11 Release Notes (or backporting 23.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

Priorities

Add a 👍 reaction to pull requests you find important.

[Janik-Haag]

Mostly looks good, just some small change suggestions. Also how would I test if the package is actually working, I can off-course build it (and it builds fine) but is there some simple way to test functionality?

[Janik-Haag]

just waiting for ci now.

[dblsaiko]

Also how would I test if the package is actually working, I can off-course build it (and it builds fine) but is there some simple way to test functionality?

Right, I never responded to this, sorry. You can run the demo compositors in bin from the TTY (it doesn't yet support windowed mode, right @ehopperdietzel?)

[Janik-Haag]

I might be missing something but I don't see a binary:
./result-dev/
├── include
│   └── Louvre
│   ├── LAnimation.h
│   ├── LBaseSurfaceRole.h
│   ├── LClient.h
│   ├── LCompositor.h
│   ├── LCursor.h
│   ├── LCursorRole.h
│   ├── LDataDevice.h
│   ├── LDataOffer.h
│   ├── LDataSource.h
│   ├── LDNDIconRole.h
│   ├── LDNDManager.h
│   ├── LFramebuffer.h
│   ├── LKeyboard.h
│   ├── LLauncher.h
│   ├── LLayerView.h
│   ├── LLog.h
│   ├── LNamespaces.h
│   ├── LObject.h
│   ├── LOpenGL.h
│   ├── LOutputFramebuffer.h
│   ├── LOutput.h
│   ├── LOutputMode.h
│   ├── LPainter.h
│   ├── LPointer.h
│   ├── LPoint.h
│   ├── LPopupRole.h
│   ├── LPositioner.h
│   ├── LRect.h
│   ├── LRegion.h
│   ├── LRenderBuffer.h
│   ├── LResource.h
│   ├── LScene.h
│   ├── LSceneView.h
│   ├── LSeat.h
│   ├── LSize.h
│   ├── LSolidColorView.h
│   ├── LSubsurfaceRole.h
│   ├── LSurface.h
│   ├── LSurfaceView.h
│   ├── LTexture.h
│   ├── LTextureView.h
│   ├── LTime.h
│   ├── LTimer.h
│   ├── LToplevelRole.h
│   ├── LView.h
│   ├── LXCursor.h
│   ├── other
│   │   ├── cursor.h
│   │   ├── stb_image.h
│   │   └── stb_image_write.h
│   ├── private
│   │   ├── LAnimationPrivate.h
│   │   ├── LBaseSurfaceRolePrivate.h
│   │   ├── LClientPrivate.h
│   │   ├── LCompositorPrivate.h
│   │   ├── LCursorPrivate.h
│   │   ├── LCursorRolePrivate.h
│   │   ├── LDataDevicePrivate.h
│   │   ├── LDataOfferPrivate.h
│   │   ├── LDataSourcePrivate.h
│   │   ├── LDNDIconRolePrivate.h
│   │   ├── LDNDManagerPrivate.h
│   │   ├── LKeyboardPrivate.h
│   │   ├── LLayerViewPrivate.h
│   │   ├── LObjectPrivate.h
│   │   ├── LOutputFramebufferPrivate.h
│   │   ├── LOutputModePrivate.h
│   │   ├── LOutputPrivate.h
│   │   ├── LPainterPrivate.h
│   │   ├── LPointerPrivate.h
│   │   ├── LPopupRolePrivate.h
│   │   ├── LPositionerPrivate.h
│   │   ├── LRenderBufferPrivate.h
│   │   ├── LResourcePrivate.h
│   │   ├── LScenePrivate.h
│   │   ├── LSceneViewPrivate.h
│   │   ├── LSeatPrivate.h
│   │   ├── LSolidColorViewPrivate.h
│   │   ├── LSubsurfaceRolePrivate.h
│   │   ├── LSurfacePrivate.h
│   │   ├── LSurfaceViewPrivate.h
│   │   ├── LTexturePrivate.h
│   │   ├── LTextureViewPrivate.h
│   │   ├── LTimerPrivate.h
│   │   ├── LToplevelRolePrivate.h
│   │   ├── LViewPrivate.h
│   │   └── LXCursorPrivate.h
│   └── protocols
│   ├── LinuxDMABuf
│   │   ├── GLinuxDMABuf.h
│   │   ├── LDMABuffer.h
│   │   ├── linux-dmabuf-unstable-v1.h
│   │   ├── private
│   │   │   ├── GLinuxDMABufPrivate.h
│   │   │   ├── LDMABufferPrivate.h
│   │   │   ├── RLinuxBufferParamsPrivate.h
│   │   │   └── RLinuxDMABufFeedbackPrivate.h
│   │   ├── RLinuxBufferParams.h
│   │   └── RLinuxDMABufFeedback.h
│   ├── Wayland
│   │   ├── GCompositor.h
│   │   ├── GDataDeviceManager.h
│   │   ├── GOutput.h
│   │   ├── GSeat.h
│   │   ├── GSubcompositor.h
│   │   ├── private
│   │   │   ├── GCompositorPrivate.h
│   │   │   ├── GDataDeviceManagerPrivate.h
│   │   │   ├── GOutputPrivate.h
│   │   │   ├── GSeatPrivate.h
│   │   │   ├── GSubcompositorPrivate.h
│   │   │   ├── RCallbackPrivate.h
│   │   │   ├── RDataDevicePrivate.h
│   │   │   ├── RDataOfferPrivate.h
│   │   │   ├── RDataSourcePrivate.h
│   │   │   ├── RKeyboardPrivate.h
│   │   │   ├── RPointerPrivate.h
│   │   │   ├── RRegionPrivate.h
│   │   │   ├── RSubsurfacePrivate.h
│   │   │   └── RSurfacePrivate.h
│   │   ├── RCallback.h
│   │   ├── RDataDevice.h
│   │   ├── RDataOffer.h
│   │   ├── RDataSource.h
│   │   ├── RKeyboard.h
│   │   ├── RPointer.h
│   │   ├── RRegion.h
│   │   ├── RSubsurface.h
│   │   ├── RSurface.h
│   │   └── wayland.h
│   ├── WpPresentationTime
│   │   ├── GWpPresentation.h
│   │   ├── presentation-time.h
│   │   ├── private
│   │   │   ├── GWpPresentationPrivate.h
│   │   │   └── RWpPresentationFeedbackPrivate.h
│   │   └── RWpPresentationFeedback.h
│   ├── XdgDecoration
│   │   ├── GXdgDecorationManager.h
│   │   ├── private
│   │   │   ├── GXdgDecorationManagerPrivate.h
│   │   │   └── RXdgToplevelDecorationPrivate.h
│   │   ├── RXdgToplevelDecoration.h
│   │   └── xdg-decoration-unstable-v1.h
│   └── XdgShell
│   ├── GXdgWmBase.h
│   ├── private
│   │   ├── GXdgWmBasePrivate.h
│   │   ├── RXdgPopupPrivate.h
│   │   ├── RXdgPositionerPrivate.h
│   │   ├── RXdgSurfacePrivate.h
│   │   └── RXdgToplevelPrivate.h
│   ├── RXdgPopup.h
│   ├── RXdgPositioner.h
│   ├── RXdgSurface.h
│   ├── RXdgToplevel.h
│   └── xdg-shell.h
├── lib
│   └── pkgconfig
│   └── Louvre.pc
└── nix-support
└── propagated-build-inputs

19 directories, 146 files

[dblsaiko]

Hmm, is there no 'out' output? I'll have to check in a bit, that's wrong.

[dblsaiko]

Yeah, it's there for me.

% nix build -f . louvre
% result/bin/louvre-views

ctrl+shift+esc to quit.

[Janik-Haag]

Hm it's not there if I do nix-build -A louvre

[Janik-Haag]

and for me all of them segfault.

[dblsaiko]

Yes, you need to run them from the TTY, it doesn't support nested compositor yet.

[ehopperdietzel]

Also how would I test if the package is actually working, I can off-course build it (and it builds fine) but is there some simple way to test functionality?

Right, I never responded to this, sorry. You can run the demo compositors in bin from the TTY (it doesn't yet support windowed mode, right @ehopperdietzel?)

Yes, currently, it only has the DRM graphic backend, so, as you mentioned, it should be launched from a free session (tty). If you still face issues running it, setting LOUVRE_DEBUG=4 should help you understand what is happening.

[Janik-Haag]

Okay, sorry for the trouble, one last thing you should add meta.mainProgram so nix run adn lib.getExe know what the default binary is.

[dblsaiko]

I'll just pick louvre-views for that since that's the one with the most lines of code :P

[Janik-Haag]

@ofborg build louvre