wlp

package
v0.0.0-...-22b451c Latest Latest
Warning

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

 Go to latest Published: Jan 4, 2018 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DisplayErrorInvalidObject = 0 // server couldn't find object
	DisplayErrorInvalidMethod = 1 // method doesn't exist on the specified interface
	DisplayErrorNoMemory      = 2 // server is out of memory
)
View Source 
const (
	ShmErrorInvalidFormat = 0 // buffer format is not known
	ShmErrorInvalidStride = 1 // invalid size or stride during pool or buffer creation
	ShmErrorInvalidFd     = 2 // mmapping the file descriptor failed
)
View Source 
const (
	ShmFormatArgb8888    = 0          // 32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian
	ShmFormatXrgb8888    = 1          // 32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian
	ShmFormatC8          = 0x20203843 // 8-bit color index format, [7:0] C
	ShmFormatRgb332      = 0x38424752 // 8-bit RGB format, [7:0] R:G:B 3:3:2
	ShmFormatBgr233      = 0x38524742 // 8-bit BGR format, [7:0] B:G:R 2:3:3
	ShmFormatXrgb4444    = 0x32315258 // 16-bit xRGB format, [15:0] x:R:G:B 4:4:4:4 little endian
	ShmFormatXbgr4444    = 0x32314258 // 16-bit xBGR format, [15:0] x:B:G:R 4:4:4:4 little endian
	ShmFormatRgbx4444    = 0x32315852 // 16-bit RGBx format, [15:0] R:G:B:x 4:4:4:4 little endian
	ShmFormatBgrx4444    = 0x32315842 // 16-bit BGRx format, [15:0] B:G:R:x 4:4:4:4 little endian
	ShmFormatArgb4444    = 0x32315241 // 16-bit ARGB format, [15:0] A:R:G:B 4:4:4:4 little endian
	ShmFormatAbgr4444    = 0x32314241 // 16-bit ABGR format, [15:0] A:B:G:R 4:4:4:4 little endian
	ShmFormatRgba4444    = 0x32314152 // 16-bit RBGA format, [15:0] R:G:B:A 4:4:4:4 little endian
	ShmFormatBgra4444    = 0x32314142 // 16-bit BGRA format, [15:0] B:G:R:A 4:4:4:4 little endian
	ShmFormatXrgb1555    = 0x35315258 // 16-bit xRGB format, [15:0] x:R:G:B 1:5:5:5 little endian
	ShmFormatXbgr1555    = 0x35314258 // 16-bit xBGR 1555 format, [15:0] x:B:G:R 1:5:5:5 little endian
	ShmFormatRgbx5551    = 0x35315852 // 16-bit RGBx 5551 format, [15:0] R:G:B:x 5:5:5:1 little endian
	ShmFormatBgrx5551    = 0x35315842 // 16-bit BGRx 5551 format, [15:0] B:G:R:x 5:5:5:1 little endian
	ShmFormatArgb1555    = 0x35315241 // 16-bit ARGB 1555 format, [15:0] A:R:G:B 1:5:5:5 little endian
	ShmFormatAbgr1555    = 0x35314241 // 16-bit ABGR 1555 format, [15:0] A:B:G:R 1:5:5:5 little endian
	ShmFormatRgba5551    = 0x35314152 // 16-bit RGBA 5551 format, [15:0] R:G:B:A 5:5:5:1 little endian
	ShmFormatBgra5551    = 0x35314142 // 16-bit BGRA 5551 format, [15:0] B:G:R:A 5:5:5:1 little endian
	ShmFormatRgb565      = 0x36314752 // 16-bit RGB 565 format, [15:0] R:G:B 5:6:5 little endian
	ShmFormatBgr565      = 0x36314742 // 16-bit BGR 565 format, [15:0] B:G:R 5:6:5 little endian
	ShmFormatRgb888      = 0x34324752 // 24-bit RGB format, [23:0] R:G:B little endian
	ShmFormatBgr888      = 0x34324742 // 24-bit BGR format, [23:0] B:G:R little endian
	ShmFormatXbgr8888    = 0x34324258 // 32-bit xBGR format, [31:0] x:B:G:R 8:8:8:8 little endian
	ShmFormatRgbx8888    = 0x34325852 // 32-bit RGBx format, [31:0] R:G:B:x 8:8:8:8 little endian
	ShmFormatBgrx8888    = 0x34325842 // 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian
	ShmFormatAbgr8888    = 0x34324241 // 32-bit ABGR format, [31:0] A:B:G:R 8:8:8:8 little endian
	ShmFormatRgba8888    = 0x34324152 // 32-bit RGBA format, [31:0] R:G:B:A 8:8:8:8 little endian
	ShmFormatBgra8888    = 0x34324142 // 32-bit BGRA format, [31:0] B:G:R:A 8:8:8:8 little endian
	ShmFormatXrgb2101010 = 0x30335258 // 32-bit xRGB format, [31:0] x:R:G:B 2:10:10:10 little endian
	ShmFormatXbgr2101010 = 0x30334258 // 32-bit xBGR format, [31:0] x:B:G:R 2:10:10:10 little endian
	ShmFormatRgbx1010102 = 0x30335852 // 32-bit RGBx format, [31:0] R:G:B:x 10:10:10:2 little endian
	ShmFormatBgrx1010102 = 0x30335842 // 32-bit BGRx format, [31:0] B:G:R:x 10:10:10:2 little endian
	ShmFormatArgb2101010 = 0x30335241 // 32-bit ARGB format, [31:0] A:R:G:B 2:10:10:10 little endian
	ShmFormatAbgr2101010 = 0x30334241 // 32-bit ABGR format, [31:0] A:B:G:R 2:10:10:10 little endian
	ShmFormatRgba1010102 = 0x30334152 // 32-bit RGBA format, [31:0] R:G:B:A 10:10:10:2 little endian
	ShmFormatBgra1010102 = 0x30334142 // 32-bit BGRA format, [31:0] B:G:R:A 10:10:10:2 little endian
	ShmFormatYuyv        = 0x56595559 // packed YCbCr format, [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian
	ShmFormatYvyu        = 0x55595659 // packed YCbCr format, [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian
	ShmFormatUyvy        = 0x59565955 // packed YCbCr format, [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian
	ShmFormatVyuy        = 0x59555956 // packed YCbCr format, [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian
	ShmFormatAyuv        = 0x56555941 // packed AYCbCr format, [31:0] A:Y:Cb:Cr 8:8:8:8 little endian
	ShmFormatNv12        = 0x3231564e // 2 plane YCbCr Cr:Cb format, 2x2 subsampled Cr:Cb plane
	ShmFormatNv21        = 0x3132564e // 2 plane YCbCr Cb:Cr format, 2x2 subsampled Cb:Cr plane
	ShmFormatNv16        = 0x3631564e // 2 plane YCbCr Cr:Cb format, 2x1 subsampled Cr:Cb plane
	ShmFormatNv61        = 0x3136564e // 2 plane YCbCr Cb:Cr format, 2x1 subsampled Cb:Cr plane
	ShmFormatYuv410      = 0x39565559 // 3 plane YCbCr format, 4x4 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu410      = 0x39555659 // 3 plane YCbCr format, 4x4 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv411      = 0x31315559 // 3 plane YCbCr format, 4x1 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu411      = 0x31315659 // 3 plane YCbCr format, 4x1 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv420      = 0x32315559 // 3 plane YCbCr format, 2x2 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu420      = 0x32315659 // 3 plane YCbCr format, 2x2 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv422      = 0x36315559 // 3 plane YCbCr format, 2x1 subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu422      = 0x36315659 // 3 plane YCbCr format, 2x1 subsampled Cr (1) and Cb (2) planes
	ShmFormatYuv444      = 0x34325559 // 3 plane YCbCr format, non-subsampled Cb (1) and Cr (2) planes
	ShmFormatYvu444      = 0x34325659 // 3 plane YCbCr format, non-subsampled Cr (1) and Cb (2) planes
)
View Source 
const (
	DataOfferErrorInvalidFinish     = 0 // finish request was called untimely
	DataOfferErrorInvalidActionMask = 1 // action mask contains invalid values
	DataOfferErrorInvalidAction     = 2 // action argument has an invalid value
	DataOfferErrorInvalidOffer      = 3 // offer doesn't accept this request
)
View Source 
const (
	DataSourceErrorInvalidActionMask = 0 // action mask contains invalid values
	DataSourceErrorInvalidSource     = 1 // source doesn't accept this request
)
View Source 
const (
	DataDeviceManagerDndActionNone = 0 // no action
	DataDeviceManagerDndActionCopy = 1 // copy action
	DataDeviceManagerDndActionMove = 2 // move action
	DataDeviceManagerDndActionAsk  = 4 // ask action
)
View Source 
const (
	ShellSurfaceResizeNone        = 0  // no edge
	ShellSurfaceResizeTop         = 1  // top edge
	ShellSurfaceResizeBottom      = 2  // bottom edge
	ShellSurfaceResizeLeft        = 4  // left edge
	ShellSurfaceResizeTopLeft     = 5  // top and left edges
	ShellSurfaceResizeBottomLeft  = 6  // bottom and left edges
	ShellSurfaceResizeRight       = 8  // right edge
	ShellSurfaceResizeTopRight    = 9  // top and right edges
	ShellSurfaceResizeBottomRight = 10 // bottom and right edges
)
View Source 
const (
	ShellSurfaceFullscreenMethodDefault = 0 // no preference, apply default policy
	ShellSurfaceFullscreenMethodScale   = 1 // scale, preserve the surface's aspect ratio and center on output
	ShellSurfaceFullscreenMethodDriver  = 2 // switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch
	ShellSurfaceFullscreenMethodFill    = 3 // no upscaling, center on output and add black borders to compensate size mismatch
)
View Source 
const (
	SurfaceErrorInvalidScale     = 0 // buffer scale value is invalid
	SurfaceErrorInvalidTransform = 1 // buffer transform value is invalid
)
View Source 
const (
	SeatCapabilityPointer  = 1 // the seat has pointer devices
	SeatCapabilityKeyboard = 2 // the seat has one or more keyboards
	SeatCapabilityTouch    = 4 // the seat has touch devices
)
View Source 
const (
	PointerButtonStateReleased = 0 // the button is not pressed
	PointerButtonStatePressed  = 1 // the button is pressed
)
View Source 
const (
	PointerAxisVerticalScroll   = 0 // vertical axis
	PointerAxisHorizontalScroll = 1 // horizontal axis
)
View Source 
const (
	PointerAxisSourceWheel      = 0 // a physical wheel rotation
	PointerAxisSourceFinger     = 1 // finger on a touch surface
	PointerAxisSourceContinuous = 2 // continuous coordinate space
	PointerAxisSourceWheelTilt  = 3 // a physical wheel tilt
)
View Source 
const (
	KeyboardKeymapFormatNoKeymap = 0 // no keymap; client must understand how to interpret the raw keycode
	KeyboardKeymapFormatXkbV1    = 1 // libxkbcommon compatible; to determine the xkb keycode, clients must add 8 to the key event keycode
)
View Source 
const (
	KeyboardKeyStateReleased = 0 // key is not pressed
	KeyboardKeyStatePressed  = 1 // key is pressed
)
View Source 
const (
	OutputSubpixelUnknown       = 0 // unknown geometry
	OutputSubpixelNone          = 1 // no geometry
	OutputSubpixelHorizontalRgb = 2 // horizontal RGB
	OutputSubpixelHorizontalBgr = 3 // horizontal BGR
	OutputSubpixelVerticalRgb   = 4 // vertical RGB
	OutputSubpixelVerticalBgr   = 5 // vertical BGR
)
View Source 
const (
	OutputTransformNormal     = 0 // no transform
	OutputTransform90         = 1 // 90 degrees counter-clockwise
	OutputTransform180        = 2 // 180 degrees counter-clockwise
	OutputTransform270        = 3 // 270 degrees counter-clockwise
	OutputTransformFlipped    = 4 // 180 degree flip around a vertical axis
	OutputTransformFlipped90  = 5 // flip and rotate 90 degrees counter-clockwise
	OutputTransformFlipped180 = 6 // flip and rotate 180 degrees counter-clockwise
	OutputTransformFlipped270 = 7 // flip and rotate 270 degrees counter-clockwise
)
View Source 
const (
	OutputModeCurrent   = 0x1 // indicates this is the current mode
	OutputModePreferred = 0x2 // indicates this is the preferred mode
)
View Source 
const (
	ZxdgShellV6ErrorRole                = 0 // given wl_surface has another role
	ZxdgShellV6ErrorDefunctSurfaces     = 1 // xdg_shell was destroyed before children
	ZxdgShellV6ErrorNotTheTopmostPopup  = 2 // the client tried to map or destroy a non-topmost popup
	ZxdgShellV6ErrorInvalidPopupParent  = 3 // the client specified an invalid popup parent surface
	ZxdgShellV6ErrorInvalidSurfaceState = 4 // the client provided an invalid surface state
	ZxdgShellV6ErrorInvalidPositioner   = 5 // the client provided an invalid positioner
)
View Source 
const (
	ZxdgPositionerV6AnchorNone   = 0 // the center of the anchor rectangle
	ZxdgPositionerV6AnchorTop    = 1 // the top edge of the anchor rectangle
	ZxdgPositionerV6AnchorBottom = 2 // the bottom edge of the anchor rectangle
	ZxdgPositionerV6AnchorLeft   = 4 // the left edge of the anchor rectangle
	ZxdgPositionerV6AnchorRight  = 8 // the right edge of the anchor rectangle
)
View Source 
const (
	ZxdgPositionerV6GravityNone   = 0 // center over the anchor edge
	ZxdgPositionerV6GravityTop    = 1 // position above the anchor edge
	ZxdgPositionerV6GravityBottom = 2 // position below the anchor edge
	ZxdgPositionerV6GravityLeft   = 4 // position to the left of the anchor edge
	ZxdgPositionerV6GravityRight  = 8 // position to the right of the anchor edge
)
View Source 
const (
	ZxdgPositionerV6ConstraintAdjustmentNone    = 0  //
	ZxdgPositionerV6ConstraintAdjustmentSlideX  = 1  //
	ZxdgPositionerV6ConstraintAdjustmentSlideY  = 2  //
	ZxdgPositionerV6ConstraintAdjustmentFlipX   = 4  //
	ZxdgPositionerV6ConstraintAdjustmentFlipY   = 8  //
	ZxdgPositionerV6ConstraintAdjustmentResizeX = 16 //
	ZxdgPositionerV6ConstraintAdjustmentResizeY = 32 //
)
View Source 
const (
	ZxdgSurfaceV6ErrorNotConstructed     = 1 //
	ZxdgSurfaceV6ErrorAlreadyConstructed = 2 //
	ZxdgSurfaceV6ErrorUnconfiguredBuffer = 3 //
)
View Source 
const (
	ZxdgToplevelV6ResizeEdgeNone        = 0  //
	ZxdgToplevelV6ResizeEdgeTop         = 1  //
	ZxdgToplevelV6ResizeEdgeBottom      = 2  //
	ZxdgToplevelV6ResizeEdgeLeft        = 4  //
	ZxdgToplevelV6ResizeEdgeTopLeft     = 5  //
	ZxdgToplevelV6ResizeEdgeBottomLeft  = 6  //
	ZxdgToplevelV6ResizeEdgeRight       = 8  //
	ZxdgToplevelV6ResizeEdgeTopRight    = 9  //
	ZxdgToplevelV6ResizeEdgeBottomRight = 10 //
)
View Source 
const (
	ZxdgToplevelV6StateMaximized  = 1 // the surface is maximized
	ZxdgToplevelV6StateFullscreen = 2 // the surface is fullscreen
	ZxdgToplevelV6StateResizing   = 3 // the surface is being resized
	ZxdgToplevelV6StateActivated  = 4 // the surface is now activated
)
View Source 
const (
	DataDeviceErrorRole = 0 // given wl_surface has another role
)
View Source 
const (
	PointerErrorRole = 0 // given wl_surface has another role
)
View Source 
const (
	ShellErrorRole = 0 // given wl_surface has another role
)
View Source 
const (
	ShellSurfaceTransientInactive = 0x1 // do not set keyboard focus
)
View Source 
const (
	SubcompositorErrorBadSurface = 0 // the to-be sub-surface is invalid
)
View Source 
const (
	SubsurfaceErrorBadSurface = 0 // wl_surface is not a sibling or the parent
)
View Source 
const (
	ZxdgPopupV6ErrorInvalidGrab = 0 // tried to grab after being mapped
)
View Source 
const (
	ZxdgPositionerV6ErrorInvalidInput = 0 // invalid input provided
)

