wl

package module
v0.2.23 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 11, 2024 License: MIT Imports: 10 Imported by: 0

README

wl

wl provides a pure-Go implementation of the Wayland display server protocol.

A pre-generated set of bindings for the core Wayland protocol is made available through this package. The wl-protocols repository contains bindings for most protocols available in wayland-protocols.

Status

wl is still under active development and is not yet stable. Breaking changes occur on a regular basis.

License

wl is available under the MIT License. See the LICENSE file for more details.

The core Wayland protocol is also available under the MIT License. See the meta/wayland.xml file for more details.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrAlreadyClosed indicates that a Wayland display has already been closed
	// and no more operations can be performed with it.
	ErrAlreadyClosed = errors.New("already closed")

	// ErrInvalidObject indicates that a received Wayland message contained an
	// object argument referencing an object which did not exist.
	ErrInvalidObject = errors.New("invalid object")

	// ErrInvalidOpcode indicates that a received Wayland message contained an
	// invalid opcode which could not be dispatched.
	ErrInvalidOpcode = errors.New("invalid opcode")

	// ErrLongMessage indicates that a request was too long to be written into
	// a Wayland message buffer. This will never be returned from a function as
	// an error but will be instead thrown as a panic.
	ErrLongMessage = errors.New("message too long")

	// ErrNonNullable indicates that a message with a non-nullable argument
	// contained a null value.
	ErrNonNullable = errors.New("null in non-nullable arg")

	// ErrShortMessage indicates that a received Wayland message was
	// unexpectedly truncated, dropping one or more arguments.
	ErrShortMessage = errors.New("truncated message")
)
View Source 
var BufferInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchBufferRelease},
	NumFd:    []int{0},
	Name:     "wl_buffer",
}

Note: Do not modify this variable.

View Source 
var CallbackInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchCallbackDone},
	NumFd:    []int{0},
	Name:     "wl_callback",
}

Note: Do not modify this variable.

View Source 
var CompositorInterface = Interface{
	ErrorStr: nil,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_compositor",
}

Note: Do not modify this variable.

View Source 
var DataDeviceInterface = Interface{
	ErrorStr: errorStrDataDevice,
	Dispatch: []func(Object, Message) error{dispatchDataDeviceDataOffer, dispatchDataDeviceEnter, dispatchDataDeviceLeave, dispatchDataDeviceMotion, dispatchDataDeviceDrop, dispatchDataDeviceSelection},
	NumFd:    []int{0, 0, 0, 0, 0, 0},
	Name:     "wl_data_device",
}

Note: Do not modify this variable.

View Source 
var DataDeviceManagerInterface = Interface{
	ErrorStr: nil,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_data_device_manager",
}

Note: Do not modify this variable.

View Source 
var DataOfferInterface = Interface{
	ErrorStr: errorStrDataOffer,
	Dispatch: []func(Object, Message) error{dispatchDataOfferOffer, dispatchDataOfferSourceActions, dispatchDataOfferAction},
	NumFd:    []int{0, 0, 0},
	Name:     "wl_data_offer",
}

Note: Do not modify this variable.

View Source 
var DataSourceInterface = Interface{
	ErrorStr: errorStrDataSource,
	Dispatch: []func(Object, Message) error{dispatchDataSourceTarget, dispatchDataSourceSend, dispatchDataSourceCancelled, dispatchDataSourceDndDropPerformed, dispatchDataSourceDndFinished, dispatchDataSourceAction},
	NumFd:    []int{0, 1, 0, 0, 0, 0},
	Name:     "wl_data_source",
}

Note: Do not modify this variable.

View Source 
var DisplayInterface = Interface{
	ErrorStr: errorStrDisplay,
	Dispatch: []func(Object, Message) error{dispatchDisplayError, dispatchDisplayDeleteId},
	NumFd:    []int{0, 0},
	Name:     "wl_display",
}

Note: Do not modify this variable.

View Source 
var KeyboardInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchKeyboardKeymap, dispatchKeyboardEnter, dispatchKeyboardLeave, dispatchKeyboardKey, dispatchKeyboardModifiers, dispatchKeyboardRepeatInfo},
	NumFd:    []int{1, 0, 0, 0, 0, 0},
	Name:     "wl_keyboard",
}

Note: Do not modify this variable.

View Source 
var OutputInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchOutputGeometry, dispatchOutputMode, dispatchOutputDone, dispatchOutputScale, dispatchOutputName, dispatchOutputDescription},
	NumFd:    []int{0, 0, 0, 0, 0, 0},
	Name:     "wl_output",
}

Note: Do not modify this variable.

View Source 
var PointerInterface = Interface{
	ErrorStr: errorStrPointer,
	Dispatch: []func(Object, Message) error{dispatchPointerEnter, dispatchPointerLeave, dispatchPointerMotion, dispatchPointerButton, dispatchPointerAxis, dispatchPointerFrame, dispatchPointerAxisSource, dispatchPointerAxisStop, dispatchPointerAxisDiscrete, dispatchPointerAxisValue120, dispatchPointerAxisRelativeDirection},
	NumFd:    []int{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
	Name:     "wl_pointer",
}

Note: Do not modify this variable.

View Source 
var RegionInterface = Interface{
	ErrorStr: nil,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_region",
}

Note: Do not modify this variable.

View Source 
var RegistryInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchRegistryGlobal, dispatchRegistryGlobalRemove},
	NumFd:    []int{0, 0},
	Name:     "wl_registry",
}

Note: Do not modify this variable.

View Source 
var SeatInterface = Interface{
	ErrorStr: errorStrSeat,
	Dispatch: []func(Object, Message) error{dispatchSeatCapabilities, dispatchSeatName},
	NumFd:    []int{0, 0},
	Name:     "wl_seat",
}

Note: Do not modify this variable.

View Source 
var ShellInterface = Interface{
	ErrorStr: errorStrShell,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_shell",
}

Note: Do not modify this variable.

View Source 
var ShellSurfaceInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchShellSurfacePing, dispatchShellSurfaceConfigure, dispatchShellSurfacePopupDone},
	NumFd:    []int{0, 0, 0},
	Name:     "wl_shell_surface",
}

Note: Do not modify this variable.

View Source 
var ShmInterface = Interface{
	ErrorStr: errorStrShm,
	Dispatch: []func(Object, Message) error{dispatchShmFormat},
	NumFd:    []int{0},
	Name:     "wl_shm",
}

Note: Do not modify this variable.

View Source 
var ShmPoolInterface = Interface{
	ErrorStr: nil,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_shm_pool",
}

Note: Do not modify this variable.

View Source 
var SubcompositorInterface = Interface{
	ErrorStr: errorStrSubcompositor,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_subcompositor",
}

Note: Do not modify this variable.

View Source 
var SubsurfaceInterface = Interface{
	ErrorStr: errorStrSubsurface,
	Dispatch: nil,
	NumFd:    nil,
	Name:     "wl_subsurface",
}

Note: Do not modify this variable.

View Source 
var SurfaceInterface = Interface{
	ErrorStr: errorStrSurface,
	Dispatch: []func(Object, Message) error{dispatchSurfaceEnter, dispatchSurfaceLeave, dispatchSurfacePreferredBufferScale, dispatchSurfacePreferredBufferTransform},
	NumFd:    []int{0, 0, 0, 0},
	Name:     "wl_surface",
}

Note: Do not modify this variable.

View Source 
var TouchInterface = Interface{
	ErrorStr: nil,
	Dispatch: []func(Object, Message) error{dispatchTouchDown, dispatchTouchUp, dispatchTouchMotion, dispatchTouchFrame, dispatchTouchCancel, dispatchTouchShape, dispatchTouchOrientation},
	NumFd:    []int{0, 0, 0, 0, 0, 0, 0},
	Name:     "wl_touch",
}

Note: Do not modify this variable.

Functions

func IsNull 

func IsNull[T ~struct{ *objdata }](obj T) bool

IsNull returns whether or not the given Wayland protocol object is null.

Types

type Buffer 

type Buffer Object

Content for a wl_surface

A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_shm, wp_linux_buffer_params (from the linux-dmabuf protocol extension) or similar. It has a width and a height and can be attached to a wl_surface, but the mechanism by which a client provides and updates the contents is defined by the buffer factory interface.

Color channels are assumed to be electrical rather than optical (in other words, encoded with a transfer function) unless otherwise specified. If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied into the electrical color channel values (after transfer function encoding) unless otherwise specified.

Note, because wl_buffer objects are created from multiple independent factory interfaces, the wl_buffer interface is frozen at version 1.

func (*Buffer) Destroy 

func (S *Buffer) Destroy()

Destroy a buffer

Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface.

For possible side-effects to a surface, see wl_surface.attach.

func (*Buffer) SetListener 

func (o *Buffer) SetListener(listener BufferListener, data any)

SetListener sets the event listener for the Buffer. Overwriting an existing listener is illegal and will result in a panic.

type BufferListener 

type BufferListener struct {
	// # Compositor releases buffer
	//
	// Sent when this wl_buffer is no longer used by the compositor.
	// The client is now free to reuse or destroy this buffer and its
	// backing storage.
	//
	// If a client receives a release event before the frame callback
	// requested in the same wl_surface.commit that attaches this
	// wl_buffer to a surface, then the client is immediately free to
	// reuse the buffer and its backing storage, and does not need a
	// second buffer for the next surface content update. Typically
	// this is possible, when the compositor maintains a copy of the
	// wl_surface contents, e.g. as a GL texture. This is an important
	// optimization for GL(ES) compositors with wl_shm clients.
	Release func(data any, self Buffer) error
	// contains filtered or unexported fields
}

type Callback 

type Callback Object

Callback object

Clients can handle the 'done' event to get notified when the related request is done.

Note, because wl_callback objects are created from multiple independent factory interfaces, the wl_callback interface is frozen at version 1.

func (*Callback) Destroy 

func (o *Callback) Destroy()

Destroy renders the Callback inert and prepares to recycle its ID.

func (*Callback) SetListener 

func (o *Callback) SetListener(listener CallbackListener, data any)

SetListener sets the event listener for the Callback. Overwriting an existing listener is illegal and will result in a panic.

type CallbackListener 

type CallbackListener struct {
	// # Done event
	//
	// Notify the client when the related request is done.
	Done func(data any, self Callback, callbackData uint32) error
	// contains filtered or unexported fields
}

type Compositor 

type Compositor Object

The compositor singleton

A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output.

func (*Compositor) CreateRegion 

func (S *Compositor) CreateRegion() Region

Create new region

Ask the compositor to create a new region.

func (*Compositor) CreateSurface 

func (S *Compositor) CreateSurface() Surface

Create new surface

Ask the compositor to create a new surface.

func (*Compositor) Destroy 

func (o *Compositor) Destroy()

Destroy renders the Compositor inert and prepares to recycle its ID.

type DataDevice 

type DataDevice Object

Data transfer device

There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton.

A wl_data_device provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.

func (*DataDevice) Release 

func (S *DataDevice) Release()

Destroy data device

This request destroys the data device.

func (*DataDevice) SetListener 

func (o *DataDevice) SetListener(listener DataDeviceListener, data any)

SetListener sets the event listener for the DataDevice. Overwriting an existing listener is illegal and will result in a panic.

func (*DataDevice) SetSelection 

func (S *DataDevice) SetSelection(source DataSource, serial uint32)

Copy data to the selection

This request asks the compositor to set the selection to the data from the source on behalf of the client.

To unset the selection, set the source to NULL.

The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error.

func (*DataDevice) StartDrag 

func (S *DataDevice) StartDrag(source DataSource, origin Surface, icon Surface, serial uint32)

Start drag-and-drop operation

This request asks the compositor to start a drag-and-drop operation on behalf of the client.

The source argument is the data source that provides the data for the eventual data transfer. If source is NULL, enter, leave and motion events are sent only to the client that initiated the drag and the client is expected to handle the data passing internally. If source is destroyed, the drag-and-drop session will be cancelled.

The origin surface is the surface where the drag originates and the client must have an active implicit grab that matches the serial.

The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wl_surface.offset requests can move the relative position. Attach requests must be confirmed with wl_surface.commit as usual. The icon surface is given the role of a drag-and-drop icon. If the icon surface already has another role, it raises a protocol error.

The input region is ignored for wl_surfaces with the role of a drag-and-drop icon.

The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error.

type DataDeviceError 

type DataDeviceError int32
const (
	DataDeviceErrorRole       DataDeviceError = 0 // Given wl_surface has another role
	DataDeviceErrorUsedSource DataDeviceError = 1 // Source has already been used
)

func (DataDeviceError) String 

func (v DataDeviceError) String() string

type DataDeviceListener 

type DataDeviceListener struct {
	// # 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).  Immediately
	// following the data_device.data_offer event, the new data_offer
	// object will send out data_offer.offer events to describe the
	// mime types it offers.
	DataOffer func(data any, self DataDevice, id DataOffer) error

	// # Initiate drag-and-drop session
	//
	// This event is sent when an active drag-and-drop pointer enters
	// a surface owned by the client.  The position of the pointer at
	// enter time is provided by the x and y arguments, in surface-local
	// coordinates.
	Enter func(data any, self DataDevice, serial uint32, surface Surface, x float64, y float64, id DataOffer) error

	// # End drag-and-drop session
	//
	// This event is sent when the drag-and-drop pointer leaves the
	// surface and the session ends.  The client must destroy the
	// wl_data_offer introduced at enter time at this point.
	Leave func(data any, self DataDevice) error

	// # Drag-and-drop session motion
	//
	// This event is sent when the drag-and-drop pointer moves within
	// the currently focused surface. The new position of the pointer
	// is provided by the x and y arguments, in surface-local
	// coordinates.
	Motion func(data any, self DataDevice, time uint32, x float64, y float64) error

	// # End drag-and-drop session successfully
	//
	// The event is sent when a drag-and-drop operation is ended
	// because the implicit grab is removed.
	//
	// The drag-and-drop destination is expected to honor the last action
	// received through wl_data_offer.action, if the resulting action is
	// "copy" or "move", the destination can still perform
	// wl_data_offer.receive requests, and is expected to end all
	// transfers with a wl_data_offer.finish request.
	//
	// If the resulting action is "ask", the action will not be considered
	// final. The drag-and-drop destination is expected to perform one last
	// wl_data_offer.set_actions request, or wl_data_offer.destroy in order
	// to cancel the operation.
	Drop func(data any, self DataDevice) error

	// # 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.  The
	// data_device.data_offer and the data_offer.offer events are
	// sent out immediately before this event to introduce the data
	// offer object.  The selection event is sent to a client
	// immediately before receiving keyboard focus and when a new
	// selection is set while the client has keyboard focus.  The
	// data_offer is valid until a new data_offer or NULL is received
	// or until the client loses keyboard focus.  Switching surface with
	// keyboard focus within the same client doesn't mean a new selection
	// will be sent.  The client must destroy the previous selection
	// data_offer, if any, upon receiving this event.
	Selection func(data any, self DataDevice, id DataOffer) error
	// contains filtered or unexported fields
}

