Namespaces. More...

Classes
class	LActivationToken
	Token for activating surfaces. More...

class	LActivationTokenManager
	Activation Token Manager. More...

class	LAnimation
	Time-based animations. More...

class	LBackgroundBlur
	Background blur controller for surfaces. More...

class	LBaseSurfaceRole
	Base class for surface roles. More...

class	LBitset
	Compact way of storing and managing conditions or states. More...

struct	LBlendFunc
	Color blending function. More...

struct	LBox
	Structure representing a 2D box. More...

class	LClient
	Representation of a Wayland client. More...

class	LClientCursor
	Encapsulates parameters used in a set cursor request. More...

class	LClipboard
	Clipboard manager. More...

class	LCompositor
	Louvre's core and objects factory. More...

class	LCursor
	Utility class for rendering cursors. More...

class	LCursorRole
	Cursor role for surfaces. More...

struct	LDMAFormat
	Structure representing a DMA format and modifier. More...

struct	LDMAPlanes
	Direct Memory Access (DMA) planes. More...

class	LDND
	Class for handling drag & drop sessions. More...

class	LDNDIconRole
	Drag & drop icon role for surfaces. More...

class	LEvent
	Base class for events. More...

class	LExclusiveZone
	Exclusive zone within an LOutput. More...

class	LFactoryObject
	Base class for Factory objects. More...

class	LForeignToplevelController
	Foreign Toplevel Controller. More...

class	LFramebuffer
	Base class for LPainter framebuffers. More...

class	LFramebufferWrapper
	Wrapper for a native OpenGL framebuffer. More...

class	LGammaTable
	Gamma correction table for outputs. More...

class	LGlobal
	A Wayland protocol global. More...

class	LGPU
	GPU Information. More...

class	LIdleListener
	Idle state listener. More...

class	LInputDevice
	Input Device. More...

class	LInputEvent
	Base class for input events. More...

class	LKeyboard
	Class for handling keyboard events. More...

class	LKeyboardEnterEvent
	Event generated when a surface or view gains keyboard focus. More...

class	LKeyboardEvent
	Base class for keyboard events. More...

class	LKeyboardKeyEvent
	Keyboard key event. More...

class	LKeyboardLeaveEvent
	Event generated when a surface or view loses keyboard focus. More...

class	LKeyboardModifiersEvent
	Keyboard modifiers event. More...

class	LLauncher
	Utility for launching applications safely. More...

class	LLayerRole
	Layer role for surfaces. More...

class	LLayerView
	Container of views. More...

class	LLog
	Debugging information. More...

struct	LMargins
	Structure representing left, top, right and bottom margins. More...

class	LNinePatchView
	Nine-Patch Texture View. More...

class	LObject
	Base class for Louvre objects. More...

class	LOpenGL
	OpenGL utility functions. More...

class	LOutput
	A display rendering interface. More...

class	LOutputFramebuffer
	An output framebuffer. More...

class	LOutputMode
	Output resolution and refresh rate. More...

class	LPainter
	Basic 2D rendering utility. More...

class	LPointer
	Class for handling events generated by pointing devices. More...

class	LPointerButtonEvent
	Pointer button event. More...

class	LPointerEnterEvent
	Event generated when a surface or view gains pointer focus. More...

class	LPointerEvent
	Base class for pointer events. More...

class	LPointerHoldBeginEvent
	Pointer hold begin gesture event. More...

class	LPointerHoldEndEvent
	Pointer hold end gesture event. More...

class	LPointerLeaveEvent
	Event generated when a surface or view loses pointer focus. More...

class	LPointerMoveEvent
	Pointer movement event. More...

class	LPointerPinchBeginEvent
	Pointer pinch begin gesture event. More...

class	LPointerPinchEndEvent
	Pointer pinch end gesture event. More...

class	LPointerPinchUpdateEvent
	Pointer pinch update gesture event. More...

class	LPointerScrollEvent
	Pointer scroll event. More...