Variables

This section is empty.

Functions

func DecodeHeader 

func DecodeHeader(buf []byte) (id uint32, opcode uint16, size int)

Types

type Buffer 

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

A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_drm, wl_shm 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.

func (*Buffer) Destroy 

func (this *Buffer) Destroy() error

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) ID 

func (this *Buffer) ID() uint32

ID returns the wayland object identifier

func (*Buffer) Type 

func (this *Buffer) Type() string

Type returns the string wayland type

type BufferListener 

type BufferListener interface {
	Release()
}

Buffer Events

Release 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.

type Callback 

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

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

func (*Callback) ID 

func (this *Callback) ID() uint32

ID returns the wayland object identifier

func (*Callback) Type 

func (this *Callback) Type() string

Type returns the string wayland type

type CallbackListener 

type CallbackListener interface {
	Done(callbackData uint32)
}

Callback Events

Done Notify the client when the related request is done.

type Compositor 

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

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 (this *Compositor) CreateRegion(l RegionListener) (*Region, error)

Ask the compositor to create a new region.

func (*Compositor) CreateSurface 

func (this *Compositor) CreateSurface(l SurfaceListener) (*Surface, error)

Ask the compositor to create a new surface.

func (*Compositor) ID 

func (this *Compositor) ID() uint32