type DataDeviceManager 

type DataDeviceManager Object

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. These mechanisms are tied to a wl_seat and this interface lets a client get a wl_data_device corresponding to a wl_seat.

Depending on the version bound, the objects created from the bound wl_data_device_manager object will have different requirements for functioning properly. See wl_data_source.set_actions, wl_data_offer.accept and wl_data_offer.finish for details.

func (*DataDeviceManager) CreateDataSource 

func (S *DataDeviceManager) CreateDataSource() DataSource

Create a new data source

Create a new data source.

func (*DataDeviceManager) Destroy 

func (o *DataDeviceManager) Destroy()

Destroy renders the DataDeviceManager inert and prepares to recycle its ID.

func (*DataDeviceManager) GetDataDevice 

func (S *DataDeviceManager) GetDataDevice(seat Seat) DataDevice

Create a new data device

Create a new data device for a given seat.

type DataDeviceManagerDndAction 

type DataDeviceManagerDndAction uint32

Drag and drop actions

This is a bitmask of the available/preferred actions in a drag-and-drop operation.

In the compositor, the selected action is a result of matching the actions offered by the source and destination sides. "action" events with a "none" action will be sent to both source and destination if there is no match. All further checks will effectively happen on (source actions ∩ destination actions).

In addition, compositors may also pick different actions in reaction to key modifiers being pressed. One common design that is used in major toolkits (and the behavior recommended for compositors) is:

  • If no modifiers are pressed, the first match (in bit order) will be used.
  • Pressing Shift selects "move", if enabled in the mask.
  • Pressing Control selects "copy", if enabled in the mask.

Behavior beyond that is considered implementation-dependent. Compositors may for example bind other modifiers (like Alt/Meta) or drags initiated with other buttons than BTN_LEFT to specific actions (e.g. "ask"). 

const (
	DataDeviceManagerDndActionNone DataDeviceManagerDndAction = 0 // No action
	DataDeviceManagerDndActionCopy DataDeviceManagerDndAction = 1 // Copy action
	DataDeviceManagerDndActionMove DataDeviceManagerDndAction = 2 // Move action
	DataDeviceManagerDndActionAsk  DataDeviceManagerDndAction = 4 // Ask action
)

func (DataDeviceManagerDndAction) String 

func (v DataDeviceManagerDndAction) String() string

type DataOffer 

type DataOffer Object

Offer to transfer data

A wl_data_offer represents a piece of data offered for transfer by another client (the source client). It is used by the copy-and-paste and drag-and-drop mechanisms. The offer describes the different mime types that the data can be converted to and provides the mechanism for transferring the data directly from the source client.

func (*DataOffer) Accept 

func (S *DataOffer) Accept(serial uint32, mimeType string)

Accept one of the offered mime types

Indicate that the client can accept the given mime type, or NULL for not accepted.

For objects of version 2 or older, this request is used by the client to give feedback whether the client can receive the given mime type, or NULL if none is accepted; the feedback does not determine whether the drag-and-drop operation succeeds or not.

For objects of version 3 or newer, this request determines the final result of the drag-and-drop operation. If the end result is that no mime types were accepted, the drag-and-drop operation will be cancelled and the corresponding drag source will receive wl_data_source.cancelled. Clients may still use this event in conjunction with wl_data_source.action for feedback.

func (*DataOffer) Destroy 

func (S *DataOffer) Destroy()

Destroy data offer

Destroy the data offer.

func (*DataOffer) Finish 

func (S *DataOffer) Finish()

The offer will no longer be used

Notifies the compositor that the drag destination successfully finished the drag-and-drop operation.

Upon receiving this request, the compositor will emit wl_data_source.dnd_finished on the drag source client.

It is a client error to perform other requests than wl_data_offer.destroy after this one. It is also an error to perform this request after a NULL mime type has been set in wl_data_offer.accept or no action was received through wl_data_offer.action.

If wl_data_offer.finish request is received for a non drag and drop operation, the invalid_finish protocol error is raised.

func (*DataOffer) Receive 

func (S *DataOffer) Receive(mimeType string, fd int)

Request that the data is transferred

To transfer the offered data, the client issues this request and indicates the mime type it wants to receive. The transfer happens through the passed file descriptor (typically created with the pipe system call). The source client writes the data in the mime type representation requested and then closes the file descriptor.

The receiving client reads from the read end of the pipe until EOF and then closes its end, at which point the transfer is complete.

This request may happen multiple times for different mime types, both before and after wl_data_device.drop. Drag-and-drop destination clients may preemptively fetch data or examine it more closely to determine acceptance.

func (*DataOffer) SetActions 

func (S *DataOffer) SetActions(dndActions DataDeviceManagerDndAction, preferredAction DataDeviceManagerDndAction)

Set the available/preferred drag-and-drop actions

Sets the actions that the destination side client supports for this operation. This request may trigger the emission of wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action.

This request can be called multiple times throughout the drag-and-drop operation, typically in response to wl_data_device.enter or wl_data_device.motion events.

This request determines the final result of the drag-and-drop operation. If the end result is that no action is accepted, the drag source will receive wl_data_source.cancelled.

The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, and the preferred_action argument must only contain one of those values set, otherwise it will result in a protocol error.

While managing an "ask" action, the destination drag-and-drop client may perform further wl_data_offer.receive requests, and is expected to perform one last wl_data_offer.set_actions request with a preferred action other than "ask" (and optionally wl_data_offer.accept) before requesting wl_data_offer.finish, in order to convey the action selected by the user. If the preferred action is not in the wl_data_offer.source_actions mask, an error will be raised.

If the "ask" action is dismissed (e.g. user cancellation), the client is expected to perform wl_data_offer.destroy right away.

This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise.

func (*DataOffer) SetListener 

func (o *DataOffer) SetListener(listener DataOfferListener, data any)

SetListener sets the event listener for the DataOffer. Overwriting an existing listener is illegal and will result in a panic.

type DataOfferError 

type DataOfferError int32
const (
	DataOfferErrorInvalidFinish     DataOfferError = 0 // Finish request was called untimely
	DataOfferErrorInvalidActionMask DataOfferError = 1 // Action mask contains invalid values
	DataOfferErrorInvalidAction     DataOfferError = 2 // Action argument has an invalid value
	DataOfferErrorInvalidOffer      DataOfferError = 3 // Offer doesn't accept this request
)

func (DataOfferError) String 

func (v DataOfferError) String() string

type DataOfferListener 

type DataOfferListener struct {
	// # Advertise offered mime type
	//
	// Sent immediately after creating the wl_data_offer object.  One
	// event per offered mime type.
	Offer func(data any, self DataOffer, mimeType string) error

	// # Notify the source-side available actions
	//
	// This event indicates the actions offered by the data source. It
	// will be sent immediately after creating the wl_data_offer object,
	// or anytime the source side changes its offered actions through
	// wl_data_source.set_actions.
	SourceActions func(data any, self DataOffer, sourceActions DataDeviceManagerDndAction) error

	// # Notify the selected action
	//
	// This event indicates the action selected by the compositor after
	// matching the source/destination side actions. Only one action (or
	// none) will be offered here.
	//
	// This event can be emitted multiple times during the drag-and-drop
	// operation in response to destination side action changes through
	// wl_data_offer.set_actions.
	//
	// This event will no longer be emitted after wl_data_device.drop
	// happened on the drag-and-drop destination, the client must
	// honor the last action received, or the last preferred one set
	// through wl_data_offer.set_actions when handling an "ask" action.
	//
	// Compositors may also change the selected action on the fly, mainly
	// in response to keyboard modifier changes during the drag-and-drop
	// operation.
	//
	// The most recent action received is always the valid one. Prior to
	// receiving wl_data_device.drop, the chosen action may change (e.g.
	// due to keyboard modifiers being pressed). At the time of receiving
	// wl_data_device.drop the drag-and-drop destination must honor the
	// last action received.
	//
	// Action changes may still happen after wl_data_device.drop,
	// especially on "ask" actions, where the drag-and-drop destination
	// may choose another action afterwards. Action changes happening
	// at this stage are always the result of inter-client negotiation, the
	// compositor shall no longer be able to induce a different action.
	//
	// Upon "ask" actions, it is expected that the drag-and-drop destination
	// may potentially choose a different action and/or mime type,
	// based on wl_data_offer.source_actions and finally chosen by the
	// user (e.g. popping up a menu with the available options). The
	// final wl_data_offer.set_actions and wl_data_offer.accept requests
	// must happen before the call to wl_data_offer.finish.
	Action func(data any, self DataOffer, dndAction DataDeviceManagerDndAction) error
	// contains filtered or unexported fields
}

type DataSource 

type DataSource Object

Offer to transfer data

The wl_data_source object is the source side of a wl_data_offer. It is created by the source client in a data transfer and provides a way to describe the offered data and a way to respond to requests to transfer the data.

func (*DataSource) Destroy 

func (S *DataSource) Destroy()

Destroy the data source

Destroy the data source.

func (*DataSource) Offer 

func (S *DataSource) Offer(mimeType string)

Add an offered mime type

This request adds a mime type to the set of mime types advertised to targets. Can be called several times to offer multiple types.

func (*DataSource) SetActions 

func (S *DataSource) SetActions(dndActions DataDeviceManagerDndAction)

Set the available drag-and-drop actions

Sets the actions that the source side client supports for this operation. This request may trigger wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action.

The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, otherwise it will result in a protocol error.

This request must be made once only, and can only be made on sources used in drag-and-drop, so it must be performed before wl_data_device.start_drag. Attempting to use the source other than for drag-and-drop will raise a protocol error.

func (*DataSource) SetListener 

func (o *DataSource) SetListener(listener DataSourceListener, data any)

SetListener sets the event listener for the DataSource. Overwriting an existing listener is illegal and will result in a panic.

type DataSourceError 

type DataSourceError int32
const (
	DataSourceErrorInvalidActionMask DataSourceError = 0 // Action mask contains invalid values
	DataSourceErrorInvalidSource     DataSourceError = 1 // Source doesn't accept this request
)

func (DataSourceError) String 

func (v DataSourceError) String() string

type DataSourceListener 

type DataSourceListener struct {
	// # A target accepts an offered mime type
	//
	// Sent when a target accepts pointer_focus or motion events.  If
	// a target does not accept any of the offered types, type is NULL.
	//
	// Used for feedback during drag-and-drop.
	Target func(data any, self DataSource, mimeType string) error

	// # Send the data
	//
	// Request for data from the client.  Send the data as the
	// specified mime type over the passed file descriptor, then
	// close it.
	Send func(data any, self DataSource, mimeType string, fd int) error

	// # Selection was cancelled
	//
	// This data source is no longer valid. There are several reasons why
	// this could happen:
	//
	//   - The data source has been replaced by another data source.
	//   - The drag-and-drop operation was performed, but the drop destination
	//     did not accept any of the mime types offered through
	//     wl_data_source.target.
	//   - The drag-and-drop operation was performed, but the drop destination
	//     did not select any of the actions present in the mask offered through
	//     wl_data_source.action.
	//   - The drag-and-drop operation was performed but didn't happen over a
	//     surface.
	//   - The compositor cancelled the drag-and-drop operation (e.g. compositor
	//     dependent timeouts to avoid stale drag-and-drop transfers).
	//
	// The client should clean up and destroy this data source.
	//
	// For objects of version 2 or older, wl_data_source.cancelled will
	// only be emitted if the data source was replaced by another data
	// source.
	Cancelled func(data any, self DataSource) error

	// # The drag-and-drop operation physically finished
	//
	// The user performed the drop action. This event does not indicate
	// acceptance, wl_data_source.cancelled may still be emitted afterwards
	// if the drop destination does not accept any mime type.
	//
	// However, this event might however not be received if the compositor
	// cancelled the drag-and-drop operation before this event could happen.
	//
	// Note that the data_source may still be used in the future and should
	// not be destroyed here.
	DndDropPerformed func(data any, self DataSource) error

	// # 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.
	//
	// If the action used to perform the operation was "move", the
	// source can now delete the transferred data.
	DndFinished func(data any, self DataSource) error

	// # Notify the selected action
	//
	// This event indicates the action selected by the compositor after
	// matching the source/destination side actions. Only one action (or
	// none) will be offered here.
	//
	// This event can be emitted multiple times during the drag-and-drop
	// operation, mainly in response to destination side changes through
	// wl_data_offer.set_actions, and as the data device enters/leaves
	// surfaces.
	//
	// It is only possible to receive this event after
	// wl_data_source.dnd_drop_performed if the drag-and-drop operation
	// ended in an "ask" action, in which case the final wl_data_source.action
	// event will happen immediately before wl_data_source.dnd_finished.
	//
	// Compositors may also change the selected action on the fly, mainly
	// in response to keyboard modifier changes during the drag-and-drop
	// operation.
	//
	// The most recent action received is always the valid one. The chosen
	// action may change alongside negotiation (e.g. an "ask" action can turn
	// into a "move" operation), so the effects of the final action must
	// always be applied in wl_data_offer.dnd_finished.
	//
	// Clients can trigger cursor surface changes from this point, so
	// they reflect the current action.
	Action func(data any, self DataSource, dndAction DataDeviceManagerDndAction) error
	// contains filtered or unexported fields
}

type Display 

type Display struct {
	// contains filtered or unexported fields
}

Display contains all of the state associated with a Wayland connection and handles reading and dispatching events and writing requests.

func NewDisplay 

func NewDisplay(name string) (*Display, error)

NewDisplay attempts to open a connection to a Wayland server. The following rules are used to determine which Wayland display to open a connection with:

  • If the provided name is empty, fall back to the WAYLAND_DISPLAY environment variable.
  • If the WAYLAND_DISPLAY environment variable is empty, fall back to "wayland-0".
  • If the given name is an absolute path (i.e. it begins with '/'), use it directly when opening the Unix socket.
  • If the given name is a relative path, prefix it with the XDG_RUNTIME_DIR environment variable.

NewDisplay does not make use of the WAYLAND_SOCKET environment variable.

func (*Display) Close 

func (d *Display) Close() error

Close closes the Display, rendering it unusable for any further I/O operations.

func (*Display) Dispatch 

func (d *Display) Dispatch() error

Dispatch reads and dispatches any queued events from the Wayland socket. If no events are available to be read, Dispatch will block until at least one full event is available.

A non-nil error return is fatal and signifies that the Display should be closed.

func (*Display) Flush 

func (d *Display) Flush() error

Flush writes any queued messages to the Wayland socket.

A non-nil error return is fatal and signifies that the Display should be closed.

func (*Display) GetRegistry 

func (d *Display) GetRegistry() Registry

Get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor.

It should be noted that the server side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke get_registry as infrequently as possible to avoid wasting memory.

func (*Display) NewObject 

func (d *Display) NewObject(iface *Interface, version uint32) Object

NewObject creates a new Object with the given interface description and version, but with an automatically generated client object ID.

Note: NewObject should only be called by auto-generated code. It is not intended for general use.

func (*Display) Roundtrip 

func (d *Display) Roundtrip() error