class	LPointerSwipeBeginEvent
	Pointer swipe begin gesture event. More...

class	LPointerSwipeEndEvent
	Pointer swipe end gesture event. More...

class	LPointerSwipeUpdateEvent
	Pointer swipe update gesture event. More...

class	LPointTemplate
	Template for 2D vectors. More...

class	LPopupRole
	Popup role for surfaces. More...

class	LPositioner
	Positioning rules for LPopupRole surfaces. More...

class	LRectTemplate
	Template for 4D vectors. More...

class	LRegion
	Collection of non-overlapping rectangles. More...

class	LRenderBuffer
	Represents a custom render destination framebuffer. More...

class	LResource
	Wrapper for native wl_resource structs. More...

struct	LRGBAF
	RGBA color with floating-point components. More...

struct	LRGBF
	RGB color with floating-point components. More...

class	LRRect
	A rectangle with rounded corners. More...

class	LScene
	Scene. More...

class	LSceneTouchPoint
	Touch point managed within an LScene. More...

class	LSceneView
	View for rendering other views. More...

class	LScreenshotRequest
	Request to capture an LOutput frame. More...

class	LSeat
	Group of input and output devices. More...

class	LSessionLockManager
	Manages session lock requests and state changes. More...

class	LSessionLockRole
	Surface displayed during a session lock. More...

class	LSolidColorView
	View for displaying solid color rects. More...

class	LSubsurfaceRole
	Subsurface role for surfaces. More...

class	LSurface
	A client "window". More...

class	LSurfaceView
	View for displaying surfaces. More...

class	LTexture
	OpenGL texture abstraction. More...

class	LTextureView
	View for displaying textures. More...

class	LTime
	Time utilities. More...

class	LTimer
	Delayed callbacks. More...

class	LToplevelMoveSession
	Toplevel move session utility. More...

class	LToplevelResizeSession
	Toplevel resize session utility. More...

class	LToplevelRole
	Toplevel role for surfaces. More...

class	LTouch
	Class for handling touch input events. More...

class	LTouchCancelEvent
	Touch cancel event. More...

class	LTouchDownEvent
	Touch down event. More...

class	LTouchEvent
	Base class for touch events. More...

class	LTouchFrameEvent
	Represents a touch frame event. More...

class	LTouchMoveEvent
	Touch move event. More...

class	LTouchPoint
	Touch point within a touch device. More...

class	LTouchUpEvent
	Touch up event. More...

struct	LVersion
	Structure representing a version in the format major.minor.patch-build. More...

class	LView
	Base class for LScene views. More...

class	LWeak
	Weak reference to an LObject. More...

class	LXCursor
	An XCursor icon. More...

Typedefs
typedef uint64_t	UInt64
	64 bits unsigned integer

typedef int64_t	Int64
	64 bits signed integer

typedef uint32_t	UInt32
	32 bits unsigned integer

typedef int32_t	Int32
	32 bits signed integer

typedef uint16_t	UInt16
	16 bits unsigned integer

typedef int16_t	Int16
	16 bits signed integer

typedef uint8_t	UInt8
	8 bits unsigned integer

typedef int8_t	Int8
	8 bits signed integer

typedef unsigned char	UChar8
	8 bits unsigned integer

typedef char	Char8
	8 bits signed integer

typedef double	Float64
	64 bits float

typedef float	Float32
	32 bits float

typedef wl_fixed_t	Float24
	24 bits Wayland float

typedef uintptr_t	UIntPtr
	Unsigned integer capable of holding a pointer.

using	LPoint = LPointTemplate< Int32 >
	2D vector of 32 bits integers

using	LSize = LPoint
	2D vector of 32 bits integers

using	LPointF = LPointTemplate< Float32 >
	2D vector of 32 bits floats

using	LSizeF = LPointF
	2D vector of 32 bits floats

using	LRect = LRectTemplate< Int32 >
	4D vector of 32 bits integers