ID returns the wayland object identifier

func (*Compositor) Type 

func (this *Compositor) Type() string

Type returns the string wayland type

type CompositorListener 

type CompositorListener interface {
}

Compositor Events

type Context 

type Context struct {
	*Display
	*Registry

	Err error
	// contains filtered or unexported fields
}

func NewContext 

func NewContext(conn *net.UnixConn) *Context

NewContext will create a new "global" context for a wayland connection

func (*Context) BindGlobal 

func (c *Context) BindGlobal(ifname string, listener interface{}) (Object, error)

func (*Context) BindGlobalIndex 

func (c *Context) BindGlobalIndex(ifname string, listener interface{}, i int) (Object, error)

func (*Context) DeleteID 

func (c *Context) DeleteID(id uint32)

func (*Context) Error 

func (c *Context) Error(objectID uint32, code uint32, message string)

Error handles stores global errors from the

func (*Context) Global 

func (c *Context) Global(name uint32, iface string, version uint32)

Global is an implementation of the RegistryListener interface. It will receive callbacks from the Global registry and stores them in a registry map.

func (*Context) GlobalRemove 

func (c *Context) GlobalRemove(name uint32)

GlobalRemove is an implementation of the RegistryListener interface for removing global objects from the client when they are no longer present in the server.

func (*Context) NumGlobals 

func (c *Context) NumGlobals(ifname string) int

func (*Context) Start 

func (c *Context) Start()

type DataDevice 

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

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) ID 

func (this *DataDevice) ID() uint32

ID returns the wayland object identifier

func (*DataDevice) Release 

func (this *DataDevice) Release() error

This request destroys the data device.

func (*DataDevice) SetSelection 

func (this *DataDevice) SetSelection(source uint32, serial uint32) error

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.

func (*DataDevice) StartDrag 

func (this *DataDevice) StartDrag(source uint32, origin uint32, icon uint32, serial uint32) error

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.

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.attach request 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 current and pending input regions of the icon wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the icon surface. When the use as an icon ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

func (*DataDevice) Type 

func (this *DataDevice) Type() string

Type returns the string wayland type

type DataDeviceListener 