Roundtrip blocks until the Wayland server on the other end of the connection has processed all previous requests.

A non-nil error return is fatal and signifies that the Display should be closed.

func (*Display) Sync 

func (d *Display) Sync() Callback

Asynchronous roundtrip

The sync request asks the server to emit the 'done' event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is undefined and should be ignored.

type DisplayError 

type DisplayError int32

Global error values

These errors are global and can be emitted in response to any server request. 

const (
	DisplayErrorInvalidObject  DisplayError = 0 // Server couldn't find object
	DisplayErrorInvalidMethod  DisplayError = 1 // Method doesn't exist on the specified interface or malformed request
	DisplayErrorNoMemory       DisplayError = 2 // Server is out of memory
	DisplayErrorImplementation DisplayError = 3 // Implementation error in compositor
)

func (DisplayError) String 

func (v DisplayError) String() string

type Interface 

type Interface struct {
	NumFd    []int                         // Number of file descriptors per opcode
	Dispatch []func(Object, Message) error // Event unmarshallers / dispatchers
	ErrorStr func(uint32) string           // Error code stringer function
	Name     string                        // Name, as it appears in the protocol XML
}

Interface contains the description of a single Wayland protocol interface.

type Keyboard 

type Keyboard Object

Keyboard input device

The wl_keyboard interface represents one or more keyboards associated with a seat.

Each wl_keyboard has the following logical state:

- an active surface (possibly null), - the keys currently logically down, - the active modifiers, - the active group.

By default, the active surface is null, the keys currently logically down are empty, the active modifiers and the active group are 0.

func (*Keyboard) Release 

func (S *Keyboard) Release()

Release the keyboard object

func (*Keyboard) SetListener 

func (o *Keyboard) SetListener(listener KeyboardListener, data any)

SetListener sets the event listener for the Keyboard. Overwriting an existing listener is illegal and will result in a panic.

type KeyboardKeyState 

type KeyboardKeyState int32

Physical key state

Describes the physical state of a key that produced the key event. 

const (
	KeyboardKeyStateReleased KeyboardKeyState = 0 // Key is not pressed
	KeyboardKeyStatePressed  KeyboardKeyState = 1 // Key is pressed
)

func (KeyboardKeyState) String 

func (v KeyboardKeyState) String() string

type KeyboardKeymapFormat 

type KeyboardKeymapFormat int32

Keyboard mapping format

This specifies the format of the keymap provided to the client with the wl_keyboard.keymap event. 

const (
	KeyboardKeymapFormatNoKeymap KeyboardKeymapFormat = 0 // No keymap; client must understand how to interpret the raw keycode
	KeyboardKeymapFormatXkbV1    KeyboardKeymapFormat = 1 // Libxkbcommon compatible, null-terminated string; to determine the xkb keycode, clients must add 8 to the key event keycode
)

func (KeyboardKeymapFormat) String 

func (v KeyboardKeymapFormat) String() string

type KeyboardListener 

type KeyboardListener struct {
	// # 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.
	//
	// From version 7 onwards, the fd must be mapped with MAP_PRIVATE by
	// the recipient, as MAP_SHARED may fail.
	Keymap func(data any, self Keyboard, format KeyboardKeymapFormat, fd int, size uint32) error

	// # Enter event
	//
	// Notification that this seat's keyboard focus is on a certain
	// surface.
	//
	// The compositor must send the wl_keyboard.modifiers event after this
	// event.
	//
	// In the wl_keyboard logical state, this event sets the active surface to
	// the surface argument and the keys currently logically down to the keys
	// in the keys argument. The compositor must not send this event if the
	// wl_keyboard already had an active surface immediately before this event.
	Enter func(data any, self Keyboard, serial uint32, surface Surface, keys []byte) error

	// # Leave event
	//
	// Notification that this seat's keyboard focus is no longer on
	// a certain surface.
	//
	// The leave notification is sent before the enter notification
	// for the new focus.
	//
	// In the wl_keyboard logical state, this event resets all values to their
	// defaults. The compositor must not send this event if the active surface
	// of the wl_keyboard was not equal to the surface argument immediately
	// before this event.
	Leave func(data any, self Keyboard, serial uint32, surface Surface) error

	// # Key event
	//
	// A key was pressed or released.
	// The time argument is a timestamp with millisecond
	// granularity, with an undefined base.
	//
	// The key is a platform-specific key code that can be interpreted
	// by feeding it to the keyboard mapping (see the keymap event).
	//
	// If this event produces a change in modifiers, then the resulting
	// wl_keyboard.modifiers event must be sent after this event.
	//
	// In the wl_keyboard logical state, this event adds the key to the keys
	// currently logically down (if the state argument is pressed) or removes
	// the key from the keys currently logically down (if the state argument is
	// released). The compositor must not send this event if the wl_keyboard
	// did not have an active surface immediately before this event. The
	// compositor must not send this event if state is pressed (resp. released)
	// and the key was already logically down (resp. was not logically down)
	// immediately before this event.
	Key func(data any, self Keyboard, serial uint32, time uint32, key uint32, state KeyboardKeyState) error

	// # Modifier and group state
	//
	// Notifies clients that the modifier and/or group state has
	// changed, and it should update its local state.
	//
	// The compositor may send this event without a surface of the client
	// having keyboard focus, for example to tie modifier information to
	// pointer focus instead. If a modifier event with pressed modifiers is sent
	// without a prior enter event, the client can assume the modifier state is
	// valid until it receives the next wl_keyboard.modifiers event. In order to
	// reset the modifier state again, the compositor can send a
	// wl_keyboard.modifiers event with no pressed modifiers.
	//
	// In the wl_keyboard logical state, this event updates the modifiers and
	// group.
	Modifiers func(data any, self Keyboard, serial uint32, modsDepressed uint32, modsLatched uint32, modsLocked uint32, group uint32) error

	// # Repeat rate and delay
	//
	// Informs the client about the keyboard's repeat rate and delay.
	//
	// This event is sent as soon as the wl_keyboard object has been created,
	// and is guaranteed to be received by the client before any key press
	// event.
	//
	// Negative values for either rate or delay are illegal. A rate of zero
	// will disable any repeating (regardless of the value of delay).
	//
	// This event can be sent later on as well with a new value if necessary,
	// so clients should continue listening for the event past the creation
	// of wl_keyboard.
	RepeatInfo func(data any, self Keyboard, rate int32, delay int32) error
	// contains filtered or unexported fields
}

type Message 

type Message struct {
	// contains filtered or unexported fields
}

Message provides a convenient way for auto-generated code to write Wayland request messages and read Wayland event messages.

Although Message provides methods for both reading and writing, any single Message should only ever be used for one of the two. A single Message cannot be both written to and read from.

Note: Message should only be used by auto-generated code. It is not intended for general use.

func NewMessage 

func NewMessage(numFd int) Message

NewMessage creates a new Message for writing requests with the given file descriptor capacity.

func (*Message) DebugEvent 

func (m *Message) DebugEvent(dpy *Display, discarded bool, name string, args ...any)

DebugEvent prints out a log message describing the given arguments as an event.

func (*Message) DebugRequest 

func (m *Message) DebugRequest(dpy *Display, name string, args ...any)

DebugRequest prints out a log message describing the given arguments as a request.

func (*Message) ReadArray 

func (m *Message) ReadArray() ([]byte, error)

ReadArray attempts to read a byte array from m.

If m is too short, then ReadArray will return ErrShortMessage.

func (*Message) ReadFd 

func (m *Message) ReadFd() int

ReadFd attempts to read a file descriptor from m.

If m is too short, ReadFd will panic. m should always contain a sufficient number of file descriptors due to checks performed during event dispatch.

func (*Message) ReadFixed 

func (m *Message) ReadFixed() (float64, error)

ReadFixed attempts to read a 4-byte fixed point number from m.

If m is too short, then ReadFixed will return ErrShortMessage.

func (*Message) ReadInt 

func (m *Message) ReadInt() (int32, error)

ReadInt attempts to read a 4-byte integer from m.

If m is too short, then ReadInt will return ErrShortMessage.

func (*Message) ReadNewId 

func (m *Message) ReadNewId(parent Object, iface *Interface) (Object, error)

ReadNewId attempts to read an object ID from m and create a new child object for parent who is implemented by iface.

If m is too short, then ReadNewId will return ErrShortMessage. If m contains a null object ID, then ReadNewId will return ErrNonNullable.

func (*Message) ReadObject 

func (m *Message) ReadObject(dpy *Display, nullable bool) (Object, error)

ReadObject attempts to read an object ID from m.

If m is too short, then ReadObject will return ErrShortMessage. If nullable is false but m contains a null object ID, then ReadObject will return ErrNonNullable. If no object with the given ID exists, then ReadObject will return ErrInvalidObject.

A null object may be returned due to race conditions inherent to the Wayland protocol.

func (*Message) ReadString 

func (m *Message) ReadString(nullable bool) (string, error)

ReadString attempts to read a variable-length string from m.

If m is too short, then ReadString will return ErrShortMessage. If nullable is false but m contains a null string, then ReadString will return ErrNonNullable.

func (*Message) ReadUint 

func (m *Message) ReadUint() (uint32, error)

ReadUint attempts to read a 4-byte unsigned integer from m.

If m is too short, then ReadUint will return ErrShortMessage.

func (*Message) WriteArray 

func (m *Message) WriteArray(x []byte)

WriteArray attempts to write an array of bytes to m.

If m is too short, then WriteArray will panic.

func (*Message) WriteFd 

func (m *Message) WriteFd(x int)

WriteFd attempts to write a file descriptor to m.

If m is too short, then WriteFd will panic.

func (*Message) WriteFixed 

func (m *Message) WriteFixed(x float64)

WriteFixed attempts to write a 4-byte fixed point number to m.

If m is too short, then WriteFixed will panic.

func (*Message) WriteHeader 

func (m *Message) WriteHeader(id uint32, op uint16)

WriteHeader writes a Wayland message header into m.

func (*Message) WriteInt 

func (m *Message) WriteInt(x int32)

WriteInt attempts to write a 4-byte integer to m.

If m is too short, then WriteInt will panic.

func (*Message) WriteNewIdDynamic 

func (m *Message) WriteNewIdDynamic(dpy *Display, iface *Interface, version uint32) Object

WriteNewIdDynamic writes a new object ID to m and creates a new Object with that ID in addition to the specified interface and version.

If m is too short or no more object IDs are available, then WriteNewIdDynamic will panic.

func (*Message) WriteNewIdStatic 

func (m *Message) WriteNewIdStatic(x Object, iface *Interface) Object

WriteNewIdStatic writes a new object ID to m and creates a new Object with that ID.

If m is too short or no more object IDs are available, then WriteNewIdStatic will panic.

func (*Message) WriteObject 

func (m *Message) WriteObject(x Object, nullable bool)

WriteObject attempts to write an object ID to m.

If m is too short, then WriteObject will panic. If nullable is false but x contains a null object, then WriteObject will panic.

func (*Message) WriteString 

func (m *Message) WriteString(x string, nullable bool)

WriteString attempts to write a variable-length string to m.

If m is too short, then WriteString will panic.

func (*Message) WriteUint 

func (m *Message) WriteUint(x uint32)

WriteUint attempts to write a 4-byte unsigned integer to m.

If m is too short, then WriteUint will panic.

type NewId 

type NewId Object

NewId is a wrapper type for Object. It is only used to signify a difference between object and new_id arguments when writing debug log messages.

type Object 

type Object struct {
	// contains filtered or unexported fields
}

Object is the base of every Wayland protocol object.

func (Object) Debug 

func (o Object) Debug() bool

Debug returns whether or not debugging Wayland traffic is enabled.

func (Object) Destroy 

func (o Object) Destroy()

Destroy renders the Object inert and prepares to recycle its ID.

Note: Destroy should only be called by auto-generated code. It is not intended for general use.

func (Object) Enqueue 

func (o Object) Enqueue(m Message)

Enqueue writes the given request into the message queue of the Object's owning Display.

Note: Enqueue should only be called by auto-generated code. It is not intended for general use.

func (Object) GetData 

func (o Object) GetData() any

GetData returns the arbitrary user-data value, if any, attached to this object.

func (Object) GetDisplay 

func (o Object) GetDisplay() *Display

GetDisplay returns the Display that this Object belongs to.

func (Object) GetId 

func (o Object) GetId() uint32

GetId returns the ID of the Object.

func (Object) GetListener 

func (o Object) GetListener() any

GetListener returns the listener object of unknown type (if any) associated with this Object.

func (Object) MakeChild 

func (o Object) MakeChild(id uint32, iface *Interface) (Object, error)

MakeChild creates a child object (i.e. one with the same version but a new ID and interface.)

If an ID of 0 is provided, a new ID will be automatically assigned.

Note: MakeChild should only be called by auto-generated code. It is not intended for general use.

func (Object) SetData 

func (o Object) SetData(data any)

SetData attempts to attach an arbitrary user-provided value to the Object. It is legal to overwrite a non-nil value from a previous call to SetData.

Note: SetData should only be called by auto-generated code. It is not intended for general use.

func (Object) SetListener 

func (o Object) SetListener(listener, data any)

SetListener attempts to attach a user-provided listener vtable to the Object. Overwriting a non-nil value from a previous call to SetListener is illegal and will result in a panic.

Note: SetListener should only be called by auto-generated code. It is not intended for general use.

type Output 

type Output Object

Compositor output region

An output describes part of the compositor geometry. The compositor works in the 'compositor coordinate system' and an output corresponds to a rectangular area in that space that is actually visible. This typically corresponds to a monitor that displays part of the compositor space. This object is published as global during start up, or when a monitor is hotplugged.

func (*Output) Release 

func (S *Output) Release()

Release the output object

Using this request a client can tell the server that it is not going to use the output object anymore.

func (*Output) SetListener 

func (o *Output) SetListener(listener OutputListener, data any)

SetListener sets the event listener for the Output. Overwriting an existing listener is illegal and will result in a panic.

type OutputListener 