using	LRectF = LRectTemplate< Float32 >
	4D vector of 32 bits floats

Enumerations
enum	LContentType
	Content Type Hint. More...

enum	LEdge : UInt32
	Edge flags. More...

enum	LSurfaceLayer
	Surface layers. More...

enum	LGraphicBackendID : UInt32
	Graphic backend IDs. More...

enum	LInputBackendID : UInt32
	Input backend IDs. More...

enum class	LImageCaptureSourceType : UInt32
	Image capture source type. More...

enum class	LTransform : Int32
	Transforms. More...

Functions
constexpr bool	edgeIsCorner (LBitset< LEdge > edges) noexcept
	Checks if the given edges form a corner by being orthogonal.

LCompositor *	compositor () noexcept
	Gets the static LCompositor instance.

LCursor *	cursor () noexcept
	Gets the compositor's cursor.

LSeat *	seat () noexcept
	Gets the compositor's seat.

LSessionLockManager *	sessionLockManager () noexcept
	Gets the compositor's session lock manager.

LActivationTokenManager *	activationTokenManager () noexcept
	Provides access to the activation token manager.

static constexpr bool	is90Transform (LTransform transform) noexcept
	Checks if the transformation results in swapping the width and height.

static constexpr LTransform	requiredTransform (LTransform a, LTransform b) noexcept
	Required transform to transition from transform 'a' to 'b'.

Variables
static constexpr Int32	LEdgeDisabled = std::numeric_limits<Int32>::min()
	Represents a disabled edge.

Detailed Description

Namespaces.

Class Documentation

◆ Louvre::LBlendFunc

struct Louvre::LBlendFunc

Color blending function.

OpenGL blend function. Refer to the documentation of glBlendFuncSeparate() for more information.

Class Members
GLenum	sRGBFactor	Source RGB factor for blending.
GLenum	dRGBFactor	Destination RGB factor for blending.
GLenum	sAlphaFactor	Source alpha factor for blending.
GLenum	dAlphaFactor	Destination alpha factor for blendin.

◆ Louvre::LBox

struct Louvre::LBox

Structure representing a 2D box.

The LBox struct defines a 2D box using four integer coordinates (x1, y1, x2, y2). It is typically used to represent bounding boxes or rectangular regions in 2D space.

Class Members
Int32	x1	The x-coordinate of the top-left corner of the box.
Int32	y1	The y-coordinate of the top-left corner of the box.
Int32	x2	The x-coordinate of the bottom-right corner of the box.
Int32	y2	The y-coordinate of the bottom-right corner of the box.

◆ Louvre::LDMAPlanes

struct Louvre::LDMAPlanes

Direct Memory Access (DMA) planes.

Use this struct to import DMA buffers with LTexture.

Class Members
UInt32	width	Width of the buffer in pixels.
UInt32	height	Height of the buffer in pixels.
UInt32	format	DRM format of the buffer.
UInt32	num_fds = 0	Number of file descriptors.
Int32	fds[4] = {-1}	Array of file descriptors associated with each DMA plane.
UInt32	strides[4] = {0}	Array of strides for each DMA plane.
UInt32	offsets[4] = {0}	Array of offsets for each DMA plane.
UInt64	modifiers[4] = {0}	Array of modifiers for each DMA plane.

◆ Louvre::LMargins

struct Louvre::LMargins

Structure representing left, top, right and bottom margins.

Class Members
Int32	left {0}	The left margin.
Int32	top {0}	The top margin.
Int32	right {0}	The right margin.
Int32	bottom {0}	The bottom margin.

◆ Louvre::LVersion

struct Louvre::LVersion

Structure representing a version in the format major.minor.patch-build.

Class Members
UInt32	major	Major version.
UInt32	minor	Minor version.
UInt32	patch	Patch version.
UInt32	build	Build number.

Typedef Documentation

◆ UInt64

typedef uint64_t UInt64