type DataDeviceListener interface {
	DataOffer(l DataOfferListener)
	Enter(serial uint32, surface uint32, x float64, y float64, id uint32)
	Leave()
	Motion(time uint32, x float64, y float64)
	Drop()
	Selection(id uint32)
}

DataDevice Events

DataOffer 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.

Enter 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.

Leave 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.

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.

Drop 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.

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. The client must destroy the previous selection data_offer, if any, upon receiving this event.

type DataDeviceManager 

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

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 (this *DataDeviceManager) CreateDataSource(l DataSourceListener) (*DataSource, error)

Create a new data source.

func (*DataDeviceManager) GetDataDevice 

func (this *DataDeviceManager) GetDataDevice(l DataDeviceListener, seat uint32) (*DataDevice, error)

Create a new data device for a given seat.

func (*DataDeviceManager) ID 

func (this *DataDeviceManager) ID() uint32

ID returns the wayland object identifier

func (*DataDeviceManager) Type 

func (this *DataDeviceManager) Type() string

Type returns the string wayland type

type DataDeviceManagerListener 

type DataDeviceManagerListener interface {
}

DataDeviceManager Events

type DataOffer 

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

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 (this *DataOffer) Accept(serial uint32, mimeType string) error

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 (this *DataOffer) Destroy() error

Destroy the data offer.

func (*DataOffer) Finish 

func (this *DataOffer) Finish() error

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.

func (*DataOffer) ID 

func (this *DataOffer) ID() uint32

ID returns the wayland object identifier

func (*DataOffer) Receive 

func (this *DataOffer) Receive(mimeType string, fd *os.File) error

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 (this *DataOffer) SetActions(dndActions uint32, preferredAction uint32) error

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_drag_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) Type 

func (this *DataOffer) Type() string

Type returns the string wayland type

type DataOfferListener 

type DataOfferListener interface {
	Offer(mimeType string)
	SourceActions(sourceActions uint32)
	Action(dndAction uint32)
}

DataOffer Events

Offer Sent immediately after creating the wl_data_offer object. One event per offered mime type.

SourceActions This event indicates the actions offered by the data source. It will be sent right after wl_data_device.enter, or anytime the source side changes its offered actions through wl_data_source.set_actions.

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.

type DataSource 

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

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 (this *DataSource) Destroy() error

Destroy the data source.

func (*DataSource) ID 

func (this *DataSource) ID() uint32

ID returns the wayland object identifier

func (*DataSource) Offer 

func (this *DataSource) Offer(mimeType string) error

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 (this *DataSource) SetActions(dndActions uint32) error

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) Type 

func (this *DataSource) Type() string

Type returns the string wayland type

type DataSourceListener 

type DataSourceListener interface {
	Target(mimeType string)
	Send(mimeType string, fd *os.File)
	Cancelled()
	DndDropPerformed()
	DndFinished()
	Action(dndAction uint32)
}

DataSource Events

Target 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.

Send Request for data from the client. Send the data as the specified mime type over the passed file descriptor, then close it.

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.

DndDropPerformed 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.

DndFinished 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.

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.

type Display 

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

The core global object. This is a special singleton object. It is used for internal Wayland protocol features.

func (*Display) GetRegistry 

func (this *Display) GetRegistry(l RegistryListener) (*Registry, error)

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

func (*Display) ID 

func (this *Display) ID() uint32

ID returns the wayland object identifier

func (*Display) Sync 

func (this *Display) Sync(l CallbackListener) (*Callback, error)

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 the event serial.

func (*Display) Type 

func (this *Display) Type() string

Type returns the string wayland type

type DisplayListener 

type DisplayListener interface {
	Error(objectID uint32, code uint32, message string)
	DeleteID(id uint32)
}

Display Events

Error The error event is sent out when a fatal (non-recoverable) error has occurred. The object_id argument is the object where the error occurred, most often in response to a request to that object. The code identifies the error and is defined by the object interface. As such, each interface defines its own set of error codes. The message is a brief description of the error, for (debugging) convenience.

DeleteID This event is used internally by the object ID management logic. When a client deletes an object, the server will send this event to acknowledge that it has seen the delete request. When the client receives this event, it will know that it can safely reuse the object ID.

type Keyboard 

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

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

func (*Keyboard) ID 

func (this *Keyboard) ID() uint32

ID returns the wayland object identifier

func (*Keyboard) Release 

func (this *Keyboard) Release() error

func (*Keyboard) Type 

func (this *Keyboard) Type() string

Type returns the string wayland type

type KeyboardListener 

type KeyboardListener interface {
	Keymap(format uint32, fd *os.File, size uint32)
	Enter(serial uint32, surface uint32, keys []byte)
	Leave(serial uint32, surface uint32)
	Key(serial uint32, time uint32, key uint32, state uint32)
	Modifiers(serial uint32, modsDepressed uint32, modsLatched uint32, modsLocked uint32, group uint32)
	RepeatInfo(rate int32, delay int32)
}

Keyboard Events

Keymap This event provides a file descriptor to the client which can be memory-mapped to provide a keyboard mapping description.

Enter Notification that this seat's keyboard focus is on a certain surface.

Leave 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.

Key A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base.

Modifiers Notifies clients that the modifier and/or group state has changed, and it should update its local state.

RepeatInfo 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.

type Object 

type Object interface {
	ID() uint32
	Type() string
	// contains filtered or unexported methods
}

type Output 

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

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) ID 

func (this *Output) ID() uint32

ID returns the wayland object identifier

func (*Output) Release 

func (this *Output) Release() error

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

func (*Output) Type 

func (this *Output) Type() string

Type returns the string wayland type

type OutputListener 

type OutputListener interface {
	Geometry(x int32, y int32, physicalWidth int32, physicalHeight int32, subpixel int32, make string, model string, transform int32)
	Mode(flags uint32, width int32, height int32, refresh int32)
	Done()
	Scale(factor int32)
}

Output Events

Geometry 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.

Mode 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.

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.

Done 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.

Scale 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. 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.

It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wl_surface.set_buffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image.

type Pointer 

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

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) ID 

func (this *Pointer) ID() uint32

ID returns the wayland object identifier

func (*Pointer) Release 

func (this *Pointer) Release() error

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 (this *Pointer) SetCursor(serial uint32, surface uint32, hotspotX int32, hotspotY int32) error

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 surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed 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 current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

func (*Pointer) Type 

func (this *Pointer) Type() string

Type returns the string wayland type

type PointerListener 

type PointerListener interface {
	Enter(serial uint32, surface uint32, surfaceX float64, surfaceY float64)
	Leave(serial uint32, surface uint32)
	Motion(time uint32, surfaceX float64, surfaceY float64)
	Button(serial uint32, time uint32, button uint32, state uint32)
	Axis(time uint32, axis uint32, value float64)
	Frame()
	AxisSource(axisSource uint32)
	AxisStop(time uint32, axis uint32)
	AxisDiscrete(axis uint32, discrete int32)
}