type OutputListener struct {
	// # Properties of the output
	//
	// The geometry event describes geometric properties of the output.
	// The event is sent when binding to the output object and whenever
	// any of the properties change.
	//
	// The physical size can be set to zero if it doesn't make sense for this
	// output (e.g. for projectors or virtual outputs).
	//
	// The geometry event will be followed by a done event (starting from
	// version 2).
	//
	// Clients should use wl_surface.preferred_buffer_transform instead of the
	// transform advertised by this event to find the preferred buffer
	// transform to use for a surface.
	//
	// Note: wl_output only advertises partial information about the output
	// position and identification. Some compositors, for instance those not
	// implementing a desktop-style output layout or those exposing virtual
	// outputs, might fake this information. Instead of using x and y, clients
	// should use xdg_output.logical_position. Instead of using make and model,
	// clients should use name and description.
	Geometry func(data any, self Output, x int32, y int32, physicalWidth int32, physicalHeight int32, subpixel OutputSubpixel, make string, model string, transform OutputTransform) error

	// # Advertise available modes for the output
	//
	// The mode event describes an available mode for the output.
	//
	// The event is sent when binding to the output object and there
	// will always be one mode, the current mode.  The event is sent
	// again if an output changes mode, for the mode that is now
	// current.  In other words, the current mode is always the last
	// mode that was received with the current flag set.
	//
	// Non-current modes are deprecated. A compositor can decide to only
	// advertise the current mode and never send other modes. Clients
	// should not rely on non-current modes.
	//
	// The size of a mode is given in physical hardware units of
	// the output device. This is not necessarily the same as
	// the output size in the global compositor space. For instance,
	// the output may be scaled, as described in wl_output.scale,
	// or transformed, as described in wl_output.transform. Clients
	// willing to retrieve the output size in the global compositor
	// space should use xdg_output.logical_size instead.
	//
	// The vertical refresh rate can be set to zero if it doesn't make
	// sense for this output (e.g. for virtual outputs).
	//
	// The mode event will be followed by a done event (starting from
	// version 2).
	//
	// Clients should not use the refresh rate to schedule frames. Instead,
	// they should use the wl_surface.frame event or the presentation-time
	// protocol.
	//
	// Note: this information is not always meaningful for all outputs. Some
	// compositors, such as those exposing virtual outputs, might fake the
	// refresh rate or the size.
	Mode func(data any, self Output, flags OutputMode, width int32, height int32, refresh int32) error

	// # 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. This allows
	// changes to the output properties to be seen as
	// atomic, even if they happen via multiple events.
	Done func(data any, self Output) error

	// # Output scaling properties
	//
	// This event contains scaling geometry information
	// that is not in the geometry event. It may be sent after
	// binding the output object or if the output scale changes
	// later. The compositor will emit a non-zero, positive
	// value for scale. If it is not sent, the client should
	// assume a scale of 1.
	//
	// A scale larger than 1 means that the compositor will
	// automatically scale surface buffers by this amount
	// when rendering. This is used for very high resolution
	// displays where applications rendering at the native
	// resolution would be too small to be legible.
	//
	// Clients should use wl_surface.preferred_buffer_scale
	// instead of this event to find the preferred buffer
	// scale to use for a surface.
	//
	// The scale event will be followed by a done event.
	Scale func(data any, self Output, factor int32) error

	// # 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. The client
	// may wish to know this name as well to offer the user similar behaviors.
	//
	// The name is a UTF-8 string with no convention defined for its contents.
	// Each name is unique among all wl_output globals. The name is only
	// guaranteed to be unique for the compositor instance.
	//
	// The same output name is used for all clients for a given wl_output
	// global. Thus, the name can be shared across processes to refer to a
	// specific wl_output global.
	//
	// The name is not guaranteed to be persistent across sessions, thus cannot
	// be used to reliably identify an output in e.g. configuration files.
	//
	// Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
	// not assume that the name is a reflection of an underlying DRM connector,
	// X11 connection, etc.
	//
	// The name event is sent after binding the output object. This event is
	// only sent once per output object, and the name does not change over the
	// lifetime of the wl_output global.
	//
	// Compositors may re-use the same output name if the wl_output global is
	// destroyed and re-created later. Compositors should avoid re-using the
	// same name if possible.
	//
	// The name event will be followed by a done event.
	Name func(data any, self Output, name string) error

	// # Human-readable description of this output
	//
	// Many compositors can produce human-readable descriptions of their
	// outputs. The client may wish to know this description as well, e.g. for
	// output selection purposes.
	//
	// The description is a UTF-8 string with no convention defined for its
	// contents. The description is not guaranteed to be unique among all
	// wl_output globals. Examples might include 'Foocorp 11" Display' or
	// 'Virtual X11 output via :1'.
	//
	// The description event is sent after binding the output object and
	// whenever the description changes. The description is optional, and may
	// not be sent at all.
	//
	// The description event will be followed by a done event.
	Description func(data any, self Output, description string) error
	// contains filtered or unexported fields
}

type OutputMode 

type OutputMode uint32

Mode information

These flags describe properties of an output mode. They are used in the flags bitfield of the mode event. 

const (
	OutputModeCurrent   OutputMode = 0x1 // Indicates this is the current mode
	OutputModePreferred OutputMode = 0x2 // Indicates this is the preferred mode
)

func (OutputMode) String 

func (v OutputMode) String() string

type OutputSubpixel 

type OutputSubpixel int32

Subpixel geometry information

This enumeration describes how the physical pixels on an output are laid out. 

const (
	OutputSubpixelUnknown       OutputSubpixel = 0 // Unknown geometry
	OutputSubpixelNone          OutputSubpixel = 1 // No geometry
	OutputSubpixelHorizontalRgb OutputSubpixel = 2 // Horizontal RGB
	OutputSubpixelHorizontalBgr OutputSubpixel = 3 // Horizontal BGR
	OutputSubpixelVerticalRgb   OutputSubpixel = 4 // Vertical RGB
	OutputSubpixelVerticalBgr   OutputSubpixel = 5 // Vertical BGR
)

func (OutputSubpixel) String 

func (v OutputSubpixel) String() string

type OutputTransform 

type OutputTransform int32

Transformation applied to buffer contents

This describes transformations that clients and compositors apply to buffer contents.

The flipped values correspond to an initial flip around a vertical axis followed by rotation.

The purpose is mainly to allow clients to render accordingly and tell the compositor, so that for fullscreen surfaces, the compositor will still be able to scan out directly from client surfaces. 

const (
	OutputTransformNormal     OutputTransform = 0 // No transform
	OutputTransform90         OutputTransform = 1 // 90 degrees counter-clockwise
	OutputTransform180        OutputTransform = 2 // 180 degrees counter-clockwise
	OutputTransform270        OutputTransform = 3 // 270 degrees counter-clockwise
	OutputTransformFlipped    OutputTransform = 4 // 180 degree flip around a vertical axis
	OutputTransformFlipped90  OutputTransform = 5 // Flip and rotate 90 degrees counter-clockwise
	OutputTransformFlipped180 OutputTransform = 6 // Flip and rotate 180 degrees counter-clockwise
	OutputTransformFlipped270 OutputTransform = 7 // Flip and rotate 270 degrees counter-clockwise
)

func (OutputTransform) String 

func (v OutputTransform) String() string

type Pointer 

type Pointer Object

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.

The wl_pointer interface generates motion, enter and leave events for the surfaces that the pointer is located over, and button and axis events for button presses, button releases and scrolling.

func (*Pointer) Release 

func (S *Pointer) Release()

Release the pointer object

Using this request a client can tell the server that it is not going to use the pointer object anymore.

This request destroys the pointer proxy object, so clients must not call wl_pointer_destroy() after using this request.

func (*Pointer) SetCursor 

func (S *Pointer) SetCursor(serial uint32, surface Surface, hotspotX int32, hotspotY int32)

Set the pointer surface

Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. If the surface already has another role, it raises a protocol error.

The cursor actually changes only if the pointer focus for this device is one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the pointer image is hidden.

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.

On wl_surface.offset requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. The offset must be applied by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

The input region is ignored for wl_surfaces with the role of a cursor. When the use as a cursor ends, the wl_surface is unmapped.

The serial parameter must match the latest wl_pointer.enter serial number sent to the client. Otherwise the request will be ignored.

func (*Pointer) SetListener 

func (o *Pointer) SetListener(listener PointerListener, data any)

SetListener sets the event listener for the Pointer. Overwriting an existing listener is illegal and will result in a panic.

type PointerAxis 

type PointerAxis int32

Axis types

Describes the axis types of scroll events. 

const (
	PointerAxisVerticalScroll   PointerAxis = 0 // Vertical axis
	PointerAxisHorizontalScroll PointerAxis = 1 // Horizontal axis
)

func (PointerAxis) String 

func (v PointerAxis) String() string

type PointerAxisRelativeDirection 

type PointerAxisRelativeDirection int32

Axis relative direction

This specifies the direction of the physical motion that caused a wl_pointer.axis event, relative to the wl_pointer.axis direction. 

const (
	PointerAxisRelativeDirectionIdentical PointerAxisRelativeDirection = 0 // Physical motion matches axis direction
	PointerAxisRelativeDirectionInverted  PointerAxisRelativeDirection = 1 // Physical motion is the inverse of the axis direction
)

func (PointerAxisRelativeDirection) String 

func (v PointerAxisRelativeDirection) String() string

type PointerAxisSource 

type PointerAxisSource int32

Axis source types

Describes the source types for axis events. This indicates to the client how an axis event was physically generated; a client may adjust the user interface accordingly. For example, scroll events from a "finger" source may be in a smooth coordinate space with kinetic scrolling whereas a "wheel" source may be in discrete steps of a number of lines.

The "continuous" axis source is a device generating events in a continuous coordinate space, but using something other than a finger. One example for this source is button-based scrolling where the vertical motion of a device is converted to scroll events while a button is held down.

The "wheel tilt" axis source indicates that the actual device is a wheel but the scroll event is not caused by a rotation but a (usually sideways) tilt of the wheel. 

const (
	PointerAxisSourceWheel      PointerAxisSource = 0 // A physical wheel rotation
	PointerAxisSourceFinger     PointerAxisSource = 1 // Finger on a touch surface
	PointerAxisSourceContinuous PointerAxisSource = 2 // Continuous coordinate space
	PointerAxisSourceWheelTilt  PointerAxisSource = 3 // A physical wheel tilt
)

func (PointerAxisSource) String 

func (v PointerAxisSource) String() string

type PointerButtonState 

type PointerButtonState int32

Physical button state

Describes the physical state of a button that produced the button event. 

const (
	PointerButtonStateReleased PointerButtonState = 0 // The button is not pressed
	PointerButtonStatePressed  PointerButtonState = 1 // The button is pressed
)

func (PointerButtonState) String 

func (v PointerButtonState) String() string

type PointerError 

type PointerError int32
const (
	PointerErrorRole PointerError = 0 // Given wl_surface has another role
)

func (PointerError) String 

func (v PointerError) String() string

type PointerListener 

type PointerListener struct {
	// # Enter event
	//
	// Notification that this seat's pointer is focused on a certain
	// surface.
	//
	// When a seat's focus enters a surface, the pointer image
	// is undefined and a client should respond to this event by setting
	// an appropriate pointer image with the set_cursor request.
	Enter func(data any, self Pointer, serial uint32, surface Surface, surfaceX float64, surfaceY float64) error

	// # Leave event
	//
	// Notification that this seat's pointer is no longer focused on
	// a certain surface.
	//
	// The leave notification is sent before the enter notification
	// for the new focus.
	Leave func(data any, self Pointer, serial uint32, surface Surface) error

	// # Pointer motion event
	//
	// Notification of pointer location change. The arguments
	// surface_x and surface_y are the location relative to the
	// focused surface.
	Motion func(data any, self Pointer, time uint32, surfaceX float64, surfaceY float64) error

	// # Pointer button event
	//
	// Mouse button click and release notifications.
	//
	// The location of the click is given by the last motion or
	// enter event.
	// The time argument is a timestamp with millisecond
	// granularity, with an undefined base.
	//
	// The button is a button code as defined in the Linux kernel's
	// linux/input-event-codes.h header file, e.g. BTN_LEFT.
	//
	// Any 16-bit button code value is reserved for future additions to the
	// kernel's event code list. All other button codes above 0xFFFF are
	// currently undefined but may be used in future versions of this
	// protocol.
	Button func(data any, self Pointer, serial uint32, time uint32, button uint32, state PointerButtonState) error

	// # Axis event
	//
	// Scroll and other axis notifications.
	//
	// For scroll events (vertical and horizontal scroll axes), the
	// value parameter is the length of a vector along the specified
	// axis in a coordinate space identical to those of motion events,
	// representing a relative movement along the specified axis.
	//
	// For devices that support movements non-parallel to axes multiple
	// axis events will be emitted.
	//
	// When applicable, for example for touch pads, the server can
	// choose to emit scroll events where the motion vector is
	// equivalent to a motion event vector.
	//
	// When applicable, a client can transform its content relative to the
	// scroll distance.
	Axis func(data any, self Pointer, time uint32, axis PointerAxis, value float64) error

	// # End of a pointer event sequence
	//
	// Indicates the end of a set of events that logically belong together.
	// A client is expected to accumulate the data in all events within the
	// frame before proceeding.
	//
	// All wl_pointer events before a wl_pointer.frame event belong
	// logically together. For example, in a diagonal scroll motion the
	// compositor will send an optional wl_pointer.axis_source event, two
	// wl_pointer.axis events (horizontal and vertical) and finally a
	// wl_pointer.frame event. The client may use this information to
	// calculate a diagonal vector for scrolling.
	//
	// When multiple wl_pointer.axis events occur within the same frame,
	// the motion vector is the combined motion of all events.
	// When a wl_pointer.axis and a wl_pointer.axis_stop event occur within
	// the same frame, this indicates that axis movement in one axis has
	// stopped but continues in the other axis.
	// When multiple wl_pointer.axis_stop events occur within the same
	// frame, this indicates that these axes stopped in the same instance.
	//
	// A wl_pointer.frame event is sent for every logical event group,
	// even if the group only contains a single wl_pointer event.
	// Specifically, a client may get a sequence: motion, frame, button,
	// frame, axis, frame, axis_stop, frame.
	//
	// The wl_pointer.enter and wl_pointer.leave events are logical events
	// generated by the compositor and not the hardware. These events are
	// also grouped by a wl_pointer.frame. When a pointer moves from one
	// surface to another, a compositor should group the
	// wl_pointer.leave event within the same wl_pointer.frame.
	// However, a client must not rely on wl_pointer.leave and
	// wl_pointer.enter being in the same wl_pointer.frame.
	// Compositor-specific policies may require the wl_pointer.leave and
	// wl_pointer.enter event being split across multiple wl_pointer.frame
	// groups.
	Frame func(data any, self Pointer) error

	// # Axis source event
	//
	// Source information for scroll and other axes.
	//
	// This event does not occur on its own. It is sent before a
	// wl_pointer.frame event and carries the source information for
	// all events within that frame.
	//
	// The source specifies how this event was generated. If the source is
	// wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be
	// sent when the user lifts the finger off the device.
	//
	// If the source is wl_pointer.axis_source.wheel,
	// wl_pointer.axis_source.wheel_tilt or
	// wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may
	// or may not be sent. Whether a compositor sends an axis_stop event
	// for these sources is hardware-specific and implementation-dependent;
	// clients must not rely on receiving an axis_stop event for these
	// scroll sources and should treat scroll sequences from these scroll
	// sources as unterminated by default.
	//
	// This event is optional. If the source is unknown for a particular
	// axis event sequence, no event is sent.
	// Only one wl_pointer.axis_source event is permitted per frame.
	//
	// The order of wl_pointer.axis_discrete and wl_pointer.axis_source is
	// not guaranteed.
	AxisSource func(data any, self Pointer, axisSource PointerAxisSource) error

	// # Axis stop event
	//
	// Stop notification for scroll and other axes.
	//
	// For some wl_pointer.axis_source types, a wl_pointer.axis_stop event
	// is sent to notify a client that the axis sequence has terminated.
	// This enables the client to implement kinetic scrolling.
	// See the wl_pointer.axis_source documentation for information on when
	// this event may be generated.
	//
	// Any wl_pointer.axis events with the same axis_source after this
	// event should be considered as the start of a new axis motion.
	//
	// The timestamp is to be interpreted identical to the timestamp in the
	// wl_pointer.axis event. The timestamp value may be the same as a
	// preceding wl_pointer.axis event.
	AxisStop func(data any, self Pointer, time uint32, axis PointerAxis) error

	// # Axis click event
	//
	// Discrete step information for scroll and other axes.
	//
	// This event carries the axis value of the wl_pointer.axis event in
	// discrete steps (e.g. mouse wheel clicks).
	//
	// This event is deprecated with wl_pointer version 8 - this event is not
	// sent to clients supporting version 8 or later.
	//
	// This event does not occur on its own, it is coupled with a
	// wl_pointer.axis event that represents this axis value on a
	// continuous scale. The protocol guarantees that each axis_discrete
	// event is always followed by exactly one axis event with the same
	// axis number within the same wl_pointer.frame. Note that the protocol
	// allows for other events to occur between the axis_discrete and
	// its coupled axis event, including other axis_discrete or axis
	// events. A wl_pointer.frame must not contain more than one axis_discrete
	// event per axis type.
	//
	// This event is optional; continuous scrolling devices
	// like two-finger scrolling on touchpads do not have discrete
	// steps and do not generate this event.
	//
	// The discrete value carries the directional information. e.g. a value
	// of -2 is two steps towards the negative direction of this axis.
	//
	// The axis number is identical to the axis number in the associated
	// axis event.
	//
	// The order of wl_pointer.axis_discrete and wl_pointer.axis_source is
	// not guaranteed.
	//
	// Deprecated: This item was deprecated in version 8.
	AxisDiscrete func(data any, self Pointer, axis PointerAxis, discrete int32) error

	// # Axis high-resolution scroll event
	//
	// Discrete high-resolution scroll information.
	//
	// This event carries high-resolution wheel scroll information,
	// with each multiple of 120 representing one logical scroll step
	// (a wheel detent). For example, an axis_value120 of 30 is one quarter of
	// a logical scroll step in the positive direction, a value120 of
	// -240 are two logical scroll steps in the negative direction within the
	// same hardware event.
	// Clients that rely on discrete scrolling should accumulate the
	// value120 to multiples of 120 before processing the event.
	//
	// The value120 must not be zero.
	//
	// This event replaces the wl_pointer.axis_discrete event in clients
	// supporting wl_pointer version 8 or later.
	//
	// Where a wl_pointer.axis_source event occurs in the same
	// wl_pointer.frame, the axis source applies to this event.
	//
	// The order of wl_pointer.axis_value120 and wl_pointer.axis_source is
	// not guaranteed.
	AxisValue120 func(data any, self Pointer, axis PointerAxis, value120 int32) error

	// # Axis relative physical direction event
	//
	// Relative directional information of the entity causing the axis
	// motion.
	//
	// For a wl_pointer.axis event, the wl_pointer.axis_relative_direction
	// event specifies the movement direction of the entity causing the
	// wl_pointer.axis event. For example:
	//   - if a user's fingers on a touchpad move down and this
	//     causes a wl_pointer.axis vertical_scroll down event, the physical
	//     direction is 'identical'
	//   - if a user's fingers on a touchpad move down and this causes a
	//     wl_pointer.axis vertical_scroll up scroll up event ('natural
	//     scrolling'), the physical direction is 'inverted'.
	//
	// A client may use this information to adjust scroll motion of
	// components. Specifically, enabling natural scrolling causes the
	// content to change direction compared to traditional scrolling.
	// Some widgets like volume control sliders should usually match the
	// physical direction regardless of whether natural scrolling is
	// active. This event enables clients to match the scroll direction of
	// a widget to the physical direction.
	//
	// This event does not occur on its own, it is coupled with a
	// wl_pointer.axis event that represents this axis value.
	// The protocol guarantees that each axis_relative_direction event is
	// always followed by exactly one axis event with the same
	// axis number within the same wl_pointer.frame. Note that the protocol
	// allows for other events to occur between the axis_relative_direction
	// and its coupled axis event.
	//
	// The axis number is identical to the axis number in the associated
	// axis event.
	//
	// The order of wl_pointer.axis_relative_direction,
	// wl_pointer.axis_discrete and wl_pointer.axis_source is not
	// guaranteed.
	AxisRelativeDirection func(data any, self Pointer, axis PointerAxis, direction PointerAxisRelativeDirection) error
	// contains filtered or unexported fields
}