64 bits unsigned integer

◆ Int64

typedef int64_t Int64

64 bits signed integer

◆ UInt32

typedef uint32_t UInt32

32 bits unsigned integer

◆ Int32

typedef int32_t Int32

32 bits signed integer

◆ UInt16

typedef uint16_t UInt16

16 bits unsigned integer

◆ Int16

typedef int16_t Int16

16 bits signed integer

◆ UInt8

typedef uint8_t UInt8

8 bits unsigned integer

◆ Int8

typedef int8_t Int8

8 bits signed integer

◆ UChar8

typedef unsigned char UChar8

8 bits unsigned integer

◆ Char8

typedef char Char8

8 bits signed integer

◆ Float64

typedef double Float64

64 bits float

◆ Float32

typedef float Float32

32 bits float

◆ Float24

typedef wl_fixed_t Float24

24 bits Wayland float

◆ UIntPtr

typedef uintptr_t UIntPtr

Unsigned integer capable of holding a pointer.

◆ LPoint

using LPoint = LPointTemplate<Int32>

2D vector of 32 bits integers

◆ LSize

using LSize = LPoint

2D vector of 32 bits integers

◆ LPointF

using LPointF = LPointTemplate<Float32>

2D vector of 32 bits floats

◆ LSizeF

using LSizeF = LPointF

2D vector of 32 bits floats

◆ LRect

using LRect = LRectTemplate<Int32>

4D vector of 32 bits integers

◆ LRectF

using LRectF = LRectTemplate<Float32>

4D vector of 32 bits floats

Enumeration Type Documentation

◆ LContentType

enum LContentType

Content Type Hint.

Hint indicating the type of content being displayed by an LSurface or LOutput.

See also: LOutput::contentType() and LOutput::setContentType().; LSurface::contentType() and LSurface::contentTypeChanged().

Enumerator
LContentTypeNone	The content doesn't fit into one of the other categories.
LContentTypePhoto	Digital still pictures that may be presented with minimal processing.
LContentTypeVideo	Video or animation that may be presented with more accurate timing to avoid stutter. Where scaling is needed, scaling methods more appropriate for video may be used.
LContentTypeGame	A running game. Its content may be presented with reduced latency.

◆ LEdge

enum LEdge : UInt32

Edge flags.

Enumerator
LEdgeNone	No edge.
LEdgeTop	The top edge.
LEdgeBottom	The bottom edge.
LEdgeLeft	The left edge.
LEdgeRight	The right edge.

◆ LSurfaceLayer

enum LSurfaceLayer

Surface layers.

This enum represents possible layers for a surface, indicating its position in the Z-axis stacking order.

Enumerator
LLayerBackground	Background layer.
LLayerBottom	Bottom layer.
LLayerMiddle	Middle layer.
LLayerTop	Top layer.
LLayerOverlay	Overlay layer.

◆ LGraphicBackendID

enum LGraphicBackendID : UInt32

Graphic backend IDs.

Use LCompositor::graphicBackendId() to identify the currently loaded backend.

Enumerator
LGraphicBackendDRM	ID for the DRM graphic backend.
LGraphicBackendWayland	ID for the Wayland graphic backend.

◆ LInputBackendID

enum LInputBackendID : UInt32

Input backend IDs.

Use LCompositor::inputBackendId() to identify the currently loaded backend.

Enumerator
LInputBackendLibinput	ID for the Libinput input backend.
LInputBackendWayland	ID for the Wayland input backend.

◆ LImageCaptureSourceType

enum class LImageCaptureSourceType : UInt32

strong

Image capture source type.

Enumerator
Output	LOutput.
ForeignToplevel	LToplevelRole.

◆ LTransform

enum class LTransform : Int32

strong

Transforms.