Pointer Events

Enter 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.

Leave 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.

Motion Notification of pointer location change. The arguments surface_x and surface_y are the location relative to the focused surface.

Button 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.

Axis 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.

Frame 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.

AxisSource 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.

AxisStop 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.

AxisDiscrete 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 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.

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.

type Region 

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

A region object describes an area.

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

func (*Region) Add 

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

Add the specified rectangle to the region.

func (*Region) Destroy 

func (this *Region) Destroy() error

Destroy the region. This will invalidate the object ID.

func (*Region) ID 

func (this *Region) ID() uint32

ID returns the wayland object identifier

func (*Region) Subtract 

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

Subtract the specified rectangle from the region.

func (*Region) Type 

func (this *Region) Type() string

Type returns the string wayland type

type RegionListener 

type RegionListener interface {
}

Region Events

type Registry 

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

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 (this *Registry) Bind(name uint32, iface string, version uint32, id uint32) error

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

func (*Registry) ID 

func (this *Registry) ID() uint32

ID returns the wayland object identifier

func (*Registry) Type 

func (this *Registry) Type() string

Type returns the string wayland type

type RegistryListener 

type RegistryListener interface {
	Global(name uint32, iface string, version uint32)
	GlobalRemove(name uint32)
}

Registry Events

Global 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.

GlobalRemove 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.

type Seat 

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

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 (this *Seat) GetKeyboard(l KeyboardListener) (*Keyboard, error)

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.

func (*Seat) GetPointer 

func (this *Seat) GetPointer(l PointerListener) (*Pointer, error)

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.

func (*Seat) GetTouch 

func (this *Seat) GetTouch(l TouchListener) (*Touch, error)

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.

func (*Seat) ID 

func (this *Seat) ID() uint32

ID returns the wayland object identifier

func (*Seat) Release 

func (this *Seat) Release() error

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

func (*Seat) Type 

func (this *Seat) Type() string

Type returns the string wayland type

type SeatListener 

type SeatListener interface {
	Capabilities(capabilities uint32)
	Name(name string)
}

Seat Events

Capabilities 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.

Name In a multiseat configuration this can be used by the client to help identify which physical devices the seat represents. Based on the seat configuration used by the compositor.

type Shell 

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

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.

func (*Shell) GetShellSurface 

func (this *Shell) GetShellSurface(l ShellSurfaceListener, surface uint32) (*ShellSurface, error)

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.

func (*Shell) ID 

func (this *Shell) ID() uint32

ID returns the wayland object identifier

func (*Shell) Type 

func (this *Shell) Type() string

Type returns the string wayland type

type ShellListener 

type ShellListener interface {
}

Shell Events

type ShellSurface 

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

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) ID 

func (this *ShellSurface) ID() uint32

ID returns the wayland object identifier

func (*ShellSurface) Move 

func (this *ShellSurface) Move(seat uint32, serial uint32) error

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 (this *ShellSurface) Pong(serial uint32) error

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

func (*ShellSurface) Resize 

func (this *ShellSurface) Resize(seat uint32, serial uint32, edges uint32) error

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 (this *ShellSurface) SetClass(class string) error

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 (this *ShellSurface) SetFullscreen(method uint32, framerate uint32, output uint32) error

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) SetMaximized 

func (this *ShellSurface) SetMaximized(output uint32) error

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 (this *ShellSurface) SetPopup(seat uint32, serial uint32, parent uint32, x int32, y int32, flags uint32) error

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 (this *ShellSurface) SetTitle(title string) error

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 (this *ShellSurface) SetToplevel() error

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

func (*ShellSurface) SetTransient 

func (this *ShellSurface) SetTransient(parent uint32, x int32, y int32, flags uint32) error

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.

func (*ShellSurface) Type 

func (this *ShellSurface) Type() string

Type returns the string wayland type

type ShellSurfaceListener 

type ShellSurfaceListener interface {
	Ping(serial uint32)
	Configure(edges uint32, width int32, height int32)
	PopupDone()
}

ShellSurface Events

Ping Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request.

Configure 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.

PopupDone 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.

type Shm 

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

A singleton global object that provides support for shared memory.

Clients can create wl_shm_pool objects using the create_pool request.

At connection setup time, the wl_shm object emits one or more format events to inform clients about the valid pixel formats that can be used for buffers.

func (*Shm) CreatePool 

func (this *Shm) CreatePool(l ShmPoolListener, fd *os.File, size int32) (*ShmPool, error)

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) ID 

func (this *Shm) ID() uint32

ID returns the wayland object identifier

func (*Shm) Type 

func (this *Shm) Type() string

Type returns the string wayland type

type ShmListener 

type ShmListener interface {
	Format(format uint32)
}

Shm Events

Format Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888.

type ShmPool 

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

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 (this *ShmPool) CreateBuffer(l BufferListener, offset int32, width int32, height int32, stride int32, format uint32) (*Buffer, error)

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 (this *ShmPool) Destroy() error

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) ID 

func (this *ShmPool) ID() uint32

ID returns the wayland object identifier

func (*ShmPool) Resize 

func (this *ShmPool) Resize(size int32) error

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.

func (*ShmPool) Type 

func (this *ShmPool) Type() string

Type returns the string wayland type

type ShmPoolListener 

type ShmPoolListener interface {
}

ShmPool Events

type Subcompositor 

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

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 (this *Subcompositor) Destroy() error

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 (this *Subcompositor) GetSubsurface(l SubsurfaceListener, surface uint32, parent uint32) (*Subsurface, error)

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 a protocol error is raised.

func (*Subcompositor) ID 

func (this *Subcompositor) ID() uint32

ID returns the wayland object identifier

func (*Subcompositor) Type 

func (this *Subcompositor) Type() string

Type returns the string wayland type

type SubcompositorListener 

type SubcompositorListener interface {
}

Subcompositor Events

type Subsurface 

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

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 have also other 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.

If the wl_surface associated with the wl_subsurface is destroyed, the wl_subsurface object becomes inert. Note, that destroying either object 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.

func (*Subsurface) Destroy 

func (this *Subsurface) Destroy() error

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, and the wl_surface loses its role as a sub-surface. The wl_surface is unmapped.

func (*Subsurface) ID 

func (this *Subsurface) ID() uint32

ID returns the wayland object identifier

func (*Subsurface) PlaceAbove 

func (this *Subsurface) PlaceAbove(sibling uint32) error

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. When this happens depends on whether the parent surface is in synchronized mode or not. See wl_subsurface.set_sync and wl_subsurface.set_desync for details.

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

func (*Subsurface) PlaceBelow 

func (this *Subsurface) PlaceBelow(sibling uint32) error

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