type Region 

type Region Object

Region interface

A region object describes an area.

Region objects are used to describe the opaque and input regions of a surface.

func (*Region) Add 

func (S *Region) Add(x int32, y int32, width int32, height int32)

Add rectangle to region

Add the specified rectangle to the region.

func (*Region) Destroy 

func (S *Region) Destroy()

Destroy region

Destroy the region. This will invalidate the object ID.

func (*Region) Subtract 

func (S *Region) Subtract(x int32, y int32, width int32, height int32)

Subtract rectangle from region

Subtract the specified rectangle from the region.

type Registry 

type Registry Object

Global registry object

The singleton global registry object. The server has a number of global objects that are available to all clients. These objects typically represent an actual object in the server (for example, an input device) or they are singleton objects that provide extension functionality.

When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device or monitor hotplugs, reconfiguration or other events, and the registry will send out global and global_remove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the wl_display.sync request immediately after calling wl_display.get_registry.

A client can bind to a global object by using the bind request. This creates a client-side handle that lets the object emit events to the client and lets the client invoke requests on the object.

func (*Registry) Bind 

func (S *Registry) Bind(name uint32, id *Interface, idVersion uint32) Object

Bind an object to the display

Binds a new, client-created object to the server using the specified name as the identifier.

func (*Registry) Destroy 

func (o *Registry) Destroy()

Destroy renders the Registry inert and prepares to recycle its ID.

func (*Registry) SetListener 

func (o *Registry) SetListener(listener RegistryListener, data any)

SetListener sets the event listener for the Registry. Overwriting an existing listener is illegal and will result in a panic.

type RegistryListener 

type RegistryListener struct {
	// # Announce global object
	//
	// Notify the client of global objects.
	//
	// The event notifies the client that a global object with
	// the given name is now available, and it implements the
	// given version of the given interface.
	Global func(data any, self Registry, name uint32, iface string, version uint32) error

	// # Announce removal of global object
	//
	// Notify the client of removed global objects.
	//
	// This event notifies the client that the global identified
	// by name is no longer available.  If the client bound to
	// the global using the bind request, the client should now
	// destroy that object.
	//
	// The object remains valid and requests to the object will be
	// ignored until the client destroys it, to avoid races between
	// the global going away and a client sending a request to it.
	GlobalRemove func(data any, self Registry, name uint32) error
	// contains filtered or unexported fields
}

type Seat 

type Seat Object

Group of input devices

A seat is a group of keyboards, pointer and touch devices. This object is published as a global during start up, or when such a device is hot plugged. A seat typically has a pointer and maintains a keyboard focus and a pointer focus.

func (*Seat) GetKeyboard 

func (S *Seat) GetKeyboard() Keyboard

Return keyboard object

The ID provided will be initialized to the wl_keyboard interface for this seat.

This request only takes effect if the seat has the keyboard capability, or has had the keyboard capability in the past. It is a protocol violation to issue this request on a seat that has never had the keyboard capability. The missing_capability error will be sent in this case.

func (*Seat) GetPointer 

func (S *Seat) GetPointer() Pointer

Return pointer object

The ID provided will be initialized to the wl_pointer interface for this seat.

This request only takes effect if the seat has the pointer capability, or has had the pointer capability in the past. It is a protocol violation to issue this request on a seat that has never had the pointer capability. The missing_capability error will be sent in this case.

func (*Seat) GetTouch 

func (S *Seat) GetTouch() Touch

Return touch object

The ID provided will be initialized to the wl_touch interface for this seat.

This request only takes effect if the seat has the touch capability, or has had the touch capability in the past. It is a protocol violation to issue this request on a seat that has never had the touch capability. The missing_capability error will be sent in this case.

func (*Seat) Release 

func (S *Seat) Release()

Release the seat object

Using this request a client can tell the server that it is not going to use the seat object anymore.

func (*Seat) SetListener 

func (o *Seat) SetListener(listener SeatListener, data any)

SetListener sets the event listener for the Seat. Overwriting an existing listener is illegal and will result in a panic.

type SeatCapability 

type SeatCapability uint32

Seat capability bitmask

This is a bitmask of capabilities this seat has; if a member is set, then it is present on the seat. 

const (
	SeatCapabilityPointer  SeatCapability = 1 // The seat has pointer devices
	SeatCapabilityKeyboard SeatCapability = 2 // The seat has one or more keyboards
	SeatCapabilityTouch    SeatCapability = 4 // The seat has touch devices
)

func (SeatCapability) String 

func (v SeatCapability) String() string

type SeatError 

type SeatError int32

wl_seat error values

These errors can be emitted in response to wl_seat requests. 

const (
	SeatErrorMissingCapability SeatError = 0 // get_pointer, get_keyboard or get_touch called on seat without the matching capability
)

func (SeatError) String 

func (v SeatError) String() string

type SeatListener 

type SeatListener struct {
	// # Seat capabilities changed
	//
	// This is emitted whenever a seat gains or loses the pointer,
	// keyboard or touch capabilities.  The argument is a capability
	// enum containing the complete set of capabilities this seat has.
	//
	// When the pointer capability is added, a client may create a
	// wl_pointer object using the wl_seat.get_pointer request. This object
	// will receive pointer events until the capability is removed in the
	// future.
	//
	// When the pointer capability is removed, a client should destroy the
	// wl_pointer objects associated with the seat where the capability was
	// removed, using the wl_pointer.release request. No further pointer
	// events will be received on these objects.
	//
	// In some compositors, if a seat regains the pointer capability and a
	// client has a previously obtained wl_pointer object of version 4 or
	// less, that object may start sending pointer events again. This
	// behavior is considered a misinterpretation of the intended behavior
	// and must not be relied upon by the client. wl_pointer objects of
	// version 5 or later must not send events if created before the most
	// recent event notifying the client of an added pointer capability.
	//
	// The above behavior also applies to wl_keyboard and wl_touch with the
	// keyboard and touch capabilities, respectively.
	Capabilities func(data any, self Seat, capabilities SeatCapability) error

	// # 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.
	//
	// The seat name is a UTF-8 string with no convention defined for its
	// contents. Each name is unique among all wl_seat globals. The name is
	// only guaranteed to be unique for the current compositor instance.
	//
	// The same seat names are used for all clients. Thus, the name can be
	// shared across processes to refer to a specific wl_seat global.
	//
	// The name event is sent after binding to the seat global. This event is
	// only sent once per seat object, and the name does not change over the
	// lifetime of the wl_seat global.
	//
	// Compositors may re-use the same seat name if the wl_seat global is
	// destroyed and re-created later.
	Name func(data any, self Seat, name string) error
	// contains filtered or unexported fields
}

type Shell 

type Shell Object

Create desktop-style surfaces

This interface is implemented by servers that provide desktop-style user interfaces.

It allows clients to associate a wl_shell_surface with a basic surface.

Note! This protocol is deprecated and not intended for production use. For desktop-style user interfaces, use xdg_shell. Compositors and clients should not implement this interface.

func (*Shell) Destroy 

func (o *Shell) Destroy()

Destroy renders the Shell inert and prepares to recycle its ID.

func (*Shell) GetShellSurface 

func (S *Shell) GetShellSurface(surface Surface) ShellSurface

Create a shell surface from a surface

Create a shell surface for an existing surface. This gives the wl_surface the role of a shell surface. If the wl_surface already has another role, it raises a protocol error.

Only one shell surface can be associated with a given surface.

type ShellError 

type ShellError int32
const (
	ShellErrorRole ShellError = 0 // Given wl_surface has another role
)

func (ShellError) String 

func (v ShellError) String() string

type ShellSurface 

type ShellSurface Object

Desktop-style metadata interface

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.

It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc.

On the server side the object is automatically destroyed when the related wl_surface is destroyed. On the client side, wl_shell_surface_destroy() must be called before destroying the wl_surface object.

func (*ShellSurface) Destroy 

func (o *ShellSurface) Destroy()

Destroy renders the ShellSurface inert and prepares to recycle its ID.

func (*ShellSurface) Move 

func (S *ShellSurface) Move(seat Seat, serial uint32)

Start an interactive move

Start a pointer-driven move of the surface.

This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized).

func (*ShellSurface) Pong 

func (S *ShellSurface) Pong(serial uint32)

Respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

func (*ShellSurface) Resize 

func (S *ShellSurface) Resize(seat Seat, serial uint32, edges ShellSurfaceResize)

Start an interactive resize

Start a pointer-driven resizing of the surface.

This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

func (*ShellSurface) SetClass 

func (S *ShellSurface) SetClass(class string)

Set surface class

Set a class for the surface.

The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class.

func (*ShellSurface) SetFullscreen 

func (S *ShellSurface) SetFullscreen(method ShellSurfaceFullscreenMethod, framerate uint32, output Output)

Make the surface a fullscreen surface

Map the surface as a fullscreen surface.

If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter.

The framerate parameter is used only when the method is set to "driver", to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz.

A method of "scale" or "driver" implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale.

A method of "fill" means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen.

The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.

func (*ShellSurface) SetListener 

func (o *ShellSurface) SetListener(listener ShellSurfaceListener, data any)

SetListener sets the event listener for the ShellSurface. Overwriting an existing listener is illegal and will result in a panic.

func (*ShellSurface) SetMaximized 

func (S *ShellSurface) SetMaximized(output Output)

Make the surface a maximized surface

Map the surface as a maximized surface.

If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface.

A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface.

The details depend on the compositor implementation.

func (*ShellSurface) SetPopup 

func (S *ShellSurface) SetPopup(seat Seat, serial uint32, parent Surface, x int32, y int32, flags ShellSurfaceTransient)

Make the surface a popup surface

Map the surface as a popup.

A popup surface is a transient surface with an added pointer grab.

An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped).

The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

func (*ShellSurface) SetTitle 

func (S *ShellSurface) SetTitle(title string)

Set surface title

Set a short title for the surface.

This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor.

The string must be encoded in UTF-8.

func (*ShellSurface) SetToplevel 

func (S *ShellSurface) SetToplevel()

Make the surface a toplevel surface

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

func (*ShellSurface) SetTransient 

func (S *ShellSurface) SetTransient(parent Surface, x int32, y int32, flags ShellSurfaceTransient)

Make the surface a transient surface

Map the surface relative to an existing surface.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

The flags argument controls details of the transient behaviour.

type ShellSurfaceFullscreenMethod 

type ShellSurfaceFullscreenMethod int32

Different method to set the surface fullscreen

Hints to indicate to the compositor how to deal with a conflict between the dimensions of the surface and the dimensions of the output. The compositor is free to ignore this parameter. 