Enumerator
Normal	No transformation.
Rotated90	Rotate 90 degrees counter-clockwise.
Rotated180	Rotate 180 degrees counter-clockwise.
Rotated270	Rotate 270 degrees counter-clockwise.
Flipped	Flipped (swap left and right sides)
Flipped90	Flip and rotate 90 degrees counter-clockwise.
Flipped180	Flip and rotate 180 degrees counter-clockwise.
Flipped270	Flip and rotate 270 degrees counter-clockwise.

Function Documentation

◆ edgeIsCorner()

constexpr bool edgeIsCorner ( LBitset< LEdge > edges )

inlineconstexprnoexcept

Checks if the given edges form a corner by being orthogonal.

This function verifies if the provided bitset of edges corresponds to one of the four possible corner configurations: (Top-Left, Top-Right, Bottom-Left, Bottom-Right).

Parameters

edges A bitset representing the edges.

Returns: true if the edges form a corner, false otherwise.

◆ compositor()

LCompositor * compositor ( )

noexcept

Gets the static LCompositor instance.

This method provides access to the single LCompositor instance that can exist per process.

Returns: A pointer to the LCompositor instance or nullptr if not yet created.

◆ cursor()

LCursor * cursor ( )

noexcept

Gets the compositor's cursor.

Warning: Must be accessed within or after the LCompositor::initialized() or LCompositor::cursorInitialized() events.

Returns: A pointer to the LCursor instance or nullptr if not yet initialized.

◆ seat()

LSeat * seat ( )

noexcept

Gets the compositor's seat.

The seat provides access to the LClipboard, LDND, LPointer, LKeyboard, LTouch, and LOutput instances.

Warning: Must be accessed within or after the LCompositor::initialized() event.

Returns: A pointer to the LSeat instance.

◆ sessionLockManager()

LSessionLockManager * sessionLockManager ( )

noexcept

Gets the compositor's session lock manager.

Warning: Must be accessed within or after the LCompositor::initialized() event.

◆ activationTokenManager()

LActivationTokenManager * activationTokenManager ( )

noexcept

Provides access to the activation token manager.

Warning: Must be accessed within or after the LCompositor::initialized() event.

◆ is90Transform()

static constexpr bool is90Transform ( LTransform transform )

inlinestaticconstexprnoexcept

Checks if the transformation results in swapping the width and height.

Parameters

transform The transformation to check.

Returns: true if the transformation includes a 90° or 270° rotation, false otherwise.

◆ requiredTransform()

static constexpr LTransform requiredTransform	(	LTransform	a,
		LTransform	b
	)

inlinestaticconstexprnoexcept

Required transform to transition from transform 'a' to 'b'.

Parameters

a	The initial transform.
b	The target transform.

Variable Documentation

◆ LEdgeDisabled

constexpr Int32 LEdgeDisabled = std::numeric_limits<Int32>::min()

inlinestaticconstexpr

Represents a disabled edge.

This constant indicates that an edge is disabled, for example, in LToplevelRole constraints.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Class Documentation

◆ Louvre::LBlendFunc

◆ Louvre::LBox

◆ Louvre::LDMAPlanes

◆ Louvre::LMargins

◆ Louvre::LVersion

Typedef Documentation

◆ UInt64

◆ Int64

◆ UInt32

◆ Int32

◆ UInt16

◆ Int16

◆ UInt8

◆ Int8

◆ UChar8

◆ Char8

◆ Float64

◆ Float32

◆ Float24

◆ UIntPtr

◆ LPoint

◆ LSize

◆ LPointF

◆ LSizeF

◆ LRect

◆ LRectF

Enumeration Type Documentation

◆ LContentType

◆ LEdge

◆ LSurfaceLayer

◆ LGraphicBackendID

◆ LInputBackendID

◆ LImageCaptureSourceType

◆ LTransform

Function Documentation

◆ edgeIsCorner()

◆ compositor()

◆ cursor()

◆ seat()

◆ sessionLockManager()

◆ activationTokenManager()

◆ is90Transform()

◆ requiredTransform()

Variable Documentation

◆ LEdgeDisabled