func (*Subsurface) SetDesync 

func (this *Subsurface) SetDesync() error

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 (this *Subsurface) SetPosition(x int32, y int32) error

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. When this happens depends on whether the parent surface is in synchronized mode or not. See wl_subsurface.set_sync and wl_subsurface.set_desync for details.

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 (this *Subsurface) SetSync() error

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.

func (*Subsurface) Type 

func (this *Subsurface) Type() string

Type returns the string wayland type

type SubsurfaceListener 

type SubsurfaceListener interface {
}

Subsurface Events

type Surface 

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

A surface is a rectangular area that is displayed on the screen. It has a location, size and pixel contents.

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.

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 (this *Surface) Attach(buffer uint32, x int32, y int32) error

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 the supplied buffer must be an integer multiple of the buffer_scale.

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 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.

Destroying the wl_buffer after wl_buffer.release does not change the surface contents. However, if the client destroys the wl_buffer before receiving the wl_buffer.release event, 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.

func (*Surface) Commit 

func (this *Surface) Commit() error

Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered. Protocol requests modify the pending state, as opposed to the current state in use by the compositor. A commit request atomically applies all pending state, replacing the current state. After commit, the new pending state is as documented for each related request.

On commit, a pending wl_buffer is applied first, and all other state second. This means that all coordinates in double-buffered state are relative to the new wl_buffer coming into use, except for wl_surface.attach itself. If there is no pending wl_buffer, the coordinates are relative to the current surface contents.

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 (this *Surface) Damage(x int32, y int32, width int32, height int32) error

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.

Alternatively, damage can be posted with wl_surface.damage_buffer which uses buffer coordinates instead of surface coordinates, and is probably the preferred and intuitive way of doing this.

func (*Surface) DamageBuffer 

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

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 (this *Surface) Destroy() error

Deletes the surface and invalidates its object ID.

func (*Surface) Frame 

func (this *Surface) Frame(l CallbackListener) (*Callback, error)

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) ID 

func (this *Surface) ID() uint32

ID returns the wayland object identifier

func (*Surface) SetBufferScale 

func (this *Surface) SetBufferScale(scale int32) error

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 positive the invalid_scale protocol error is raised.

func (*Surface) SetBufferTransform 

func (this *Surface) SetBufferTransform(transform int32) error

This request sets an optional transformation on how the compositor interprets the contents of the buffer attached to the surface. The accepted values for the transform parameter are the values for wl_output.transform.

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 (this *Surface) SetInputRegion(region uint32) error

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) SetOpaqueRegion 

func (this *Surface) SetOpaqueRegion(region uint32) error

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.

func (*Surface) Type 

func (this *Surface) Type() string

Type returns the string wayland type

type SurfaceListener 

type SurfaceListener interface {
	Enter(output uint32)
	Leave(output uint32)
}

Surface Events

Enter 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.

Leave 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.

type Touch 

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

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) ID 

func (this *Touch) ID() uint32

ID returns the wayland object identifier

func (*Touch) Release 

func (this *Touch) Release() error

func (*Touch) Type 

func (this *Touch) Type() string

Type returns the string wayland type

type TouchListener 

type TouchListener interface {
	Down(serial uint32, time uint32, surface uint32, id int32, x float64, y float64)
	Up(serial uint32, time uint32, id int32)
	Motion(time uint32, id int32, x float64, y float64)
	Frame()
	Cancel()
	Shape(id int32, major float64, minor float64)
	Orientation(id int32, orientation float64)
}

Touch Events

Down 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.

Up 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.

Motion A touch point has changed coordinates.

Frame 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.

Cancel 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.

Shape 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.

Orientation 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.

type ZxdgPopupV6 

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

A popup surface is a short-lived, temporary surface. It can be used to implement for example menus, popovers, tooltips and other similar user interface concepts.

A popup can be made to take an explicit grab. See xdg_popup.grab for details.

When the popup is dismissed, a popup_done event will be sent out, and at the same time the surface will be unmapped. See the xdg_popup.popup_done event for details.

Explicitly destroying the xdg_popup object will also dismiss the popup and unmap the surface. Clients that want to dismiss the popup when another surface of their own is clicked should dismiss the popup using the destroy request.

The parent surface must have either the xdg_toplevel or xdg_popup surface role.

A newly created xdg_popup will be stacked on top of all previously created xdg_popup surfaces associated with the same xdg_toplevel.

The parent of an xdg_popup must be mapped (see the xdg_surface description) before the xdg_popup itself.

The x and y arguments passed when creating the popup object specify where the top left of the popup should be placed, relative to the local surface coordinates of the parent surface. See xdg_surface.get_popup. An xdg_popup must intersect with or be at least partially adjacent to its parent surface.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_popup state to take effect.

func (*ZxdgPopupV6) Destroy 

func (this *ZxdgPopupV6) Destroy() error

This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface.

If this xdg_popup is not the "topmost" popup, a protocol error will be sent.

func (*ZxdgPopupV6) Grab 

func (this *ZxdgPopupV6) Grab(seat uint32, serial uint32) error

This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.

If the compositor denies the grab, the popup will be immediately dismissed.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The serial number of the event should be passed as 'serial'.

The parent of a grabbing popup must either be an xdg_toplevel surface or another xdg_popup with an explicit grab. If the parent is another xdg_popup it means that the popups are nested, with this popup now being the topmost popup.

Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one.

When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client.

The parent of a grabbing popup must either be another xdg_popup with an active explicit grab, or an xdg_popup or xdg_toplevel, if there are no explicit grabs already taken.

If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab.

If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised.

During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an "owner-events" grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.

func (*ZxdgPopupV6) ID 

func (this *ZxdgPopupV6) ID() uint32

ID returns the wayland object identifier

func (*ZxdgPopupV6) Type 

func (this *ZxdgPopupV6) Type() string

Type returns the string wayland type

type ZxdgPopupV6Listener 

type ZxdgPopupV6Listener interface {
	Configure(x int32, y int32, width int32, height int32)
	PopupDone()
}

ZxdgPopupV6 Events

Configure This event asks the popup surface to configure itself given the configuration. The configured state should not be applied immediately. See xdg_surface.configure for details.

The x and y arguments represent the position the popup was placed at given the xdg_positioner rule, relative to the upper left corner of the window geometry of the parent surface.

PopupDone The popup_done event is sent out when a popup is dismissed by the compositor. The client should destroy the xdg_popup object at this point.

type ZxdgPositionerV6 

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

The xdg_positioner provides a collection of rules for the placement of a child surface relative to a parent surface. Rules can be defined to ensure the child surface remains within the visible area's borders, and to specify how the child surface changes its position, such as sliding along an axis, or flipping around a rectangle. These positioner-created rules are constrained by the requirement that a child surface must intersect with or be at least partially adjacent to its parent surface.