const (
	ShellSurfaceFullscreenMethodDefault ShellSurfaceFullscreenMethod = 0 // No preference, apply default policy
	ShellSurfaceFullscreenMethodScale   ShellSurfaceFullscreenMethod = 1 // Scale, preserve the surface's aspect ratio and center on output
	ShellSurfaceFullscreenMethodDriver  ShellSurfaceFullscreenMethod = 2 // Switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch
	ShellSurfaceFullscreenMethodFill    ShellSurfaceFullscreenMethod = 3 // No upscaling, center on output and add black borders to compensate size mismatch
)

func (ShellSurfaceFullscreenMethod) String 

func (v ShellSurfaceFullscreenMethod) String() string

type ShellSurfaceListener 

type ShellSurfaceListener struct {
	// # Ping client
	//
	// Ping a client to check if it is receiving events and sending
	// requests. A client is expected to reply with a pong request.
	Ping func(data any, self ShellSurface, serial uint32) error

	// # Suggest resize
	//
	// The configure event asks the client to resize its surface.
	//
	// The size is a hint, in the sense that the client is free to
	// ignore it if it doesn't resize, pick a smaller size (to
	// satisfy aspect ratio or resize in steps of NxM pixels).
	//
	// The edges parameter provides a hint about how the surface
	// was resized. The client may use this information to decide
	// how to adjust its content to the new size (e.g. a scrolling
	// area might adjust its content position to leave the viewable
	// content unmoved).
	//
	// The client is free to dismiss all but the last configure
	// event it received.
	//
	// The width and height arguments specify the size of the window
	// in surface-local coordinates.
	Configure func(data any, self ShellSurface, edges ShellSurfaceResize, width int32, height int32) error

	// # 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.
	PopupDone func(data any, self ShellSurface) error
	// contains filtered or unexported fields
}

type ShellSurfaceResize 

type ShellSurfaceResize uint32

Edge values for resizing

These values are used to indicate which edge of a surface is being dragged in a resize operation. The server may use this information to adapt its behavior, e.g. choose an appropriate cursor image. 

const (
	ShellSurfaceResizeNone        ShellSurfaceResize = 0  // No edge
	ShellSurfaceResizeTop         ShellSurfaceResize = 1  // Top edge
	ShellSurfaceResizeBottom      ShellSurfaceResize = 2  // Bottom edge
	ShellSurfaceResizeLeft        ShellSurfaceResize = 4  // Left edge
	ShellSurfaceResizeTopLeft     ShellSurfaceResize = 5  // Top and left edges
	ShellSurfaceResizeBottomLeft  ShellSurfaceResize = 6  // Bottom and left edges
	ShellSurfaceResizeRight       ShellSurfaceResize = 8  // Right edge
	ShellSurfaceResizeTopRight    ShellSurfaceResize = 9  // Top and right edges
	ShellSurfaceResizeBottomRight ShellSurfaceResize = 10 // Bottom and right edges
)

func (ShellSurfaceResize) String 

func (v ShellSurfaceResize) String() string

type ShellSurfaceTransient 

type ShellSurfaceTransient uint32

Details of transient behaviour

These flags specify details of the expected behaviour of transient surfaces. Used in the set_transient request. 

const (
	ShellSurfaceTransientInactive ShellSurfaceTransient = 0x1 // Do not set keyboard focus
)

func (ShellSurfaceTransient) String 

func (v ShellSurfaceTransient) String() string

type Shm 

type Shm Object

Shared memory support

A singleton global object that provides support for shared memory.

Clients can create wl_shm_pool objects using the create_pool request.

On binding the wl_shm object one or more format events are emitted to inform clients about the valid pixel formats that can be used for buffers.

func (*Shm) CreatePool 

func (S *Shm) CreatePool(fd int, size int32) ShmPool

Create a shm pool

Create a new wl_shm_pool object.

The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool.

func (*Shm) Release 

func (S *Shm) Release()

Release the shm object

Using this request a client can tell the server that it is not going to use the shm object anymore.

Objects created via this interface remain unaffected.

func (*Shm) SetListener 

func (o *Shm) SetListener(listener ShmListener, data any)

SetListener sets the event listener for the Shm. Overwriting an existing listener is illegal and will result in a panic.

type ShmError 

type ShmError int32

wl_shm error values

These errors can be emitted in response to wl_shm requests. 

const (
	ShmErrorInvalidFormat ShmError = 0 // Buffer format is not known
	ShmErrorInvalidStride ShmError = 1 // Invalid size or stride during pool or buffer creation
	ShmErrorInvalidFd     ShmError = 2 // Mmapping the file descriptor failed
)

func (ShmError) String 

func (v ShmError) String() string

type ShmFormat 

type ShmFormat int32

Pixel formats

This describes the memory layout of an individual pixel.

All renderers should support argb8888 and xrgb8888 but any other formats are optional and may not be supported by the particular renderer in use.

The drm format codes match the macros defined in drm_fourcc.h, except argb8888 and xrgb8888. The formats actually supported by the compositor will be reported by the format event.

For all wl_shm formats and unless specified in another protocol extension, pre-multiplied alpha is used for pixel values. 

const (
	ShmFormatArgb8888             ShmFormat = 0          // 32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian
	ShmFormatXrgb8888             ShmFormat = 1          // 32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian
	ShmFormatC8                   ShmFormat = 0x20203843 // 8-bit color index format, [7:0] C
	ShmFormatRgb332               ShmFormat = 0x38424752 // 8-bit RGB format, [7:0] R:G:B 3:3:2
	ShmFormatBgr233               ShmFormat = 0x38524742 // 8-bit BGR format, [7:0] B:G:R 2:3:3
	ShmFormatXrgb4444             ShmFormat = 0x32315258 // 16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian
	ShmFormatXbgr4444             ShmFormat = 0x32314258 // 16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian
	ShmFormatRgbx4444             ShmFormat = 0x32315852 // 16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian
	ShmFormatBgrx4444             ShmFormat = 0x32315842 // 16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian
	ShmFormatArgb4444             ShmFormat = 0x32315241 // 16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian
	ShmFormatAbgr4444             ShmFormat = 0x32314241 // 16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian
	ShmFormatRgba4444             ShmFormat = 0x32314152 // 16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian
	ShmFormatBgra4444             ShmFormat = 0x32314142 // 16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian
	ShmFormatXrgb1555             ShmFormat = 0x35315258 // 16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian
	ShmFormatXbgr1555             ShmFormat = 0x35314258 // 16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian
	ShmFormatRgbx5551             ShmFormat = 0x35315852 // 16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian
	ShmFormatBgrx5551             ShmFormat = 0x35315842 // 16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian
	ShmFormatArgb1555             ShmFormat = 0x35315241 // 16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian
	ShmFormatAbgr1555             ShmFormat = 0x35314241 // 16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian
	ShmFormatRgba5551             ShmFormat = 0x35314152 // 16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian
	ShmFormatBgra5551             ShmFormat = 0x35314142 // 16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian
	ShmFormatRgb565               ShmFormat = 0x36314752 // 16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian
	ShmFormatBgr565               ShmFormat = 0x36314742 // 16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian
	ShmFormatRgb888               ShmFormat = 0x34324752 // 24-bit RGB format, [23:0] R:G:B little endian
	ShmFormatBgr888               ShmFormat = 0x34324742 // 24-bit BGR format, [23:0] B:G:R little endian
	ShmFormatXbgr8888             ShmFormat = 0x34324258 // 32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian
	ShmFormatRgbx8888             ShmFormat = 0x34325852 // 32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian
	ShmFormatBgrx8888             ShmFormat = 0x34325842 // 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian
	ShmFormatAbgr8888             ShmFormat = 0x34324241 // 32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian
	ShmFormatRgba8888             ShmFormat = 0x34324152 // 32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian
	ShmFormatBgra8888             ShmFormat = 0x34324142 // 32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian
	ShmFormatXrgb2101010          ShmFormat = 0x30335258 // 32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian
	ShmFormatXbgr2101010          ShmFormat = 0x30334258 // 32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian
	ShmFormatRgbx1010102          ShmFormat = 0x30335852 // 32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian
	ShmFormatBgrx1010102          ShmFormat = 0x30335842 // 32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian
	ShmFormatArgb2101010          ShmFormat = 0x30335241 // 32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian
	ShmFormatAbgr2101010          ShmFormat = 0x30334241 // 32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian
	ShmFormatRgba1010102          ShmFormat = 0x30334152 // 32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian
	ShmFormatBgra1010102          ShmFormat = 0x30334142 // 32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian
	ShmFormatYuyv                 ShmFormat = 0x56595559 // Packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian
	ShmFormatYvyu                 ShmFormat = 0x55595659 // Packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian
	ShmFormatUyvy                 ShmFormat = 0x59565955 // Packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian
	ShmFormatVyuy                 ShmFormat = 0x59555956 // Packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian
	ShmFormatAyuv                 ShmFormat = 0x56555941 // Packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian
	ShmFormatNv12                 ShmFormat = 0x3231564e // 2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane
	ShmFormatNv21                 ShmFormat = 0x3132564e // 2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane
	ShmFormatNv16                 ShmFormat = 0x3631564e // 2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane
	ShmFormatNv61                 ShmFormat = 0x3136564e // 2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane
	ShmFormatYuv410               ShmFormat = 0x39565559 // 3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu410               ShmFormat = 0x39555659 // 3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv411               ShmFormat = 0x31315559 // 3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu411               ShmFormat = 0x31315659 // 3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv420               ShmFormat = 0x32315559 // 3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu420               ShmFormat = 0x32315659 // 3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv422               ShmFormat = 0x36315559 // 3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu422               ShmFormat = 0x36315659 // 3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv444               ShmFormat = 0x34325559 // 3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu444               ShmFormat = 0x34325659 // 3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes
	ShmFormatR8                   ShmFormat = 0x20203852 // [7:0] R
	ShmFormatR16                  ShmFormat = 0x20363152 // [15:0] R little endian
	ShmFormatRg88                 ShmFormat = 0x38384752 // [15:0] R:G 8:8 little endian
	ShmFormatGr88                 ShmFormat = 0x38385247 // [15:0] G:R 8:8 little endian
	ShmFormatRg1616               ShmFormat = 0x32334752 // [31:0] R:G 16:16 little endian
	ShmFormatGr1616               ShmFormat = 0x32335247 // [31:0] G:R 16:16 little endian
	ShmFormatXrgb16161616f        ShmFormat = 0x48345258 // [63:0] x:R:G:B 16:16:16:16 little endian
	ShmFormatXbgr16161616f        ShmFormat = 0x48344258 // [63:0] x:B:G:R 16:16:16:16 little endian
	ShmFormatArgb16161616f        ShmFormat = 0x48345241 // [63:0] A:R:G:B 16:16:16:16 little endian
	ShmFormatAbgr16161616f        ShmFormat = 0x48344241 // [63:0] A:B:G:R 16:16:16:16 little endian
	ShmFormatXyuv8888             ShmFormat = 0x56555958 // [31:0] X:Y:Cb:Cr 8:8:8:8 little endian
	ShmFormatVuy888               ShmFormat = 0x34325556 // [23:0] Cr:Cb:Y 8:8:8 little endian
	ShmFormatVuy101010            ShmFormat = 0x30335556 // Y followed by U then V, 10:10:10. Non-linear modifier only
	ShmFormatY210                 ShmFormat = 0x30313259 // [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                 ShmFormat = 0x32313259 // [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                 ShmFormat = 0x36313259 // [63:0] Cr0:Y1:Cb0:Y0 16:16:16:16 little endian per 2 Y pixels
	ShmFormatY410                 ShmFormat = 0x30313459 // [31:0] A:Cr:Y:Cb 2:10:10:10 little endian
	ShmFormatY412                 ShmFormat = 0x32313459 // [63:0] A:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian
	ShmFormatY416                 ShmFormat = 0x36313459 // [63:0] A:Cr:Y:Cb 16:16:16:16 little endian
	ShmFormatXvyu2101010          ShmFormat = 0x30335658 // [31:0] X:Cr:Y:Cb 2:10:10:10 little endian
	ShmFormatXvyu1216161616       ShmFormat = 0x36335658 // [63:0] X:0:Cr:0:Y:0:Cb:0 12:4:12:4:12:4:12:4 little endian
	ShmFormatXvyu16161616         ShmFormat = 0x38345658 // [63:0] X:Cr:Y:Cb 16:16:16:16 little endian
	ShmFormatY0l0                 ShmFormat = 0x304c3059 // [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
	ShmFormatX0l0                 ShmFormat = 0x304c3058 // [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
	ShmFormatY0l2                 ShmFormat = 0x324c3059 // [63:0]   A3:A2:Y3:Cr0:Y2:A1:A0:Y1:Cb0:Y0  1:1:10:10:10:1:1:10:10:10 little endian
	ShmFormatX0l2                 ShmFormat = 0x324c3058 // [63:0]   X3:X2:Y3:Cr0:Y2:X1:X0:Y1:Cb0:Y0  1:1:10:10:10:1:1:10:10:10 little endian
	ShmFormatYuv4208bit           ShmFormat = 0x38305559
	ShmFormatYuv42010bit          ShmFormat = 0x30315559
	ShmFormatXrgb8888A8           ShmFormat = 0x38415258
	ShmFormatXbgr8888A8           ShmFormat = 0x38414258
	ShmFormatRgbx8888A8           ShmFormat = 0x38415852
	ShmFormatBgrx8888A8           ShmFormat = 0x38415842
	ShmFormatRgb888A8             ShmFormat = 0x38413852
	ShmFormatBgr888A8             ShmFormat = 0x38413842
	ShmFormatRgb565A8             ShmFormat = 0x38413552
	ShmFormatBgr565A8             ShmFormat = 0x38413542
	ShmFormatNv24                 ShmFormat = 0x3432564e // Non-subsampled Cr:Cb plane
	ShmFormatNv42                 ShmFormat = 0x3234564e // Non-subsampled Cb:Cr plane
	ShmFormatP210                 ShmFormat = 0x30313250 // 2x1 subsampled Cr:Cb plane, 10 bit per channel
	ShmFormatP010                 ShmFormat = 0x30313050 // 2x2 subsampled Cr:Cb plane 10 bits per channel
	ShmFormatP012                 ShmFormat = 0x32313050 // 2x2 subsampled Cr:Cb plane 12 bits per channel
	ShmFormatP016                 ShmFormat = 0x36313050 // 2x2 subsampled Cr:Cb plane 16 bits per channel
	ShmFormatAxbxgxrx106106106106 ShmFormat = 0x30314241 // [63:0] A:x:B:x:G:x:R:x 10:6:10:6:10:6:10:6 little endian
	ShmFormatNv15                 ShmFormat = 0x3531564e // 2x2 subsampled Cr:Cb plane
	ShmFormatQ410                 ShmFormat = 0x30313451
	ShmFormatQ401                 ShmFormat = 0x31303451
	ShmFormatXrgb16161616         ShmFormat = 0x38345258 // [63:0] x:R:G:B 16:16:16:16 little endian
	ShmFormatXbgr16161616         ShmFormat = 0x38344258 // [63:0] x:B:G:R 16:16:16:16 little endian
	ShmFormatArgb16161616         ShmFormat = 0x38345241 // [63:0] A:R:G:B 16:16:16:16 little endian
	ShmFormatAbgr16161616         ShmFormat = 0x38344241 // [63:0] A:B:G:R 16:16:16:16 little endian
	ShmFormatC1                   ShmFormat = 0x20203143 // [7:0] C0:C1:C2:C3:C4:C5:C6:C7 1:1:1:1:1:1:1:1 eight pixels/byte
	ShmFormatC2                   ShmFormat = 0x20203243 // [7:0] C0:C1:C2:C3 2:2:2:2 four pixels/byte
	ShmFormatC4                   ShmFormat = 0x20203443 // [7:0] C0:C1 4:4 two pixels/byte
	ShmFormatD1                   ShmFormat = 0x20203144 // [7:0] D0:D1:D2:D3:D4:D5:D6:D7 1:1:1:1:1:1:1:1 eight pixels/byte
	ShmFormatD2                   ShmFormat = 0x20203244 // [7:0] D0:D1:D2:D3 2:2:2:2 four pixels/byte
	ShmFormatD4                   ShmFormat = 0x20203444 // [7:0] D0:D1 4:4 two pixels/byte
	ShmFormatD8                   ShmFormat = 0x20203844 // [7:0] D
	ShmFormatR1                   ShmFormat = 0x20203152 // [7:0] R0:R1:R2:R3:R4:R5:R6:R7 1:1:1:1:1:1:1:1 eight pixels/byte
	ShmFormatR2                   ShmFormat = 0x20203252 // [7:0] R0:R1:R2:R3 2:2:2:2 four pixels/byte
	ShmFormatR4                   ShmFormat = 0x20203452 // [7:0] R0:R1 4:4 two pixels/byte
	ShmFormatR10                  ShmFormat = 0x20303152 // [15:0] x:R 6:10 little endian
	ShmFormatR12                  ShmFormat = 0x20323152 // [15:0] x:R 4:12 little endian
	ShmFormatAvuy8888             ShmFormat = 0x59555641 // [31:0] A:Cr:Cb:Y 8:8:8:8 little endian
	ShmFormatXvuy8888             ShmFormat = 0x59555658 // [31:0] X:Cr:Cb:Y 8:8:8:8 little endian
	ShmFormatP030                 ShmFormat = 0x30333050 // 2x2 subsampled Cr:Cb plane 10 bits per channel packed
)

