package
0.0.0-20241029195437-1fbd8b4a9917
Repository: https://github.com/raitonoberu/go-wayland.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
No description provided by the author
NewBuffer : content for a wl_surface
A buffer provides the content for a wl_surface.
NewCallback : callback object
Clients can handle the 'done' event to get notified when the related request is done.
NewCompositor : the compositor singleton
A compositor.
NewDataDevice : data transfer device
There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton.
NewDataDeviceManager : data transfer interface
The wl_data_device_manager is a singleton global object that provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.
NewDataOffer : offer to transfer data
A wl_data_offer represents a piece of data offered for transfer by another client (the source client).
NewDataSource : offer to transfer data
The wl_data_source object is the source side of a wl_data_offer.
NewDisplay : core global object
The core global object.
NewKeyboard : keyboard input device
The wl_keyboard interface represents one or more keyboards associated with a seat.
NewOutput : compositor output region
An output describes part of the compositor geometry.
NewPointer : pointer input device
The wl_pointer interface represents one or more input devices, such as mice, which control the pointer location and pointer_focus of a seat.
NewRegion : region interface
A region object describes an area.
NewRegistry : global registry object
The singleton global registry object.
NewSeat : group of input devices
A seat is a group of keyboards, pointer and touch devices.
NewShell : create desktop-style surfaces
This interface is implemented by servers that provide desktop-style user interfaces.
NewShellSurface : desktop-style metadata interface
An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.
NewShm : shared memory support
A singleton global object that provides support for shared memory.
NewShmPool : a shared memory pool
The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client.
NewSubcompositor : sub-surface compositing
The global interface exposing sub-surface compositing capabilities.
NewSubsurface : sub-surface interface to a wl_surface
An additional interface to a wl_surface object, which has been made a sub-surface.
NewSurface : an onscreen surface
A surface is a rectangular area that may be displayed on zero or more outputs, and shown any number of times at the compositor's discretion.
NewTouch : touchscreen input device
The wl_touch interface represents a touchscreen associated with a seat.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
DataDeviceErrorRole : given wl_surface has another role.
DataDeviceErrorUsedSource : source has already been used.
DataDeviceManagerDndActionAsk : ask action.
DataDeviceManagerDndActionCopy : copy action.
DataDeviceManagerDndActionMove : move action.
DataDeviceManagerDndActionNone : no action.
DataOfferErrorInvalidAction : action argument has an invalid value.
DataOfferErrorInvalidActionMask : action mask contains invalid values.
DataOfferErrorInvalidFinish : finish request was called untimely.
DataOfferErrorInvalidOffer : offer doesn't accept this request.
DataSourceErrorInvalidActionMask : action mask contains invalid values.
DataSourceErrorInvalidSource : source doesn't accept this request.
DisplayErrorImplementation : implementation error in compositor.
DisplayErrorInvalidMethod : method doesn't exist on the specified interface or malformed request.
DisplayErrorInvalidObject : server couldn't find object.
DisplayErrorNoMemory : server is out of memory.
KeyboardKeymapFormatNoKeymap : no keymap; client must understand how to interpret the raw keycode.
KeyboardKeymapFormatXkbV1 : libxkbcommon compatible, null-terminated string; to determine the xkb keycode, clients must add 8 to the key event keycode.
KeyboardKeyStatePressed : key is pressed.
KeyboardKeyStateReleased : key is not pressed.
OutputModeCurrent : indicates this is the current mode.
OutputModePreferred : indicates this is the preferred mode.
OutputSubpixelHorizontalBgr : horizontal BGR.
OutputSubpixelHorizontalRgb : horizontal RGB.
OutputSubpixelNone : no geometry.
OutputSubpixelUnknown : unknown geometry.
OutputSubpixelVerticalBgr : vertical BGR.
OutputSubpixelVerticalRgb : vertical RGB.
OutputTransform180 : 180 degrees counter-clockwise.
OutputTransform270 : 270 degrees counter-clockwise.
OutputTransform90 : 90 degrees counter-clockwise.
OutputTransformFlipped : 180 degree flip around a vertical axis.
OutputTransformFlipped180 : flip and rotate 180 degrees counter-clockwise.
OutputTransformFlipped270 : flip and rotate 270 degrees counter-clockwise.
OutputTransformFlipped90 : flip and rotate 90 degrees counter-clockwise.
OutputTransformNormal : no transform.
PointerAxisHorizontalScroll : horizontal axis.
PointerAxisRelativeDirectionIdentical : physical motion matches axis direction.
PointerAxisRelativeDirectionInverted : physical motion is the inverse of the axis direction.
PointerAxisSourceContinuous : continuous coordinate space.
PointerAxisSourceFinger : finger on a touch surface.
PointerAxisSourceWheel : a physical wheel rotation.
PointerAxisSourceWheelTilt : a physical wheel tilt.
PointerAxisVerticalScroll : vertical axis.
PointerButtonStatePressed : the button is pressed.
PointerButtonStateReleased : the button is not pressed.
PointerErrorRole : given wl_surface has another role.
SeatCapabilityKeyboard : the seat has one or more keyboards.
SeatCapabilityPointer : the seat has pointer devices.
SeatCapabilityTouch : the seat has touch devices.
SeatErrorMissingCapability : get_pointer, get_keyboard or get_touch called on seat without the matching capability.
ShellErrorRole : given wl_surface has another role.
ShellSurfaceFullscreenMethodDefault : no preference, apply default policy.
ShellSurfaceFullscreenMethodDriver : switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch.
ShellSurfaceFullscreenMethodFill : no upscaling, center on output and add black borders to compensate size mismatch.
ShellSurfaceFullscreenMethodScale : scale, preserve the surface's aspect ratio and center on output.
ShellSurfaceResizeBottom : bottom edge.
ShellSurfaceResizeBottomLeft : bottom and left edges.
ShellSurfaceResizeBottomRight : bottom and right edges.
ShellSurfaceResizeLeft : left edge.
ShellSurfaceResizeNone : no edge.
ShellSurfaceResizeRight : right edge.
ShellSurfaceResizeTop : top edge.
ShellSurfaceResizeTopLeft : top and left edges.
ShellSurfaceResizeTopRight : top and right edges.
ShellSurfaceTransientInactive : do not set keyboard focus.
ShmErrorInvalidFd : mmapping the file descriptor failed.
ShmErrorInvalidFormat : buffer format is not known.
ShmErrorInvalidStride : invalid size or stride during pool or buffer creation.
ShmFormatAbgr1555 : 16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian.
ShmFormatAbgr16161616 : [63:0] A:B:G:R 16:16:16:16 little endian.
ShmFormatAbgr16161616F : [63:0] A:B:G:R 16:16:16:16 little endian.
ShmFormatAbgr2101010 : 32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian.
ShmFormatAbgr4444 : 16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian.
ShmFormatAbgr8888 : 32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian.
ShmFormatArgb1555 : 16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian.
ShmFormatArgb16161616 : [63:0] A:R:G:B 16:16:16:16 little endian.
ShmFormatArgb16161616F : [63:0] A:R:G:B 16:16:16:16 little endian.
ShmFormatArgb2101010 : 32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian.
ShmFormatArgb4444 : 16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian.
ShmFormatArgb8888 : 32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian.
ShmFormatAvuy8888 : [31:0] A:Cr:Cb:Y 8:8:8:8 little endian.
ShmFormatAxbxgxrx106106106106 : [63:0] A:x:B:x:G:x:R:x 10:6:10:6:10:6:10:6 little endian.
ShmFormatAyuv : packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian.
ShmFormatBgr233 : 8-bit BGR format, [7:0] B:G:R 2:3:3.
ShmFormatBgr565 : 16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatBgr888 : 24-bit BGR format, [23:0] B:G:R little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatBgra1010102 : 32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian.
ShmFormatBgra4444 : 16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian.
ShmFormatBgra5551 : 16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian.
ShmFormatBgra8888 : 32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian.
ShmFormatBgrx1010102 : 32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian.
ShmFormatBgrx4444 : 16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian.
ShmFormatBgrx5551 : 16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian.
ShmFormatBgrx8888 : 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatC1 : [7:0] C0:C1:C2:C3:C4:C5:C6:C7 1:1:1:1:1:1:1:1 eight pixels/byte.
ShmFormatC2 : [7:0] C0:C1:C2:C3 2:2:2:2 four pixels/byte.
ShmFormatC4 : [7:0] C0:C1 4:4 two pixels/byte.
ShmFormatC8 : 8-bit color index format, [7:0] C.
ShmFormatD1 : [7:0] D0:D1:D2:D3:D4:D5:D6:D7 1:1:1:1:1:1:1:1 eight pixels/byte.
ShmFormatD2 : [7:0] D0:D1:D2:D3 2:2:2:2 four pixels/byte.
ShmFormatD4 : [7:0] D0:D1 4:4 two pixels/byte.
ShmFormatD8 : [7:0] D.
ShmFormatGr1616 : [31:0] G:R 16:16 little endian.
ShmFormatGr88 : [15:0] G:R 8:8 little endian.
ShmFormatNv12 : 2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane.
ShmFormatNv15 : 2x2 subsampled Cr:Cb plane.
ShmFormatNv16 : 2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane.
ShmFormatNv21 : 2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane.
ShmFormatNv24 : non-subsampled Cr:Cb plane.
ShmFormatNv42 : non-subsampled Cb:Cr plane.
ShmFormatNv61 : 2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane.
ShmFormatP010 : 2x2 subsampled Cr:Cb plane 10 bits per channel.
ShmFormatP012 : 2x2 subsampled Cr:Cb plane 12 bits per channel.
ShmFormatP016 : 2x2 subsampled Cr:Cb plane 16 bits per channel.
ShmFormatP030 : 2x2 subsampled Cr:Cb plane 10 bits per channel packed.
ShmFormatP210 : 2x1 subsampled Cr:Cb plane, 10 bit per channel.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatR1 : [7:0] R0:R1:R2:R3:R4:R5:R6:R7 1:1:1:1:1:1:1:1 eight pixels/byte.
ShmFormatR10 : [15:0] x:R 6:10 little endian.
ShmFormatR12 : [15:0] x:R 4:12 little endian.
ShmFormatR16 : [15:0] R little endian.
ShmFormatR2 : [7:0] R0:R1:R2:R3 2:2:2:2 four pixels/byte.
ShmFormatR4 : [7:0] R0:R1 4:4 two pixels/byte.
ShmFormatR8 : [7:0] R.
ShmFormatRg1616 : [31:0] R:G 16:16 little endian.
ShmFormatRg88 : [15:0] R:G 8:8 little endian.
ShmFormatRgb332 : 8-bit RGB format, [7:0] R:G:B 3:3:2.
ShmFormatRgb565 : 16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatRgb888 : 24-bit RGB format, [23:0] R:G:B little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatRgba1010102 : 32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian.
ShmFormatRgba4444 : 16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian.
ShmFormatRgba5551 : 16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian.
ShmFormatRgba8888 : 32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian.
ShmFormatRgbx1010102 : 32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian.
ShmFormatRgbx4444 : 16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian.
ShmFormatRgbx5551 : 16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian.
ShmFormatRgbx8888 : 32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatUyvy : packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian.
ShmFormatVuy101010 : Y followed by U then V, 10:10:10.
ShmFormatVuy888 : [23:0] Cr:Cb:Y 8:8:8 little endian.
ShmFormatVyuy : packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian.
ShmFormatX0L0 : [63:0] X3:X2:Y3:0:Cr0:0:Y2:0:X1:X0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian.
ShmFormatX0L2 : [63:0] X3:X2:Y3:Cr0:Y2:X1:X0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian.
ShmFormatXbgr1555 : 16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian.
ShmFormatXbgr16161616 : [63:0] x:B:G:R 16:16:16:16 little endian.
ShmFormatXbgr16161616F : [63:0] x:B:G:R 16:16:16:16 little endian.
ShmFormatXbgr2101010 : 32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian.
ShmFormatXbgr4444 : 16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian.
ShmFormatXbgr8888 : 32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatXrgb1555 : 16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian.
ShmFormatXrgb16161616 : [63:0] x:R:G:B 16:16:16:16 little endian.
ShmFormatXrgb16161616F : [63:0] x:R:G:B 16:16:16:16 little endian.
ShmFormatXrgb2101010 : 32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian.
ShmFormatXrgb4444 : 16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian.
ShmFormatXrgb8888 : 32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatXvuy8888 : [31:0] X:Cr:Cb:Y 8:8:8:8 little endian.
ShmFormatXvyu1216161616 : [63:0] X:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian.
ShmFormatXvyu16161616 : [63:0] X:Cr:Y:Cb 16:16:16:16 little endian.
ShmFormatXvyu2101010 : [31:0] X:Cr:Y:Cb 2:10:10:10 little endian.
ShmFormatXyuv8888 : [31:0] X:Y:Cb:Cr 8:8:8:8 little endian.
ShmFormatY0L0 : [63:0] A3:A2:Y3:0:Cr0:0:Y2:0:A1:A0:Y1:0:Cb0:0:Y0:0 1:1:8:2:8:2:8:2:1:1:8:2:8:2:8:2 little endian.
ShmFormatY0L2 : [63:0] A3:A2:Y3:Cr0:Y2:A1:A0:Y1:Cb0:Y0 1:1:10:10:10:1:1:10:10:10 little endian.
ShmFormatY210 : [63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 10:6:10:6:10:6:10:6 little endian per 2 Y pixels.
ShmFormatY212 : [63:0] Cr0:0:Y1:0:Cb0:0:Y0:0 12:4:12:4:12:4:12:4 little endian per 2 Y pixels.
ShmFormatY216 : [63:0] Cr0:Y1:Cb0:Y0 16:16:16:16 little endian per 2 Y pixels.
ShmFormatY410 : [31:0] A:Cr:Y:Cb 2:10:10:10 little endian.
ShmFormatY412 : [63:0] A:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian.
ShmFormatY416 : [63:0] A:Cr:Y:Cb 16:16:16:16 little endian.
ShmFormatYuv410 : 3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes.
ShmFormatYuv411 : 3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes.
ShmFormatYuv420 : 3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormat : pixel formats
This describes the memory layout of an individual pixel.
ShmFormatYuv422 : 3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes.
ShmFormatYuv444 : 3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes.
ShmFormatYuyv : packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian.
ShmFormatYvu410 : 3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes.
ShmFormatYvu411 : 3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes.
ShmFormatYvu420 : 3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes.
ShmFormatYvu422 : 3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes.
ShmFormatYvu444 : 3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes.
ShmFormatYvyu : packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian.
SubcompositorErrorBadParent : the to-be sub-surface parent is invalid.
SubcompositorErrorBadSurface : the to-be sub-surface is invalid.
SubsurfaceErrorBadSurface : wl_surface is not a sibling or the parent.
SurfaceErrorDefunctRoleObject : surface was destroyed before its role object.
SurfaceErrorInvalidOffset : buffer offset is invalid.
SurfaceErrorInvalidScale : buffer scale value is invalid.
SurfaceErrorInvalidSize : buffer size is invalid.
SurfaceErrorInvalidTransform : buffer transform value is invalid.
# Structs
No description provided by the author
Buffer : content for a wl_surface
A buffer provides the content for a wl_surface.
BufferReleaseEvent : compositor releases buffer
Sent when this wl_buffer is no longer used by the compositor.
Callback : callback object
Clients can handle the 'done' event to get notified when the related request is done.
CallbackDoneEvent : done event
Notify the client when the related request is done.
Compositor : the compositor singleton
A compositor.
No description provided by the author
DataDevice : data transfer device
There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton.
DataDeviceDataOfferEvent : introduce a new wl_data_offer
The data_offer event introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections).
DataDeviceDropEvent : end drag-and-drop session successfully
The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.
DataDeviceEnterEvent : initiate drag-and-drop session
This event is sent when an active drag-and-drop pointer enters a surface owned by the client.
DataDeviceLeaveEvent : end drag-and-drop session
This event is sent when the drag-and-drop pointer leaves the surface and the session ends.
DataDeviceManager : data transfer interface
The wl_data_device_manager is a singleton global object that provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.
DataDeviceMotionEvent : drag-and-drop session motion
This event is sent when the drag-and-drop pointer moves within the currently focused surface.
DataDeviceSelectionEvent : advertise new selection
The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device.
DataOffer : offer to transfer data
A wl_data_offer represents a piece of data offered for transfer by another client (the source client).
DataOfferActionEvent : notify the selected action
This event indicates the action selected by the compositor after matching the source/destination side actions.
DataOfferOfferEvent : advertise offered mime type
Sent immediately after creating the wl_data_offer object.
DataOfferSourceActionsEvent : notify the source-side available actions
This event indicates the actions offered by the data source.
DataSource : offer to transfer data
The wl_data_source object is the source side of a wl_data_offer.
DataSourceActionEvent : notify the selected action
This event indicates the action selected by the compositor after matching the source/destination side actions.
DataSourceCancelledEvent : selection was cancelled
This data source is no longer valid.
DataSourceDndDropPerformedEvent : the drag-and-drop operation physically finished
The user performed the drop action.
DataSourceDndFinishedEvent : the drag-and-drop operation concluded
The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data.
DataSourceSendEvent : send the data
Request for data from the client.
DataSourceTargetEvent : a target accepts an offered mime type
Sent when a target accepts pointer_focus or motion events.
Display : core global object
The core global object.
DisplayDeleteIdEvent : acknowledge object ID deletion
This event is used internally by the object ID management logic.
DisplayErrorEvent : fatal error event
The error event is sent out when a fatal (non-recoverable) error has occurred.
Keyboard : keyboard input device
The wl_keyboard interface represents one or more keyboards associated with a seat.
KeyboardEnterEvent : enter event
Notification that this seat's keyboard focus is on a certain surface.
KeyboardKeyEvent : key event
A key was pressed or released.
KeyboardKeymapEvent : keyboard mapping
This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description.
KeyboardLeaveEvent : leave event
Notification that this seat's keyboard focus is no longer on a certain surface.
KeyboardModifiersEvent : modifier and group state
Notifies clients that the modifier and/or group state has changed, and it should update its local state.
KeyboardRepeatInfoEvent : repeat rate and delay
Informs the client about the keyboard's repeat rate and delay.
Output : compositor output region
An output describes part of the compositor geometry.
OutputDescriptionEvent : human-readable description of this output
Many compositors can produce human-readable descriptions of their outputs.
OutputDoneEvent : sent all information about output
This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that.
OutputGeometryEvent : properties of the output
The geometry event describes geometric properties of the output.
OutputModeEvent : advertise available modes for the output
The mode event describes an available mode for the output.
OutputNameEvent : name of this output
Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc.
OutputScaleEvent : output scaling properties
This event contains scaling geometry information that is not in the geometry event.
Pointer : pointer input device
The wl_pointer interface represents one or more input devices, such as mice, which control the pointer location and pointer_focus of a seat.
PointerAxisDiscreteEvent : axis click event
Discrete step information for scroll and other axes.
PointerAxisEvent : axis event
Scroll and other axis notifications.
PointerAxisRelativeDirectionEvent : axis relative physical direction event
Relative directional information of the entity causing the axis motion.
PointerAxisSourceEvent : axis source event
Source information for scroll and other axes.
PointerAxisStopEvent : axis stop event
Stop notification for scroll and other axes.
PointerAxisValue120Event : axis high-resolution scroll event
Discrete high-resolution scroll information.
PointerButtonEvent : pointer button event
Mouse button click and release notifications.
PointerEnterEvent : enter event
Notification that this seat's pointer is focused on a certain surface.
PointerFrameEvent : end of a pointer event sequence
Indicates the end of a set of events that logically belong together.
PointerLeaveEvent : leave event
Notification that this seat's pointer is no longer focused on a certain surface.
PointerMotionEvent : pointer motion event
Notification of pointer location change.
Region : region interface
A region object describes an area.
Registry : global registry object
The singleton global registry object.
RegistryGlobalEvent : announce global object
Notify the client of global objects.
RegistryGlobalRemoveEvent : announce removal of global object
Notify the client of removed global objects.
Seat : group of input devices
A seat is a group of keyboards, pointer and touch devices.
SeatCapabilitiesEvent : seat capabilities changed
This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities.
SeatNameEvent : unique identifier for this seat
In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents.
Shell : create desktop-style surfaces
This interface is implemented by servers that provide desktop-style user interfaces.
ShellSurface : desktop-style metadata interface
An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.
ShellSurfaceConfigureEvent : suggest resize
The configure event asks the client to resize its surface.
ShellSurfacePingEvent : ping client
Ping a client to check if it is receiving events and sending requests.
ShellSurfacePopupDoneEvent : popup interaction is done
The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface.
Shm : shared memory support
A singleton global object that provides support for shared memory.
ShmFormatEvent : pixel format description
Informs the client about a valid pixel format that can be used for buffers.
ShmPool : a shared memory pool
The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client.
Subcompositor : sub-surface compositing
The global interface exposing sub-surface compositing capabilities.
Subsurface : sub-surface interface to a wl_surface
An additional interface to a wl_surface object, which has been made a sub-surface.
Surface : an onscreen surface
A surface is a rectangular area that may be displayed on zero or more outputs, and shown any number of times at the compositor's discretion.
SurfaceEnterEvent : surface enters an output
This is emitted whenever a surface's creation, movement, or resizing results in some part of it being within the scanout region of an output.
SurfaceLeaveEvent : surface leaves an output
This is emitted whenever a surface's creation, movement, or resizing results in it no longer having any part of it within the scanout region of an output.
SurfacePreferredBufferScaleEvent : preferred buffer scale for the surface
This event indicates the preferred buffer scale for this surface.
SurfacePreferredBufferTransformEvent : preferred buffer transform for the surface
This event indicates the preferred buffer transform for this surface.
Touch : touchscreen input device
The wl_touch interface represents a touchscreen associated with a seat.
TouchCancelEvent : touch session cancelled
Sent if the compositor decides the touch stream is a global gesture.
TouchDownEvent : touch down event and beginning of a touch sequence
A new touch point has appeared on the surface.
TouchFrameEvent : end of touch frame event
Indicates the end of a set of events that logically belong together.
TouchMotionEvent : update of touch point coordinates
A touch point has changed coordinates.
TouchOrientationEvent : update orientation of touch point
Sent when a touchpoint has changed its orientation.
TouchShapeEvent : update shape of touch point
Sent when a touchpoint has changed its shape.
TouchUpEvent : end of a touch event sequence
The touch point has disappeared.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author