See the various requests for details about possible rules.

At the time of the request, the compositor makes a copy of the rules specified by the xdg_positioner. Thus, after the request is complete the xdg_positioner object can be destroyed or reused; further changes to the object will have no effect on previous usages.

For an xdg_positioner object to be considered complete, it must have a non-zero size set by set_size, and a non-zero anchor rectangle set by set_anchor_rect. Passing an incomplete xdg_positioner object when positioning a surface raises an error.

func (*ZxdgPositionerV6) Destroy 

func (this *ZxdgPositionerV6) Destroy() error

Notify the compositor that the xdg_positioner will no longer be used.

func (*ZxdgPositionerV6) ID 

func (this *ZxdgPositionerV6) ID() uint32

ID returns the wayland object identifier

func (*ZxdgPositionerV6) SetAnchor 

func (this *ZxdgPositionerV6) SetAnchor(anchor uint32) error

Defines a set of edges for the anchor rectangle. These are used to derive an anchor point that the child surface will be positioned relative to. If two orthogonal edges are specified (e.g. 'top' and 'left'), then the anchor point will be the intersection of the edges (e.g. the top left position of the rectangle); otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

If two parallel anchor edges are specified (e.g. 'left' and 'right'), the invalid_input error is raised.

func (*ZxdgPositionerV6) SetAnchorRect 

func (this *ZxdgPositionerV6) SetAnchorRect(x int32, y int32, width int32, height int32) error

Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface. The rectangle must be at least 1x1 large.

When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface.

If a zero or negative size is set the invalid_input error is raised.

func (*ZxdgPositionerV6) SetConstraintAdjustment 

func (this *ZxdgPositionerV6) SetConstraintAdjustment(constraintAdjustment uint32) error

Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

func (*ZxdgPositionerV6) SetGravity 

func (this *ZxdgPositionerV6) SetGravity(gravity uint32) error

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If two orthogonal gravities are specified (e.g. 'bottom' and 'right'), then the child surface will be placed in the specified direction; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.

If two parallel gravities are specified (e.g. 'left' and 'right'), the invalid_input error is raised.

func (*ZxdgPositionerV6) SetOffset 

func (this *ZxdgPositionerV6) SetOffset(x int32, y int32) error

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

func (*ZxdgPositionerV6) SetSize 

func (this *ZxdgPositionerV6) SetSize(width int32, height int32) error

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If a zero or negative size is set the invalid_input error is raised.

func (*ZxdgPositionerV6) Type 

func (this *ZxdgPositionerV6) Type() string

Type returns the string wayland type

type ZxdgPositionerV6Listener 

type ZxdgPositionerV6Listener interface {
}

ZxdgPositionerV6 Events

type ZxdgShellV6 

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

xdg_shell allows clients to turn a wl_surface into a "real window" which can be dragged, resized, stacked, and moved around by the user. Everything about this interface is suited towards traditional desktop environments.

func (*ZxdgShellV6) CreatePositioner 

func (this *ZxdgShellV6) CreatePositioner(l ZxdgPositionerV6Listener) (*ZxdgPositionerV6, error)

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

func (*ZxdgShellV6) Destroy 

func (this *ZxdgShellV6) Destroy() error

Destroy this xdg_shell object.

Destroying a bound xdg_shell object while there are surfaces still alive created by this xdg_shell object instance is illegal and will result in a protocol error.

func (*ZxdgShellV6) GetXdgSurface 

func (this *ZxdgShellV6) GetXdgSurface(l ZxdgSurfaceV6Listener, surface uint32) (*ZxdgSurfaceV6, error)

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

func (*ZxdgShellV6) ID 

func (this *ZxdgShellV6) ID() uint32

ID returns the wayland object identifier

func (*ZxdgShellV6) Pong 

func (this *ZxdgShellV6) Pong(serial uint32) error

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

func (*ZxdgShellV6) Type 

func (this *ZxdgShellV6) Type() string

Type returns the string wayland type

type ZxdgShellV6Listener 

type ZxdgShellV6Listener interface {
	Ping(serial uint32)
}

ZxdgShellV6 Events

Ping The ping event asks the client if it's still alive. Pass the serial specified in the event back to the compositor by sending a "pong" request back with the specified serial. See xdg_shell.ping.

Compositors can use this to determine if the client is still alive. It's unspecified what will happen if the client doesn't respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.

A compositor is free to ping in any way it wants, but a client must always respond to any xdg_shell object it created.

type ZxdgSurfaceV6 

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

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

It provides a base set of functionality required to construct user interface elements requiring management by the compositor, such as toplevel windows, menus, etc. The types of functionality are split into xdg_surface roles.

Creating an xdg_surface does not set the role for a wl_surface. In order to map an xdg_surface, the client must create a role-specific object using, e.g., get_toplevel, get_popup. The wl_surface for any given xdg_surface can have at most one role, and may not be assigned any role not based on xdg_surface.

A role must be assigned before any other requests are made to the xdg_surface object.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect.

Creating an xdg_surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_surface.configure call must also be treated as errors.

For a surface to be mapped by the compositor, the following conditions must be met: (1) the client has assigned a xdg_surface based role to the surface, (2) the client has set and committed the xdg_surface state and the role dependent state to the surface and (3) the client has committed a buffer to the surface.

func (*ZxdgSurfaceV6) AckConfigure 

func (this *ZxdgSurfaceV6) AckConfigure(serial uint32) error

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

func (*ZxdgSurfaceV6) Destroy 

func (this *ZxdgSurfaceV6) Destroy() error

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed.

func (*ZxdgSurfaceV6) GetPopup 

func (this *ZxdgSurfaceV6) GetPopup(l ZxdgPopupV6Listener, parent uint32, positioner uint32) (*ZxdgPopupV6, error)

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

func (*ZxdgSurfaceV6) GetToplevel 

func (this *ZxdgSurfaceV6) GetToplevel(l ZxdgToplevelV6Listener) (*ZxdgToplevelV6, error)

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.

func (*ZxdgSurfaceV6) ID 

func (this *ZxdgSurfaceV6) ID() uint32

ID returns the wayland object identifier

func (*ZxdgSurfaceV6) SetWindowGeometry 

func (this *ZxdgSurfaceV6) SetWindowGeometry(x int32, y int32, width int32, height int32) error

The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

func (*ZxdgSurfaceV6) Type 

func (this *ZxdgSurfaceV6) Type() string

Type returns the string wayland type

type ZxdgSurfaceV6Listener 

type ZxdgSurfaceV6Listener interface {
	Configure(serial uint32)
}

ZxdgSurfaceV6 Events

Configure The configure event marks the end of a configure sequence. A configure sequence is a set of one or more events configuring the state of the xdg_surface, including the final xdg_surface.configure event.