func (ShmFormat) String 

func (v ShmFormat) String() string

type ShmListener 

type ShmListener struct {
	// # Pixel format description
	//
	// Informs the client about a valid pixel format that
	// can be used for buffers. Known formats include
	// argb8888 and xrgb8888.
	Format func(data any, self Shm, format ShmFormat) error
	// contains filtered or unexported fields
}

type ShmPool 

type ShmPool Object

A shared memory pool

The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client. Through the wl_shm_pool object, the client can allocate shared memory wl_buffer objects. All objects created through the same pool share the same underlying mapped memory. Reusing the mapped memory avoids the setup/teardown overhead and is useful when interactively resizing a surface or for many small buffers.

func (*ShmPool) CreateBuffer 

func (S *ShmPool) CreateBuffer(offset int32, width int32, height int32, stride int32, format ShmFormat) Buffer

Create a buffer from the pool

Create a wl_buffer object from the pool.

The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wl_shm.format event.

A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it.

func (*ShmPool) Destroy 

func (S *ShmPool) Destroy()

Destroy the pool

Destroy the shared memory pool.

The mmapped memory will be released when all buffers that have been created from this pool are gone.

func (*ShmPool) Resize 

func (S *ShmPool) Resize(size int32)

Change the size of the pool mapping

This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size. This request can only be used to make the pool bigger.

This request only changes the amount of bytes that are mmapped by the server and does not touch the file corresponding to the file descriptor passed at creation time. It is the client's responsibility to ensure that the file is at least as big as the new pool size.

type Subcompositor 

type Subcompositor Object

Sub-surface compositing

The global interface exposing sub-surface compositing capabilities. A wl_surface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces.

The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent.

A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wl_surface objects is to be considered as a single window, and it should also behave as such.

The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible.

func (*Subcompositor) Destroy 

func (S *Subcompositor) Destroy()

Unbind from the subcompositor interface

Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wl_subsurface objects included.

func (*Subcompositor) GetSubsurface 

func (S *Subcompositor) GetSubsurface(surface Surface, parent Surface) Subsurface

Give a surface the role sub-surface

Create a sub-surface interface for the given surface, and associate it with the given parent surface. This turns a plain wl_surface into a sub-surface.

The to-be sub-surface must not already have another role, and it must not have an existing wl_subsurface object. Otherwise the bad_surface protocol error is raised.

Adding sub-surfaces to a parent is a double-buffered operation on the parent (see wl_surface.commit). The effect of adding a sub-surface becomes visible on the next time the state of the parent surface is applied.

The parent surface must not be one of the child surface's descendants, and the parent must be different from the child surface, otherwise the bad_parent protocol error is raised.

This request modifies the behaviour of wl_surface.commit request on the sub-surface, see the documentation on wl_subsurface interface.

type SubcompositorError 

type SubcompositorError int32
const (
	SubcompositorErrorBadSurface SubcompositorError = 0 // The to-be sub-surface is invalid
	SubcompositorErrorBadParent  SubcompositorError = 1 // The to-be sub-surface parent is invalid
)

func (SubcompositorError) String 

func (v SubcompositorError) String() string

type Subsurface 

type Subsurface Object

Sub-surface interface to a wl_surface

An additional interface to a wl_surface object, which has been made a sub-surface. A sub-surface has one parent surface. A sub-surface's size and position are not limited to that of the parent. Particularly, a sub-surface is not automatically clipped to its parent's area.

A sub-surface becomes mapped, when a non-NULL wl_buffer is applied and the parent surface is mapped. The order of which one happens first is irrelevant. A sub-surface is hidden if the parent becomes hidden, or if a NULL wl_buffer is applied. These rules apply recursively through the tree of surfaces.

The behaviour of a wl_surface.commit request on a sub-surface depends on the sub-surface's mode. The possible modes are synchronized and desynchronized, see methods wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized mode caches the wl_surface state to be applied when the parent's state gets applied, and desynchronized mode applies the pending wl_surface state directly. A sub-surface is initially in the synchronized mode.

Sub-surfaces also have another kind of state, which is managed by wl_subsurface requests, as opposed to wl_surface requests. This state includes the sub-surface position relative to the parent surface (wl_subsurface.set_position), and the stacking order of the parent and its sub-surfaces (wl_subsurface.place_above and .place_below). This state is applied when the parent surface's wl_surface state is applied, regardless of the sub-surface's mode. As the exception, set_sync and set_desync are effective immediately.

The main surface can be thought to be always in desynchronized mode, since it does not have a parent in the sub-surfaces sense.

Even if a sub-surface is in desynchronized mode, it will behave as in synchronized mode, if its parent surface behaves as in synchronized mode. This rule is applied recursively throughout the tree of surfaces. This means, that one can set a sub-surface into synchronized mode, and then assume that all its child and grand-child sub-surfaces are synchronized, too, without explicitly setting them.

Destroying a sub-surface takes effect immediately. If you need to synchronize the removal of a sub-surface to the parent surface update, unmap the sub-surface first by attaching a NULL wl_buffer, update parent, and then destroy the sub-surface.

If the parent wl_surface object is destroyed, the sub-surface is unmapped.

A sub-surface never has the keyboard focus of any seat.

The wl_surface.offset request is ignored: clients must use set_position instead to move the sub-surface.

func (*Subsurface) Destroy 

func (S *Subsurface) Destroy()

Remove sub-surface interface

The sub-surface interface is removed from the wl_surface object that was turned into a sub-surface with a wl_subcompositor.get_subsurface request. The wl_surface's association to the parent is deleted. The wl_surface is unmapped immediately.

func (*Subsurface) PlaceAbove 

func (S *Subsurface) PlaceAbove(sibling Surface)

Restack the sub-surface

This sub-surface is taken from the stack, and put back just above the reference surface, changing the z-order of the sub-surfaces. The reference surface must be one of the sibling surfaces, or the parent surface. Using any other surface, including this sub-surface, will cause a protocol error.

The z-order is double-buffered. Requests are handled in order and applied immediately to a pending state. The final pending state is copied to the active state the next time the state of the parent surface is applied.

A new sub-surface is initially added as the top-most in the stack of its siblings and parent.

func (*Subsurface) PlaceBelow 

func (S *Subsurface) PlaceBelow(sibling Surface)

Restack the sub-surface

The sub-surface is placed just below the reference surface. See wl_subsurface.place_above.

func (*Subsurface) SetDesync 

func (S *Subsurface) SetDesync()

Set sub-surface to desynchronized mode

Change the commit behaviour of the sub-surface to desynchronized mode, also described as independent or freely running mode.

In desynchronized mode, wl_surface.commit on a sub-surface will apply the pending state directly, without caching, as happens normally with a wl_surface. Calling wl_surface.commit on the parent surface has no effect on the sub-surface's wl_surface state. This mode allows a sub-surface to be updated on its own.

If cached state exists when wl_surface.commit is called in desynchronized mode, the pending state is added to the cached state, and applied as a whole. This invalidates the cache.

Note: even if a sub-surface is set to desynchronized, a parent sub-surface may override it to behave as synchronized. For details, see wl_subsurface.

If a surface's parent surface behaves as desynchronized, then the cached state is applied on set_desync.

func (*Subsurface) SetPosition 

func (S *Subsurface) SetPosition(x int32, y int32)

Reposition the sub-surface

This schedules a sub-surface position change. The sub-surface will be moved so that its origin (top left corner pixel) will be at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative values are allowed.

The scheduled coordinates will take effect whenever the state of the parent surface is applied.

If more than one set_position request is invoked by the client before the commit of the parent surface, the position of a new request always replaces the scheduled position from any previous request.

The initial position is 0, 0.

func (*Subsurface) SetSync 

func (S *Subsurface) SetSync()

Set sub-surface to synchronized mode

Change the commit behaviour of the sub-surface to synchronized mode, also described as the parent dependent mode.

In synchronized mode, wl_surface.commit on a sub-surface will accumulate the committed state in a cache, but the state will not be applied and hence will not change the compositor output. The cached state is applied to the sub-surface immediately after the parent surface's state is applied. This ensures atomic updates of the parent and all its synchronized sub-surfaces. Applying the cached state will invalidate the cache, so further parent surface commits do not (re-)apply old state.

See wl_subsurface for the recursive effect of this mode.

type SubsurfaceError 

type SubsurfaceError int32
const (
	SubsurfaceErrorBadSurface SubsurfaceError = 0 // wl_surface is not a sibling or the parent
)

func (SubsurfaceError) String 

func (v SubsurfaceError) String() string

type Surface 

type Surface Object

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. They can present wl_buffers, receive user input, and define a local coordinate system.

The size of a surface (and relative positions on it) is described in surface-local coordinates, which may differ from the buffer coordinates of the pixel content, in case a buffer_transform or a buffer_scale is used.

A surface without a "role" is fairly useless: a compositor does not know where, when or how to present it. The role is the purpose of a wl_surface. Examples of roles are a cursor for a pointer (as set by wl_pointer.set_cursor), a drag icon (wl_data_device.start_drag), a sub-surface (wl_subcompositor.get_subsurface), and a window as defined by a shell protocol (e.g. wl_shell.get_shell_surface).

A surface can have only one role at a time. Initially a wl_surface does not have a role. Once a wl_surface is given a role, it is set permanently for the whole lifetime of the wl_surface object. Giving the current role again is allowed, unless explicitly forbidden by the relevant interface specification.

Surface roles are given by requests in other interfaces such as wl_pointer.set_cursor. The request should explicitly mention that this request gives a role to a wl_surface. Often, this request also creates a new protocol object that represents the role and adds additional functionality to wl_surface. When a client wants to destroy a wl_surface, they must destroy this role object before the wl_surface, otherwise a defunct_role_object error is sent.

Destroying the role object does not remove the role from the wl_surface, but it may stop the wl_surface from "playing the role". For instance, if a wl_subsurface object is destroyed, the wl_surface it was created for will be unmapped and forget its position and z-order. It is allowed to create a wl_subsurface for the same wl_surface again, but it is not allowed to use the wl_surface as a cursor (cursor is a different role than sub-surface, and role switching is not allowed).

func (*Surface) Attach 

func (S *Surface) Attach(buffer Buffer, x int32, y int32)

Set the surface contents

Set a buffer as the content of this surface.

The new size of the surface is calculated based on the buffer size transformed by the inverse buffer_transform and the inverse buffer_scale. This means that at commit time the supplied buffer size must be an integer multiple of the buffer_scale. If that's not the case, an invalid_size error is sent.

The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes. Setting anything other than 0 as x and y arguments is discouraged, and should instead be replaced with using the separate wl_surface.offset request.

When the bound wl_surface version is 5 or higher, passing any non-zero x or y is a protocol violation, and will result in an 'invalid_offset' error being raised. The x and y arguments are ignored and do not change the pending state. To achieve equivalent semantics, use wl_surface.offset.

Surface contents are double-buffered state, see wl_surface.commit.

The initial surface contents are void; there is no content. wl_surface.attach assigns the given wl_buffer as the pending wl_buffer. wl_surface.commit makes the pending wl_buffer the new surface contents, and the size of the surface becomes the size calculated from the wl_buffer, as described above. After commit, there is no pending buffer until the next attach.

Committing a pending wl_buffer allows the compositor to read the pixels in the wl_buffer. The compositor may access the pixels at any time after the wl_surface.commit request. When the compositor will not access the pixels anymore, it will send the wl_buffer.release event. Only after receiving wl_buffer.release, the client may reuse the wl_buffer. A wl_buffer that has been attached and then replaced by another attach instead of committed will not receive a release event, and is not used by the compositor.

If a pending wl_buffer has been committed to more than one wl_surface, the delivery of wl_buffer.release events becomes undefined. A well behaved client should not rely on wl_buffer.release events in this case. Alternatively, a client could create multiple wl_buffer objects from the same backing storage or use wp_linux_buffer_release.

Destroying the wl_buffer after wl_buffer.release does not change the surface contents. Destroying the wl_buffer before wl_buffer.release is allowed as long as the underlying buffer storage isn't re-used (this can happen e.g. on client process termination). However, if the client destroys the wl_buffer before receiving the wl_buffer.release event and mutates the underlying buffer storage, the surface contents become undefined immediately.

If wl_surface.attach is sent with a NULL wl_buffer, the following wl_surface.commit will remove the surface content.

If a pending wl_buffer has been destroyed, the result is not specified. Many compositors are known to remove the surface content on the following wl_surface.commit, but this behaviour is not universal. Clients seeking to maximise compatibility should not destroy pending buffers and should ensure that they explicitly remove content from surfaces, even after destroying buffers.

func (*Surface) Commit 

func (S *Surface) Commit()

Commit pending surface state

Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered. Protocol requests modify the pending state, as opposed to the active state in use by the compositor.

A commit request atomically creates a content update from the pending state, even if the pending state has not been touched. The content update is placed in a queue until it becomes active. After commit, the new pending state is as documented for each related request.

When the content update is applied, the wl_buffer is applied before all other state. This means that all coordinates in double-buffered state are relative to the newly attached wl_buffers, except for wl_surface.attach itself. If there is no newly attached wl_buffer, the coordinates are relative to the previous content update.

All requests that need a commit to become effective are documented to affect double-buffered state.

Other interfaces may add further double-buffered surface state.

func (*Surface) Damage 

func (S *Surface) Damage(x int32, y int32, width int32, height int32)

Mark part of the surface damaged

This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted. The compositor ignores the parts of the damage that fall outside of the surface.

Damage is double-buffered state, see wl_surface.commit.

The damage rectangle is specified in surface-local coordinates, where x and y specify the upper left corner of the damage rectangle.

The initial value for pending damage is empty: no damage. wl_surface.damage adds pending damage: the new pending damage is the union of old pending damage and the given rectangle.

wl_surface.commit assigns pending damage as the current damage, and clears pending damage. The server will clear the current damage as it repaints the surface.

Note! New clients should not use this request. Instead damage can be posted with wl_surface.damage_buffer which uses buffer coordinates instead of surface coordinates.

func (*Surface) DamageBuffer 

func (S *Surface) DamageBuffer(x int32, y int32, width int32, height int32)

Mark part of the surface damaged using buffer coordinates

This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted. The compositor ignores the parts of the damage that fall outside of the surface.

Damage is double-buffered state, see wl_surface.commit.

The damage rectangle is specified in buffer coordinates, where x and y specify the upper left corner of the damage rectangle.

The initial value for pending damage is empty: no damage. wl_surface.damage_buffer adds pending damage: the new pending damage is the union of old pending damage and the given rectangle.

wl_surface.commit assigns pending damage as the current damage, and clears pending damage. The server will clear the current damage as it repaints the surface.

This request differs from wl_surface.damage in only one way - it takes damage in buffer coordinates instead of surface-local coordinates. While this generally is more intuitive than surface coordinates, it is especially desirable when using wp_viewport or when a drawing library (like EGL) is unaware of buffer scale and buffer transform.

Note: Because buffer transformation changes and damage requests may be interleaved in the protocol stream, it is impossible to determine the actual mapping between surface and buffer damage until wl_surface.commit time. Therefore, compositors wishing to take both kinds of damage into account will have to accumulate damage from the two requests separately and only transform from one to the other after receiving the wl_surface.commit.

func (*Surface) Destroy 

func (S *Surface) Destroy()

Delete surface

Deletes the surface and invalidates its object ID.

func (*Surface) Frame 

func (S *Surface) Frame() Callback

Request a frame throttling hint

Request a notification when it is a good time to start drawing a new frame, by creating a frame callback. This is useful for throttling redrawing operations, and driving animations.

When a client is animating on a wl_surface, it can use the 'frame' request to get notified when it is a good time to draw and commit the next frame of animation. If the client commits an update earlier than that, it is likely that some updates will not make it to the display, and the client is wasting resources by drawing too often.

The frame request will take effect on the next wl_surface.commit. The notification will only be posted for one frame unless requested again. For a wl_surface, the notifications are posted in the order the frame requests were committed.

The server must send the notifications so that a client will not send excessive updates, while still allowing the highest possible update rate for clients that wait for the reply before drawing again. The server should give some time for the client to draw and commit after sending the frame callback events to let it hit the next output refresh.

A server should avoid signaling the frame callbacks if the surface is not visible in any way, e.g. the surface is off-screen, or completely obscured by other opaque surfaces.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is the current time, in milliseconds, with an undefined base.

func (*Surface) Offset 

func (S *Surface) Offset(x int32, y int32)

Set the surface contents offset

The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes.

Surface location offset is double-buffered state, see wl_surface.commit.

This request is semantically equivalent to and the replaces the x and y arguments in the wl_surface.attach request in wl_surface versions prior to 5. See wl_surface.attach for details.

func (*Surface) SetBufferScale 

func (S *Surface) SetBufferScale(scale int32)

Sets the buffer scaling factor

This request sets an optional scaling factor on how the compositor interprets the contents of the buffer attached to the window.

Buffer scale is double-buffered state, see wl_surface.commit.

A newly created surface has its buffer scale set to 1.

wl_surface.set_buffer_scale changes the pending buffer scale. wl_surface.commit copies the pending buffer scale to the current one. Otherwise, the pending and current values are never changed.

The purpose of this request is to allow clients to supply higher resolution buffer data for use on high resolution outputs. It is intended that you pick the same buffer scale as the scale of the output that the surface is displayed on. This means the compositor can avoid scaling when rendering the surface on that output.

Note that if the scale is larger than 1, then you have to attach a buffer that is larger (by a factor of scale in each dimension) than the desired surface size.

If scale is not greater than 0 the invalid_scale protocol error is raised.

func (*Surface) SetBufferTransform 

func (S *Surface) SetBufferTransform(transform OutputTransform)

Sets the buffer transformation

This request sets the transformation that the client has already applied to the content of the buffer. The accepted values for the transform parameter are the values for wl_output.transform.

The compositor applies the inverse of this transformation whenever it uses the buffer contents.

Buffer transform is double-buffered state, see wl_surface.commit.

A newly created surface has its buffer transformation set to normal.

wl_surface.set_buffer_transform changes the pending buffer transformation. wl_surface.commit copies the pending buffer transformation to the current one. Otherwise, the pending and current values are never changed.

The purpose of this request is to allow clients to render content according to the output transform, thus permitting the compositor to use certain optimizations even if the display is rotated. Using hardware overlays and scanning out a client buffer for fullscreen surfaces are examples of such optimizations. Those optimizations are highly dependent on the compositor implementation, so the use of this request should be considered on a case-by-case basis.

Note that if the transform value includes 90 or 270 degree rotation, the width of the buffer will become the surface height and the height of the buffer will become the surface width.

If transform is not one of the values from the wl_output.transform enum the invalid_transform protocol error is raised.

func (*Surface) SetInputRegion 

func (S *Surface) SetInputRegion(region Region)

Set input region

This request sets the region of the surface that can receive pointer and touch events.

Input events happening outside of this region will try the next surface in the server surface stack. The compositor ignores the parts of the input region that fall outside of the surface.

The input region is specified in surface-local coordinates.

Input region is double-buffered state, see wl_surface.commit.

wl_surface.set_input_region changes the pending input region. wl_surface.commit copies the pending region to the current region. Otherwise the pending and current regions are never changed, except cursor and icon surfaces are special cases, see wl_pointer.set_cursor and wl_data_device.start_drag.

The initial value for an input region is infinite. That means the whole surface will accept input. Setting the pending input region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the input region to be set to infinite.

func (*Surface) SetListener 

func (o *Surface) SetListener(listener SurfaceListener, data any)

SetListener sets the event listener for the Surface. Overwriting an existing listener is illegal and will result in a panic.

func (*Surface) SetOpaqueRegion 

func (S *Surface) SetOpaqueRegion(region Region)

Set opaque region

This request sets the region of the surface that contains opaque content.

The opaque region is an optimization hint for the compositor that lets it optimize the redrawing of content behind opaque regions. Setting an opaque region is not required for correct behaviour, but marking transparent content as opaque will result in repaint artifacts.

The opaque region is specified in surface-local coordinates.

The compositor ignores the parts of the opaque region that fall outside of the surface.

Opaque region is double-buffered state, see wl_surface.commit.

wl_surface.set_opaque_region changes the pending opaque region. wl_surface.commit copies the pending region to the current region. Otherwise, the pending and current regions are never changed.

The initial value for an opaque region is empty. Setting the pending opaque region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the pending opaque region to be set to empty.

type SurfaceError 

type SurfaceError int32

wl_surface error values

These errors can be emitted in response to wl_surface requests. 

const (
	SurfaceErrorInvalidScale      SurfaceError = 0 // Buffer scale value is invalid
	SurfaceErrorInvalidTransform  SurfaceError = 1 // Buffer transform value is invalid
	SurfaceErrorInvalidSize       SurfaceError = 2 // Buffer size is invalid
	SurfaceErrorInvalidOffset     SurfaceError = 3 // Buffer offset is invalid
	SurfaceErrorDefunctRoleObject SurfaceError = 4 // Surface was destroyed before its role object
)

func (SurfaceError) String 

func (v SurfaceError) String() string

type SurfaceListener 

type SurfaceListener struct {
	// # 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.
	//
	// Note that a surface may be overlapping with zero or more outputs.
	Enter func(data any, self Surface, output Output) error

	// # 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.
	//
	// Clients should not use the number of outputs the surface is on for frame
	// throttling purposes. The surface might be hidden even if no leave event
	// has been sent, and the compositor might expect new surface content
	// updates even if no enter event has been sent. The frame event should be
	// used instead.
	Leave func(data any, self Surface, output Output) error

	// # Preferred buffer scale for the surface
	//
	// This event indicates the preferred buffer scale for this surface. It is
	// sent whenever the compositor's preference changes.
	//
	// Before receiving this event the preferred buffer scale for this surface
	// is 1.
	//
	// It is intended that scaling aware clients use this event to scale their
	// content and use wl_surface.set_buffer_scale to indicate the scale they
	// have rendered with. This allows clients to supply a higher detail
	// buffer.
	//
	// The compositor shall emit a scale value greater than 0.
	PreferredBufferScale func(data any, self Surface, factor int32) error

	// # Preferred buffer transform for the surface
	//
	// This event indicates the preferred buffer transform for this surface.
	// It is sent whenever the compositor's preference changes.
	//
	// Before receiving this event the preferred buffer transform for this
	// surface is normal.
	//
	// Applying this transformation to the surface buffer contents and using
	// wl_surface.set_buffer_transform might allow the compositor to use the
	// surface buffer more efficiently.
	PreferredBufferTransform func(data any, self Surface, transform OutputTransform) error
	// contains filtered or unexported fields
}

type Touch 

type Touch Object

Touchscreen input device

The wl_touch interface represents a touchscreen associated with a seat.

Touch interactions can consist of one or more contacts. For each contact, a series of events is generated, starting with a down event, followed by zero or more motion events, and ending with an up event. Events relating to the same contact point can be identified by the ID of the sequence.

func (*Touch) Release 

func (S *Touch) Release()

Release the touch object

func (*Touch) SetListener 

func (o *Touch) SetListener(listener TouchListener, data any)

SetListener sets the event listener for the Touch. Overwriting an existing listener is illegal and will result in a panic.

type TouchListener 

type TouchListener struct {
	// # Touch down event and beginning of a touch sequence
	//
	// A new touch point has appeared on the surface. This touch point is
	// assigned a unique ID. Future events from this touch point reference
	// this ID. The ID ceases to be valid after a touch up event and may be
	// reused in the future.
	Down func(data any, self Touch, serial uint32, time uint32, surface Surface, id int32, x float64, y float64) error

	// # End of a touch event sequence
	//
	// The touch point has disappeared. No further events will be sent for
	// this touch point and the touch point's ID is released and may be
	// reused in a future touch down event.
	Up func(data any, self Touch, serial uint32, time uint32, id int32) error

	// # Update of touch point coordinates
	//
	// A touch point has changed coordinates.
	Motion func(data any, self Touch, time uint32, id int32, x float64, y float64) error

	// # End of touch frame event
	//
	// Indicates the end of a set of events that logically belong together.
	// A client is expected to accumulate the data in all events within the
	// frame before proceeding.
	//
	// A wl_touch.frame terminates at least one event but otherwise no
	// guarantee is provided about the set of events within a frame. A client
	// must assume that any state not updated in a frame is unchanged from the
	// previously known state.
	Frame func(data any, self Touch) error

	// # Touch session cancelled
	//
	// Sent if the compositor decides the touch stream is a global
	// gesture. No further events are sent to the clients from that
	// particular gesture. Touch cancellation applies to all touch points
	// currently active on this client's surface. The client is
	// responsible for finalizing the touch points, future touch points on
	// this surface may reuse the touch point ID.
	//
	// No frame event is required after the cancel event.
	Cancel func(data any, self Touch) error

	// # Update shape of touch point
	//
	// Sent when a touchpoint has changed its shape.
	//
	// This event does not occur on its own. It is sent before a
	// wl_touch.frame event and carries the new shape information for
	// any previously reported, or new touch points of that frame.
	//
	// Other events describing the touch point such as wl_touch.down,
	// wl_touch.motion or wl_touch.orientation may be sent within the
	// same wl_touch.frame. A client should treat these events as a single
	// logical touch point update. The order of wl_touch.shape,
	// wl_touch.orientation and wl_touch.motion is not guaranteed.
	// A wl_touch.down event is guaranteed to occur before the first
	// wl_touch.shape event for this touch ID but both events may occur within
	// the same wl_touch.frame.
	//
	// A touchpoint shape is approximated by an ellipse through the major and
	// minor axis length. The major axis length describes the longer diameter
	// of the ellipse, while the minor axis length describes the shorter
	// diameter. Major and minor are orthogonal and both are specified in
	// surface-local coordinates. The center of the ellipse is always at the
	// touchpoint location as reported by wl_touch.down or wl_touch.move.
	//
	// This event is only sent by the compositor if the touch device supports
	// shape reports. The client has to make reasonable assumptions about the
	// shape if it did not receive this event.
	Shape func(data any, self Touch, id int32, major float64, minor float64) error

	// # Update orientation of touch point
	//
	// Sent when a touchpoint has changed its orientation.
	//
	// This event does not occur on its own. It is sent before a
	// wl_touch.frame event and carries the new shape information for
	// any previously reported, or new touch points of that frame.
	//
	// Other events describing the touch point such as wl_touch.down,
	// wl_touch.motion or wl_touch.shape may be sent within the
	// same wl_touch.frame. A client should treat these events as a single
	// logical touch point update. The order of wl_touch.shape,
	// wl_touch.orientation and wl_touch.motion is not guaranteed.
	// A wl_touch.down event is guaranteed to occur before the first
	// wl_touch.orientation event for this touch ID but both events may occur
	// within the same wl_touch.frame.
	//
	// The orientation describes the clockwise angle of a touchpoint's major
	// axis to the positive surface y-axis and is normalized to the -180 to
	// +180 degree range. The granularity of orientation depends on the touch
	// device, some devices only support binary rotation values between 0 and
	// 90 degrees.
	//
	// This event is only sent by the compositor if the touch device supports
	// orientation reports.
	Orientation func(data any, self Touch, id int32, orientation float64) error
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
scanner
Package meta provides facilities for working with Wayland protocol definitions written in XML.
 Package meta provides facilities for working with Wayland protocol definitions written in XML.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.