Where applicable, xdg_surface surface roles will during a configure sequence extend this event as a latched state sent as events before the xdg_surface.configure event. Such events should be considered to make up a set of atomically applied configuration states, where the xdg_surface.configure commits the accumulated state.

Clients should arrange their surface for the new states, and then send an ack_configure request with the serial sent in this configure event at some point before committing the new surface.

If the client receives multiple configure events before it can respond to one, it is free to discard all but the last event it received.

type ZxdgToplevelV6 

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

This interface defines an xdg_surface role which allows a surface to, among other things, set window-like properties such as maximize, fullscreen, and minimize, set application-specific metadata like title and id, and well as trigger user interactive operations such as interactive resize and move.

func (*ZxdgToplevelV6) Destroy 

func (this *ZxdgToplevelV6) Destroy() error

Unmap and destroy the window. The window will be effectively hidden from the user's point of view, and all state like maximization, fullscreen, and so on, will be lost.

func (*ZxdgToplevelV6) ID 

func (this *ZxdgToplevelV6) ID() uint32

ID returns the wayland object identifier

func (*ZxdgToplevelV6) Move 

func (this *ZxdgToplevelV6) Move(seat uint32, serial uint32) error

Start an interactive, user-driven move of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc).

The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid.

If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed.

func (*ZxdgToplevelV6) Resize 

func (this *ZxdgToplevelV6) Resize(seat uint32, serial uint32, edges uint32) error

Start a user-driven, interactive resize of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

If triggered, the client will receive configure events with the "resize" state enum value and the expected sizes. See the "resize" enum value for more details about what is required. The client must also acknowledge configure events using "ack_configure". After the resize is completed, the client will receive another "configure" event without the resize state.

If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc) used for the resize. It is up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. There is no guarantee that the device focus will return when the resize is completed.

The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. The compositor may use this information to update the surface position for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image.

func (*ZxdgToplevelV6) SetAppID 

func (this *ZxdgToplevelV6) SetAppID(appID string) error

Set an application identifier for the surface.

The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application.

For D-Bus activatable applications, the app ID is used as the D-Bus service name.

The compositor shell will try to group application surfaces together by their app ID. As a best practice, it is suggested to select app ID's that match the basename of the application's .desktop file. For example, "org.freedesktop.FooViewer" where the .desktop file is "org.freedesktop.FooViewer.desktop".

See the desktop-entry specification [0] for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files.

[0] http://standards.freedesktop.org/desktop-entry-spec/

func (*ZxdgToplevelV6) SetFullscreen 

func (this *ZxdgToplevelV6) SetFullscreen(output uint32) error

Make the surface fullscreen.

You can specify an output that you would prefer to be fullscreen. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface.

If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with black borders filling the rest of the output.

func (*ZxdgToplevelV6) SetMaxSize 

func (this *ZxdgToplevelV6) SetMaxSize(width int32, height int32) error

Set a maximum size for the window.

The client can specify a maximum size so that the compositor does not try to configure the window beyond this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the maximum size. The compositor may decide to ignore the values set by the client and request a larger size.

If never set, or a value of zero in the request, means that the client has no expected maximum size in the given dimension. As a result, a client wishing to reset the maximum size to an unspecified state can use zero for width and height in the request.

Requesting a maximum size to be smaller than the minimum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

func (*ZxdgToplevelV6) SetMaximized 

func (this *ZxdgToplevelV6) SetMaximized() error

Maximize the surface.

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event with the "maximized" state and the required window geometry. The client should then update its content, drawing it in a maximized state, i.e. without shadow or other decoration outside of the window geometry. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to decide how and where to maximize the surface, for example which output and what region of the screen should be used.

If the surface was already maximized, the compositor will still emit a configure event with the "maximized" state.

func (*ZxdgToplevelV6) SetMinSize 

func (this *ZxdgToplevelV6) SetMinSize(width int32, height int32) error

Set a minimum size for the window.

The client can specify a minimum size so that the compositor does not try to configure the window below this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore the values set by the client and request a smaller size.

If never set, or a value of zero in the request, means that the client has no expected minimum size in the given dimension. As a result, a client wishing to reset the minimum size to an unspecified state can use zero for width and height in the request.

Requesting a minimum size to be larger than the maximum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

func (*ZxdgToplevelV6) SetMinimized 

func (this *ZxdgToplevelV6) SetMinimized() error

Request that the compositor minimize your surface. There is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface.

If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features.

func (*ZxdgToplevelV6) SetParent 

func (this *ZxdgToplevelV6) SetParent(parent uint32) error

Set the "parent" of this surface. This window should be stacked above a parent. The parent surface must be mapped as long as this surface is mapped.

Parent windows should be set on dialogs, toolboxes, or other "auxiliary" surfaces, so that the parent is raised when the dialog is raised.

func (*ZxdgToplevelV6) SetTitle 

func (this *ZxdgToplevelV6) SetTitle(title string) error

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 (*ZxdgToplevelV6) ShowWindowMenu 

func (this *ZxdgToplevelV6) ShowWindowMenu(seat uint32, serial uint32, x int32, y int32) error

Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window.

This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

func (*ZxdgToplevelV6) Type 

func (this *ZxdgToplevelV6) Type() string

Type returns the string wayland type

func (*ZxdgToplevelV6) UnsetFullscreen 

func (this *ZxdgToplevelV6) UnsetFullscreen() error

func (*ZxdgToplevelV6) UnsetMaximized 

func (this *ZxdgToplevelV6) UnsetMaximized() error

Unmaximize the surface.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event without the "maximized" state. If available, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure request. The client must then update its content, drawing it in a regular state, i.e. potentially with shadow, etc. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable.

If the surface was already not maximized, the compositor will still emit a configure event without the "maximized" state.

type ZxdgToplevelV6Listener 

type ZxdgToplevelV6Listener interface {
	Configure(width int32, height int32, states []byte)
	Close()
}

ZxdgToplevelV6 Events

Configure This configure event asks the client to resize its toplevel surface or to change its state. The configured state should not be applied immediately. See xdg_surface.configure for details.

The width and height arguments specify a hint to the window about how its surface should be resized in window geometry coordinates. See set_window_geometry.

If the width or height arguments are zero, it means the client should decide its own window dimension. This may happen when the compositor needs to configure the state of the surface but doesn't have any information about any previous or expected dimension.

The states listed in the event specify how the width/height arguments should be interpreted, and possibly how it should be drawn.

Clients must send an ack_configure in response to this event. See xdg_surface.configure and xdg_surface.ack_configure for details.

Close The close event is sent by the compositor when the user wants the surface to be closed. This should be equivalent to the user clicking the close button in client-side decorations, if your application has any.

This is only a request that the user intends to close the window. The client may choose to ignore this request, or show a dialog to ask the user to save their data, etc.

Source Files

View all Source files

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.