The wayflan Reference Manual

This is the wayflan Reference Manual, version 0.0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:44:11 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 wayflan

From-scratch Wayland client implementation

Author

Samuel Hunter

License

BSD 3-Clause

Version

0.0.3

Dependency

wayflan-client (system).

Source

wayflan.asd.


2.2 wayflan-client

From-scratch Wayland client implementation

Author

Samuel Hunter

License

BSD 3-Clause

Version

0.0.3

Defsystem Dependency

cffi-grovel (system).

Dependencies
Source

wayflan-client.asd.

Child Components

2.3 wayflan/common

PRIVATE: Wayflan common source for client and server

Author

Samuel Hunter

License

BSD 3-Clause

Version

0.0.3

Defsystem Dependency

cffi-grovel (system).

Dependencies
  • alexandria (system).
  • babel (system).
  • cffi (system).
  • plump (system).
Source

wayflan.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 wayflan/common/protocols

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 wayflan/wayflan.asd

Source

wayflan.asd.

Parent Component

wayflan (system).

ASDF Systems

4.1.2 wayflan-client/wayflan-client.asd

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

ASDF Systems

wayflan-client.


4.1.4 wayflan-client/client.lisp

Dependency

packages.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface
Internals

4.1.5 wayflan-client/scanner.lisp

Dependency

client.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface

wl-include (macro).

Internals

4.1.6 wayflan-client/asdf.lisp

Dependency

scanner.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface
Internals

4.1.7 wayflan-client/wayland-protocol.lisp

Dependency

scanner.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface
Internals

4.1.8 wayflan-client/stable-protocols.lisp

Dependencies
Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface
Internals

4.1.9 wayflan/common/packages.lisp

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Packages

4.1.10 wayflan/common/protocol.lisp

Dependency

packages.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface
Internals

4.1.11 wayflan/common/types.lisp

Dependency

packages.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface
Internals

octet (type).


4.1.12 wayflan/common/grovel.lisp

Dependency

packages.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).


4.1.13 wayflan/common/ffi.lisp

Dependency

grovel.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface
Internals

4.1.14 wayflan/common/conditions.lisp

Dependencies
Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface

4.1.15 wayflan/common/wire.lisp

Dependencies
Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface
Internals

4.2 Static


4.2.1 wayflan/common/protocols/wayland.xml

Source

wayflan.asd.

Parent Component

protocols (module).


4.2.2 wayflan/common/protocols/presentation-time.xml

Source

wayflan.asd.

Parent Component

protocols (module).


4.2.3 wayflan/common/protocols/viewporter.xml

Source

wayflan.asd.

Parent Component

protocols (module).


4.2.4 wayflan/common/protocols/xdg-shell.xml

Source

wayflan.asd.

Parent Component

protocols (module).


5 Packages

Packages are listed by definition order.


5.1 xyz.shunter.wayflan.wire

PRIVATE: Wayland wire format marshalling.

The wayland-wire package defines utilities for communicating primitive data through a local address socket

PRIVATE: This package is private to Wayflan, and its API is susceptible to change. Please do not use this package in your own code.

Source

packages.lisp.

Use List
Used By List

xyz.shunter.wayflan.client.

Public Interface
Internals

5.2 xyz.shunter.wayflan.client

Wayland client and core protocol implementation.

Wayland is a protocol for a compositor to talk to its clients.
The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, or an X application, or a Wayland client itself.
The clients can be traditional applications, X servers (rootless or fullscreen), or other display servers.

This package defines the client’s interpretation of various CLOS classes, the event protocol, define- macros to implement wayland protocols, and the core Wayland protocol.

Source

packages.lisp.

Nickname

wayflan-client

Use List
Used By List
Public Interface
Internals

5.3 xyz.shunter.wayflan.ffi

PRIVATE: This package is private to Wayflan, and its API is susceptible to change. Please do not use this package in your own code.

Source

packages.lisp.

Use List

cffi.

Used By List

xyz.shunter.wayflan.wire.

Public Interface
Internals

5.4 xyz.shunter.wayflan.client.viewporter

Wayland Viewporter protocol implementation.

Wayland is a protocol for a compositor to talk to its clients.
The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, or an X application, or a Wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen), or other display servers.

This package implements the stable Viewporter protocol.

Source

packages.lisp.

Nickname

wayflan-client.viewporter

Use List
Public Interface

5.5 xyz.shunter.wayflan.client.scanner

PRIVATE: Wayland XML protocol definitions auto-wrapper.

This package defines WL-INCLUDE, a macro that transforms a Wayland protocol described in an XML file into wayflan definition forms.

PRIVATE: This package is private to Wayflan, and its API is susceptible to change. Please do not use this package in your own code.

Source

packages.lisp.

Use List
Public Interface

wl-include (macro).

Internals

5.6 xyz.shunter.wayflan.client.presentation-time

Wayland Presentation time protocol implementation.

Wayland is a protocol for a compositor to talk to its clients.
The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, or an X application, or a Wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen), or other display servers.

This package implements the stable Presentation Time protocol.

Source

packages.lisp.

Nickname

wayflan-client.presentation-time

Use List
Public Interface

5.7 xyz.shunter.wayflan.client.xdg-shell

Wayland XDG shell protocol implementation.

Wayland is a protocol for a compositor to talk to its clients.
The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, or an X application, or a Wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen), or other display servers.

This package implements the stable XDG shell protocol.

Source

packages.lisp.

Nickname

wayflan-client.xdg-shell

Use List
Public Interface

5.8 xyz.shunter.wayflan

Wayland protocol and type information

Wayland is a protocol for a compositor to talk to its clients.
The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, or an X application, or a Wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen), or other display servers.

This package defines Wayland protocol CLOS objects, a function that parses a protocol document into CLOS, and a series of types of Wayland primitives.

Source

packages.lisp.

Nickname

wayflan

Use List
  • alexandria.
  • asdf/interface.
  • common-lisp.
Used By List
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Constants

Constant: +most-negative-wl-fixed+
Package

xyz.shunter.wayflan.

Source

types.lisp.

Constant: +most-negative-wl-int+
Package

xyz.shunter.wayflan.

Source

types.lisp.

Constant: +most-positive-wl-fixed+
Package

xyz.shunter.wayflan.

Source

types.lisp.

Constant: +most-positive-wl-int+
Package

xyz.shunter.wayflan.

Source

types.lisp.

Constant: +most-positive-wl-uint+
Package

xyz.shunter.wayflan.

Source

types.lisp.


6.1.2 Symbol macros

Symbol Macro: *errno*
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.


6.1.3 Macros

Macro: define-enum (name () &body entry-specifiers)

Define a parameter that associates each entry keyword with an index in the array.

NAME - The name of the enum class. Used as arguments in Wayland types :INT and :UINT.

OPTIONS:

(:since INTEGER) - The interface version since it appeared.
(:documentation DOCSTRING) - Ignored.
(:bitfield BOOLEAN) - Whether individual bits have specific meanings. If set, enums are decoded as a list of arguments, rather than a single argument.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: define-event ((name interface opcode) &body arg-specifiers)

Define an event to be read by WL-DISPLAY-DISPATCH-EVENT.

NAME - The name of the event. It can be anything, but is usually a keyword unique to the interface.
INTERFACE - The name of the interface (as provided by define-interface) whose objects send the event.
OPCODE - The integer opcode value of the event.

ARG-SPECIFIERS - Each specifier takes the lambda list (name &key type documentation).
TYPE - The Wayland type of the arg.
DOCUMENTATION - The summary of the arg.

OPTIONS:

(:DOCUMENTATION DOCSTRING) - Provided to the event class as its docstring.
(:TYPE TYPE) - TODO does nothing. So far, only :DESTRUCTOR is a valid type.
(:SINCE VERSION) - TODO in the future, asserts that only proxies of this version of higher should receive this event.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: define-interface (name () &body options)

Define a wl-proxy CLOS subclass and assign the interface’s name to the interface table, accessible via #’FIND-INTERFACE-NAMED.

NAME - The name of the interface class.

OPTIONS:

(:version VERSION) - Latest supported version of the interface.
(:documentation DOCSTRING) - Docstring attached to the defined class.
(:skip-defclass BOOLEAN) - If true, do not define the interface class.
Used by cl-autowrap when it reads wl_display.
(:interface-name STRING) - The name of the interface as listed by the wl-registry on a wl-registry-global-event.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: define-request ((name interface opcode) &body arg-specifiers)

Define a function implementing the wl request.
DEFINE-REQUEST currently only supports up to one :NEW-ID argument per request.

NAME - The name of the request function.
INTERFACE - The name of the interface (as provided by define-interface) whose proxies send the request. OPCODE - The integer opcode value of the request.

ARG-SPECIFIERS - Each specifier takes the lambda list (name &key type documentation).
TYPE - The Wayland type of the arg.
DOCUMENTATION - The summary of the arg.

OPTIONS:

(:DOCUMENTATION STRING) - Provided to the function as its docstring.
(:TYPE KEYWORD) - So far, only :DESTRUCTOR is a valid type.
(:SINCE VERSION) - Minimum interface version of the proxy object.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: evclambda (&body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: evelambda (&body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: event-case (event &body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: event-ccase (event &body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: event-ecase (event &body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: evlambda (&body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: send-wl-message ((socket sender-id opcode) types &rest objects)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Macro: with-incoming-message ((socket sender-id opcode buf) &body body)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Macro: with-open-display ((display &rest options) &body body)

Like WITH-OPEN-FILE, but binding DISPLAY to the result of WL-DISPLAY-CONNECT instead of OPEN. Executes the body with DISPLAY bound to a freshly connected display.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: with-proxy ((var value) &body body)

Bind the proxy variable VAR to VALUE, and destroy it when execution leaves the body.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: wl-include (input &key export exclude-defclasses)

Define the collection of interfaces, enums, requests, and events described by INPUT, for use by a Wayland client.

INPUT - A stream to an XML file, a pathname to an XML file, or an XML string.
EXPORT - If true, export all interned symbols in the current package.

Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.


6.1.4 Ordinary functions

Function: accept (sockfd addr addrlen)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: bind (sockfd addr addrlen)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: bzero (s n)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: close-fd (fd)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: cmsg-len (length)
Package

xyz.shunter.wayflan.ffi.

Source

wire.lisp.

Function: connect (socket address-string)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: connect-fd (sockfd addr addrlen)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: find-interface-named (name)

Return the interface linked to the given string NAME.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: find-proxy (display id)

Return a proxy with the given ID.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: make-socket ()
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: memcpy (dest src n)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: read-wl-array (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: read-wl-fixed (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: read-wl-int (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: read-wl-string (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: read-wl-uint (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: recvmsg (sockfd msg flags)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: sendmsg (sockfd msg flags)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: socket (domain type protocol)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: strerror (errnum)
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: wl-buffer.destroy (wl-buffer)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-compositor.create-region (wl-compositor)

create new region

Ask the compositor to create a new region.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-compositor.create-surface (wl-compositor)

create new surface

Ask the compositor to create a new surface.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-device-manager.create-data-source (wl-data-device-manager)

create a new data source

Create a new data source.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-device-manager.get-data-device (wl-data-device-manager seat)

create a new data device

Create a new data device for a given seat.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-device.release (wl-data-device)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-device.set-selection (wl-data-device source serial)

copy data to the selection

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

To unset the selection, set the source to NULL.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-device.start-drag (wl-data-device source origin icon serial)

start drag-and-drop operation

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

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

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

The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wl_surface.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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-offer.accept (wl-data-offer serial mime-type)

accept one of the offered mime types

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-offer.destroy (wl-data-offer)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-offer.finish (wl-data-offer)

the offer will no longer be used

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-offer.receive (wl-data-offer mime-type fd)

request that the data is transferred

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-offer.set-actions (wl-data-offer dnd-actions preferred-action)

set the available/preferred drag-and-drop actions

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

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-source.destroy (wl-data-source)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-source.offer (wl-data-source mime-type)

add an offered mime type

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-data-source.set-actions (wl-data-source dnd-actions)

set the available drag-and-drop actions

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-display-connect (&optional display-name)

Return a display connected to the given socket name.

WL-DISPLAY-CONNECT searches and connects to a Wayland display if DISPLAY-NAME is a pathname, a string, or not provided; if DISPLAY-NAME is a stream, it will take it in as-is.

Whether or not WL-DISPLAY-CONNECT opened a stream, it will close the display’s underlying stream when WL-DISPLAY-DISCONNECT is called.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: wl-display-dispatch-event (display)

Read and dispatch the display’s next event, or event if more than one is buffered. Return the number of events processed.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: wl-display-listen (display)

Return whether there is a (partial) message available from the display.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: wl-display-roundtrip (display)

Block and dispatch events until all requests sent up to this point have been finalized.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: wl-display.get-registry (wl-display)

get global registry object

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-display.sync (wl-display)

asynchronous roundtrip

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

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

The callback_data passed in the callback is the event serial.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-keyboard.release (wl-keyboard)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-output.release (wl-output)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-parse (input)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: wl-pointer.release (wl-pointer)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-pointer.set-cursor (wl-pointer serial surface hotspot-x hotspot-y)

set the pointer surface

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-region.add (wl-region x y width height)

add rectangle to region

Add the specified rectangle to the region.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-region.destroy (wl-region)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-region.subtract (wl-region x y width height)

subtract rectangle from region

Subtract the specified rectangle from the region.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-registry.bind (wl-registry name interface-class version)

bind an object to the display

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-seat.get-keyboard (wl-seat)

return keyboard object

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-seat.get-pointer (wl-seat)

return pointer object

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-seat.get-touch (wl-seat)

return touch object

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-seat.release (wl-seat)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.move (wl-shell-surface seat serial)

start an interactive move

Start a pointer-driven move of the surface.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.pong (wl-shell-surface serial)

respond to a ping event

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.resize (wl-shell-surface seat serial edges)

start an interactive resize

Start a pointer-driven resizing of the surface.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-class (wl-shell-surface class-)

set surface class

Set a class for the surface.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-fullscreen (wl-shell-surface method framerate output)

make the surface a fullscreen surface

Map the surface as a fullscreen surface.

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-maximized (wl-shell-surface output)

make the surface a maximized surface

Map the surface as a maximized surface.

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

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

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

The details depend on the compositor implementation.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-popup (wl-shell-surface seat serial parent x y flags)

make the surface a popup surface

Map the surface as a popup.

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-title (wl-shell-surface title)

set surface title

Set a short title for the surface.

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

The string must be encoded in UTF-8.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-toplevel (wl-shell-surface)

make the surface a toplevel surface

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell-surface.set-transient (wl-shell-surface parent x y flags)

make the surface a transient surface

Map the surface relative to an existing surface.

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

The flags argument controls details of the transient behaviour.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shell.get-shell-surface (wl-shell surface)

create a shell surface from a surface

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shm-pool.create-buffer (wl-shm-pool offset width height stride format)

create a buffer from the pool

Create a wl_buffer object from the pool.

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shm-pool.destroy (wl-shm-pool)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shm-pool.resize (wl-shm-pool size)

change the size of the pool mapping

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-shm.create-pool (wl-shm fd size)

create a shm pool

Create a new wl_shm_pool object.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subcompositor.destroy (wl-subcompositor)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subcompositor.get-subsurface (wl-subcompositor surface parent)

give a surface the role sub-surface

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.destroy (wl-subsurface)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.place-above (wl-subsurface sibling)

restack the sub-surface

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.place-below (wl-subsurface sibling)

restack the sub-surface

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.set-desync (wl-subsurface)

set sub-surface to desynchronized mode

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.set-position (wl-subsurface x y)

reposition the sub-surface

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

The scheduled coordinates will take effect whenever the state of the parent surface is applied. 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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-subsurface.set-sync (wl-subsurface)

set sub-surface to synchronized mode

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

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

See wl_subsurface for the recursive effect of this mode.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.attach (wl-surface buffer x y)

set the surface contents

Set a buffer as the content of this surface.

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

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

When the bound wl_surface version is 5 or higher, passing any non-zero x or y is a protocol violation, and will result in an ’invalid_offset’ error being raised. To achieve equivalent semantics, use wl_surface.offset.

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.commit (wl-surface)

commit pending surface state

Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered. Protocol requests modify the pending state, as opposed to the 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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.damage (wl-surface x y width height)

mark part of the surface damaged

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.damage-buffer (wl-surface x y width height)

mark part of the surface damaged using buffer coordinates

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

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.destroy (wl-surface)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.frame (wl-surface)

request a frame throttling hint

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

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

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.offset (wl-surface x y)

set the surface contents offset

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.set-buffer-scale (wl-surface scale)

sets the buffer scaling factor

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

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

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

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

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

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

If scale is not positive the invalid_scale protocol error is raised.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.set-buffer-transform (wl-surface transform)

sets the buffer transformation

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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.set-input-region (wl-surface region)

set input region

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

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

The input region is specified in surface-local coordinates.

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-surface.set-opaque-region (wl-surface region)

set opaque region

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

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

The opaque region is specified in surface-local coordinates.

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wl-touch.release (wl-touch)
Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Function: wp-presentation.destroy (wp-presentation)
Package

xyz.shunter.wayflan.client.presentation-time.

Source

stable-protocols.lisp.

Function: wp-presentation.feedback (wp-presentation surface)

request presentation feedback information

Request presentation feedback for the current content submission
on the given surface. This creates a new presentation_feedback object, which will deliver the feedback information once. If multiple presentation_feedback objects are created for the same submission, they will all deliver the same information.

For details on what information is returned, see the presentation_feedback interface.

Package

xyz.shunter.wayflan.client.presentation-time.

Source

stable-protocols.lisp.

Function: wp-viewport.destroy (wp-viewport)
Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Function: wp-viewport.set-destination (wp-viewport width height)

set the surface size for scaling

Set the destination size of the associated wl_surface. See wp_viewport for the description, and relation to the wl_buffer size.

If width is -1 and height is -1, the destination size is unset instead. Any other pair of values for width and height that contains zero or negative values raises the bad_value protocol error.

The crop and scale state is double-buffered state, and will be applied on the next wl_surface.commit.

Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Function: wp-viewport.set-source (wp-viewport x y width height)

set the source rectangle for cropping

Set the source rectangle of the associated wl_surface. See wp_viewport for the description, and relation to the wl_buffer size.

If all of x, y, width and height are -1.0, the source rectangle is unset instead. Any other set of values where width or height are zero or negative, or x or y are negative, raise the bad_value protocol error.

The crop and scale state is double-buffered state, and will be applied on the next wl_surface.commit.

Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Function: wp-viewporter.destroy (wp-viewporter)
Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Function: wp-viewporter.get-viewport (wp-viewporter surface)

extend surface interface for crop and scale

Instantiate an interface extension for the given wl_surface to crop and scale its content. If the given wl_surface already has a wp_viewport object associated, the viewport_exists protocol error is raised.

Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Function: xdg-popup.destroy (xdg-popup)
Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-popup.grab (xdg-popup seat serial)

make the popup take an explicit grab

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.

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-popup.reposition (xdg-popup positioner token)

recalculate the popup’s location

Reposition an already-mapped popup. The popup will be placed given the details in the passed xdg_positioner object, and a xdg_popup.repositioned followed by xdg_popup.configure and xdg_surface.configure will be emitted in response. Any parameters set by the previous positioner will be discarded.

The passed token will be sent in the corresponding xdg_popup.repositioned event. The new popup position will not take effect until the corresponding configure event is acknowledged by the client. See xdg_popup.repositioned for details. The token itself is opaque, and has no other special meaning.

If multiple reposition requests are sent, the compositor may skip all but the last one.

If the popup is repositioned in response to a configure event for its parent, the client should send an xdg_positioner.set_parent_configure and possibly an xdg_positioner.set_parent_size request to allow the compositor to properly constrain the popup.

If the popup is repositioned together with a parent that is being resized, but not in response to a configure event, the client should send an xdg_positioner.set_parent_size request.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.destroy (xdg-positioner)
Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-anchor (xdg-positioner anchor)

set anchor rectangle anchor

Defines the anchor point for the anchor rectangle. The specified anchor is used derive an anchor point that the child surface will be positioned relative to. If a corner anchor is set (e.g. ’top_left’ or ’bottom_right’), the anchor point will be at the specified corner; 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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-anchor-rect (xdg-positioner x y width height)

set the anchor rectangle within the parent surface

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.

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 negative size is set the invalid_input error is raised.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-constraint-adjustment (xdg-positioner constraint-adjustment)

set the adjustment to be done when constrained

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-gravity (xdg-positioner gravity)

set child surface gravity

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If a corner gravity is specified (e.g. ’bottom_right’ or ’top_left’), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-offset (xdg-positioner x y)

set surface position offset

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-parent-configure (xdg-positioner serial)

set parent configure this is a response to

Set the serial of an xdg_surface.configure event this positioner will be used in response to. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-parent-size (xdg-positioner parent-width parent-height)

Set the parent window geometry the compositor should use when positioning the popup. The compositor may use this information to determine the future state the popup should be constrained using. If this doesn’t match the dimension of the parent the popup is eventually positioned against, the behavior is undefined.

The arguments are given in the surface-local coordinate space.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-reactive (xdg-positioner)

continuously reconstrain the surface

When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the parent window moved.

If the conditions changed and the popup was reconstrained, an xdg_popup.configure event is sent with updated geometry, followed by an xdg_surface.configure event.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-positioner.set-size (xdg-positioner width height)

set the size of the to-be positioned rectangle

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-surface.ack-configure (xdg-surface serial)

ack a configure event

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.

Sending an ack_configure request consumes the serial number sent with the request, as well as serial numbers sent by all configure events sent on this xdg_surface prior to the configure event referenced by the committed serial.

It is an error to issue multiple ack_configure requests referencing a serial from the same configure event, or to issue an ack_configure request referencing a serial from a configure event issued before the event identified by the last ack_configure request for the same xdg_surface. Doing so will raise an invalid_serial error.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-surface.destroy (xdg-surface)
Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-surface.get-popup (xdg-surface parent positioner)

assign the xdg_popup surface role

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

If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state.

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

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-surface.get-toplevel (xdg-surface)

assign the xdg_toplevel surface role

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-surface.set-window-geometry (xdg-surface x y width height)

set the new window geometry

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.

When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window.

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.destroy (xdg-toplevel)
Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.move (xdg-toplevel seat serial)

start an interactive move

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.resize (xdg-toplevel seat serial edges)

start an interactive resize

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. Values not matching a variant of the enum will cause a protocol error. 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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-app-id (xdg-toplevel app-id)

set application ID

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

Like other properties, a set_app_id request can be sent after the xdg_toplevel has been mapped to update the property.

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/

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-fullscreen (xdg-toplevel output)

set the window as fullscreen on an output

Make the surface fullscreen.

After requesting that the surface should be fullscreened, the compositor will respond by emitting a configure event. Whether the client is actually put into a fullscreen state is subject to compositor policies. The client must also acknowledge the configure when committing the new content (see ack_configure).

The output passed by the request indicates the client’s preference as to which display it should be set fullscreen on. 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 with border fill covering the rest of the output. The content of the border fill is undefined, but should be assumed to be in some way that attempts to blend into the surrounding area (e.g. solid black).

If the fullscreened surface is not opaque, the compositor must make sure that other screen content not part of the same surface tree (made up of subsurfaces, popups or similarly coupled surfaces) are not visible below the fullscreened surface.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-max-size (xdg-toplevel width height)

set the maximum size

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-maximized (xdg-toplevel)

maximize the window

Maximize the surface.

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event. Whether this configure actually sets the window maximized is subject to compositor policies. The client must then update its content, drawing in the configured state. 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.

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-min-size (xdg-toplevel width height)

set the minimum size

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-minimized (xdg-toplevel)

set the window as minimized

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-parent (xdg-toplevel parent)

set the parent of this surface

Set the "parent" of this surface. This surface should be stacked above the parent surface and all other ancestor surfaces.

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

Setting a null parent for a child surface unsets its parent. Setting a null parent for a surface which currently has no parent is a no-op.

Only mapped surfaces can have child surfaces. Setting a parent which is not mapped is equivalent to setting a null parent. If a surface becomes unmapped, its children’s parent is set to the parent of the now-unmapped surface. If the now-unmapped surface has no parent, its children’s parent is unset. If the now-unmapped surface becomes mapped again, its parent-child relationship is not restored.

The parent toplevel must not be one of the child toplevel’s descendants, and the parent must be different from the child toplevel, otherwise the invalid_parent protocol error is raised.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.set-title (xdg-toplevel title)

set surface title

Set a short title for the surface.

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

The string must be encoded in UTF-8.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.show-window-menu (xdg-toplevel seat serial x y)

show the window menu

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.unset-fullscreen (xdg-toplevel)

unset the window as fullscreen

Make the surface no longer fullscreen.

After requesting that the surface should be unfullscreened, the
compositor will respond by emitting a configure event.
Whether this actually removes the fullscreen state of the client is
subject to compositor policies.

Making a surface unfullscreen sets states for the surface based on the following: * the state(s) it may have had before becoming fullscreen
* any state(s) decided by the compositor
* any state(s) requested by the client while the surface was fullscreen

The compositor may include the previous window geometry dimensions in
the configure event, if applicable.

The client must also acknowledge the configure when committing the new content (see ack_configure).

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-toplevel.unset-maximized (xdg-toplevel)

unmaximize the window

Unmaximize the surface.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event. Whether this actually un-maximizes the window is subject to compositor policies.
If available and applicable, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure event. The client must then update its content, drawing it in the configured state. 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.

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-wm-base.create-positioner (xdg-wm-base)

create a positioner object

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-wm-base.destroy (xdg-wm-base)
Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-wm-base.get-xdg-surface (xdg-wm-base surface)

create a shell surface from a surface

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. It is illegal to create an xdg_surface for a wl_surface which already has an assigned role and this will result in a protocol error.

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Function: xdg-wm-base.pong (xdg-wm-base serial)

respond to a ping event

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

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.


6.1.5 Generic functions

Generic Function: close-socket (socket)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: close-socket ((socket data-socket))
Generic Function: destroy-proxy (proxy)

Delist the proxy from its display and mark it as destroyed.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Method: destroy-proxy :before ((xdg-popup xdg-popup))

remove xdg_popup interface

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.

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((xdg-toplevel xdg-toplevel))

destroy the xdg_toplevel

This request destroys the role surface and unmaps the surface; see "Unmapping" behavior in interface section for details.

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((xdg-surface xdg-surface))

destroy the xdg_surface

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

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((xdg-positioner xdg-positioner))

destroy the xdg_positioner object

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

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((xdg-wm-base xdg-wm-base))

destroy xdg_wm_base

Destroy this xdg_wm_base object.

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

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((wp-viewport wp-viewport))

remove scaling and cropping from the surface

The associated wl_surface’s crop and scale state is removed. The change is applied on the next wl_surface.commit.

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((wp-viewporter wp-viewporter))

unbind from the cropping and scaling interface

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

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((wp-presentation wp-presentation))

unbind from the presentation interface

Informs the server that the client will no longer be using
this protocol object. Existing objects created by this object are not affected.

Source

stable-protocols.lisp.

Method: destroy-proxy :before ((wl-subsurface wl-subsurface))

remove sub-surface interface

The sub-surface interface is removed from the wl_surface object that was turned into a sub-surface with a wl_subcompositor.get_subsurface request. The wl_surface’s association to the parent is deleted, and the wl_surface loses its role as
a sub-surface. The wl_surface is unmapped immediately.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-subcompositor wl-subcompositor))

unbind from the subcompositor interface

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

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-region wl-region))

destroy region

Destroy the region. This will invalidate the object ID.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-output wl-output))

release the output object

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

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-touch wl-touch))

release the touch object

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-keyboard wl-keyboard))

release the keyboard object

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-pointer wl-pointer))

release the pointer object

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

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

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-seat wl-seat))

release the seat object

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

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-surface wl-surface))

delete surface

Deletes the surface and invalidates its object ID.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-data-device wl-data-device))

destroy data device

This request destroys the data device.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-data-source wl-data-source))

destroy the data source

Destroy the data source.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-data-offer wl-data-offer))

destroy data offer

Destroy the data offer.

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-buffer wl-buffer))

destroy a buffer

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

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

Source

wayland-protocol.lisp.

Method: destroy-proxy :before ((wl-shm-pool wl-shm-pool))

destroy the pool

Destroy the shared memory pool.

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

Source

wayland-protocol.lisp.

Method: destroy-proxy ((proxy wl-proxy))
Method: destroy-proxy ((proxy wl-display))
Generic Function: listen-socket (socket)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: listen-socket ((socket data-socket))
Generic Function: read-fd (socket)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: read-fd ((socket data-socket))
Generic Reader: wl-args (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-args ((%wl-message %wl-message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%args.

Generic Reader: wl-bitfield (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-bitfield ((wl-enum wl-enum))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%bitfield.

Generic Reader: wl-copyright (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-copyright ((wl-protocol wl-protocol))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%copyright.

Generic Reader: wl-description (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-description ((wl-entry wl-entry))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%description.

Reader Method: wl-description ((wl-enum wl-enum))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%description.

Reader Method: wl-description ((%wl-message %wl-message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%description.

Reader Method: wl-description ((wl-interface wl-interface))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%description.

Reader Method: wl-description ((wl-protocol wl-protocol))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%description.

Generic Function: wl-display-disconnect (display)

Close the display’s underlying stream and remove all proxies.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Method: wl-display-disconnect ((display wl-display))
Method: wl-display-disconnect ((display wl-destroyed-proxy))
Generic Reader: wl-display-pathname (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: wl-display-pathname ((wl-display wl-display))

automatically generated reader method

Source

client.lisp.

Target Slot

%pathname.

Generic Reader: wl-entries (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-entries ((wl-enum wl-enum))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%entries.

Generic Function: wl-enum-keyword (enum value)

Convert an integer into a KEYWORD (or, in the case of a bitfield enum, a list of keywords) according to ENUM.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-popup.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.wm-capabilities)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.state)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.resize-edge)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-surface.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.constraint-adjustment)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.gravity)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.anchor)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-wm-base.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.viewporter:wp-viewport.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.viewporter:wp-viewporter.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.presentation-time:wp-presentation-feedback.kind)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client.presentation-time:wp-presentation.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-subsurface.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-subcompositor.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-output.mode)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-output.transform)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-output.subpixel)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-keyboard.key-state)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-keyboard.keymap-format)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-pointer.axis-source)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-pointer.axis)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-pointer.button-state)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-pointer.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-seat.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-seat.capability)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-surface.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.fullscreen-method)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.transient)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.resize)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shell.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-data-device-manager.dnd-action)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-data-device.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-data-source.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-data-offer.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shm.format)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-shm.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-keyword ((enum (eql xyz.shunter.wayflan.client:wl-display.error)) value)
Source

wayland-protocol.lisp.

Generic Function: wl-enum-value (enum value)

Convert a KEYWORD (or, in the case of a bitfield enum, a list of keywords) into an integer according to ENUM.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-popup.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.wm-capabilities)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.state)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.resize-edge)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-toplevel.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-surface.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.constraint-adjustment)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.gravity)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.anchor)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-positioner.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.xdg-shell:xdg-wm-base.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.viewporter:wp-viewport.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.viewporter:wp-viewporter.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.presentation-time:wp-presentation-feedback.kind)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client.presentation-time:wp-presentation.error)) value)
Source

stable-protocols.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-subsurface.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-subcompositor.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-output.mode)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-output.transform)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-output.subpixel)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-keyboard.key-state)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-keyboard.keymap-format)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-pointer.axis-source)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-pointer.axis)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-pointer.button-state)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-pointer.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-seat.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-seat.capability)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-surface.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.fullscreen-method)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.transient)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shell-surface.resize)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shell.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-data-device-manager.dnd-action)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-data-device.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-data-source.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-data-offer.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shm.format)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-shm.error)) value)
Source

wayland-protocol.lisp.

Method: wl-enum-value ((enum (eql xyz.shunter.wayflan.client:wl-display.error)) value)
Source

wayland-protocol.lisp.

Generic Reader: wl-enums (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-enums ((wl-interface wl-interface))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%enums.

Generic Reader: wl-events (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-events ((wl-interface wl-interface))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%events.

Generic Function: wl-interface-name (interface)

Return the interface’s name discoverable by FIND-INTERFACE-NAMED

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Reader Method: wl-interface-name ((wl-interface-class wl-interface-class))

automatically generated reader method

Target Slot

%interface-name.

Method: wl-interface-name ((interface symbol))
Generic Function: wl-interface-version (interface)

Return the interface’s latest supported version

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Reader Method: wl-interface-version ((wl-interface-class wl-interface-class))

automatically generated reader method

Target Slot

%version.

Method: wl-interface-version ((interface symbol))
Generic Reader: wl-interfaces (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-interfaces ((wl-protocol wl-protocol))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%interfaces.

Generic Reader: wl-name (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-name ((%wl-named-object %wl-named-object))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%name.

Generic Reader: wl-proxy-display (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: wl-proxy-display ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%display.

Generic Reader: wl-proxy-hooks (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: wl-proxy-hooks ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%hooks.

Generic Writer: (setf wl-proxy-hooks) (object)
Package

xyz.shunter.wayflan.client.

Methods
Writer Method: (setf wl-proxy-hooks) ((wl-proxy wl-proxy))

automatically generated writer method

Source

client.lisp.

Target Slot

%hooks.

Generic Reader: wl-proxy-id (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: wl-proxy-id ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%object-id.

Generic Reader: wl-proxy-version (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: wl-proxy-version ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%version.

Generic Reader: wl-requests (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-requests ((wl-interface wl-interface))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%requests.

Generic Reader: wl-since (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-since ((wl-entry wl-entry))

The version of the parent interface since the entry was introduced

Source

protocol.lisp.

Target Slot

%since.

Reader Method: wl-since ((wl-enum wl-enum))

The version of the parent interface since the enum was introduced

Source

protocol.lisp.

Target Slot

%since.

Reader Method: wl-since ((%wl-message %wl-message))

The version of the parent interface since the message was introduced

Source

protocol.lisp.

Target Slot

%since.

Generic Reader: wl-summary (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-summary ((wl-description wl-description))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%summary.

Reader Method: wl-summary ((wl-arg wl-arg))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%summary.

Reader Method: wl-summary ((wl-entry wl-entry))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%summary.

Generic Reader: wl-text (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-text ((wl-description wl-description))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%text.

Generic Reader: wl-type (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-type ((wl-arg wl-arg))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%type.

Reader Method: wl-type ((%wl-message %wl-message))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%type.

Generic Reader: wl-value (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-value ((wl-entry wl-entry))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%value.

Generic Reader: wl-version (object)
Package

xyz.shunter.wayflan.

Methods
Reader Method: wl-version ((wl-interface wl-interface))

automatically generated reader method

Source

protocol.lisp.

Target Slot

%version.


6.1.6 Standalone methods

Method: component-depends-on ((o prepare-source-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: component-depends-on ((o prepare-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: initialize-instance :after ((interface wl-interface-class) &key &allow-other-keys)
Source

client.lisp.

Method: initialize-instance :after ((display wl-display) &key &allow-other-keys)
Source

client.lisp.

Method: input-files ((o wayflan-scan-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: input-files ((o load-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: input-files ((o compile-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: output-files ((o wayflan-scan-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: perform ((o wayflan-scan-op) (c wayflan-client-impl))
Package

asdf/action.

Source

asdf.lisp.

Method: print-object ((object circular-buffer) stream)
Source

wire.lisp.

Method: print-object ((object wl-display) stream)
Source

client.lisp.

Method: print-object ((object wl-proxy) stream)
Source

client.lisp.

Method: print-object ((object %wl-named-object) stream)
Source

protocol.lisp.

Method: reinitialize-instance :after ((interface wl-interface-class) &key &allow-other-keys)
Source

client.lisp.

Method: validate-superclass ((class wl-interface-class) (superclass standard-class))
Package

sb-mop.

Source

client.lisp.


6.1.7 Conditions

Condition: wl-error

Error signaled during Wayland communication

Package

xyz.shunter.wayflan.

Source

conditions.lisp.

Direct superclasses

error.

Direct subclasses
Condition: wl-message-error

Error signaled due to a malformed Wayland message

Package

xyz.shunter.wayflan.

Source

conditions.lisp.

Direct superclasses

wl-error.

Direct slots
Slot: %summary
Initform

(quote nil)

Initargs

:summary

Condition: wl-server-error
Package

xyz.shunter.wayflan.

Source

conditions.lisp.

Direct superclasses

wl-error.

Direct slots
Slot: %object
Initargs

:object

Slot: %code
Initargs

:code

Slot: %message
Initargs

:message

Condition: wl-socket-error

Error signaled due to an issue in a Wayland connection’s underlying socket

Package

xyz.shunter.wayflan.

Source

conditions.lisp.

Direct superclasses

wl-error.

Direct slots
Slot: %summary
Initargs

:summary

Slot: %errno
Initform

(quote xyz.shunter.wayflan.ffi:*errno*)

Initargs

:errno


6.1.8 Classes

Class: data-socket

A binary binary local socket connected to a Wayland compositor

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Direct superclasses

%socket.

Direct methods
Direct slots
Slot: %fd
Type

(or xyz.shunter.wayflan.wire::c-sized-int null)

Initargs

:fd

Slot: %input-iobuf
Type

(or xyz.shunter.wayflan.wire::circular-buffer null)

Initform

(xyz.shunter.wayflan.wire::make-circular-buffer)

Slot: %output-iobuf
Type

(or xyz.shunter.wayflan.wire::circular-buffer null)

Initform

(xyz.shunter.wayflan.wire::make-circular-buffer)

Slot: %input-fdbuf
Type

(or xyz.shunter.wayflan.wire::circular-buffer null)

Initform

(xyz.shunter.wayflan.wire::make-circular-buffer)

Slot: %output-fdbuf
Type

(or xyz.shunter.wayflan.wire::circular-buffer null)

Initform

(xyz.shunter.wayflan.wire::make-circular-buffer)

Class: wl-arg
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct methods
Direct slots
Slot: %type
Type

(cons keyword t)

Initargs

:type

Readers

wl-type.

Writers

This slot is read-only.

Slot: %summary
Type

(or string null)

Initargs

:summary

Readers

wl-summary.

Writers

This slot is read-only.

Class: wl-buffer

content for a wl_surface

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

If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied in the color channels unless otherwise specified.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-callback

callback object

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

%read-event.

Class: wl-compositor

the compositor singleton

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Class: wl-data-device

data transfer device

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-data-device-manager

data transfer interface

The wl_data_device_manager is a singleton global object that provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop. These mechanisms are tied to a wl_seat and this interface lets a client get a wl_data_device corresponding to a wl_seat.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Class: wl-data-offer

offer to transfer data

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-data-source

offer to transfer data

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-description
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct methods
Direct slots
Slot: %summary
Type

(or string null)

Initargs

:summary

Readers

wl-summary.

Writers

This slot is read-only.

Slot: %text
Initargs

:text

Readers

wl-text.

Writers

This slot is read-only.

Class: wl-destroyed-proxy

A proxy that has since been deleted by the compositor.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Direct superclasses

wl-proxy.

Direct methods

wl-display-disconnect.

Class: wl-display

A connection to the compositor that acts as a proxy to the wl_display singleton object

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Direct superclasses

wl-proxy.

Direct methods
Direct slots
Slot: %pathname
Type

pathname

Initargs

:pathname

Readers

wl-display-pathname.

Writers

This slot is read-only.

Slot: %proxy-table
Type

hash-table

Initform

(make-hash-table)

Readers

%proxy-table.

Writers

This slot is read-only.

Slot: %socket
Type

xyz.shunter.wayflan.wire:data-socket

Initargs

:socket

Readers

%wl-display-socket.

Writers

This slot is read-only.

Class: wl-entry
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct methods
Direct slots
Slot: %value
Type

xyz.shunter.wayflan:wl-uint

Initargs

:value

Readers

wl-value.

Writers

This slot is read-only.

Slot: %summary
Type

(or string null)

Initargs

:summary

Readers

wl-summary.

Writers

This slot is read-only.

Slot: %since

The version of the parent interface since the entry was introduced

Type

xyz.shunter.wayflan:wl-uint

Initform

1

Initargs

:since

Readers

wl-since.

Writers

This slot is read-only.

Slot: %description
Type

(or xyz.shunter.wayflan:wl-description null)

Initargs

:description

Readers

wl-description.

Writers

This slot is read-only.

Class: wl-enum
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct methods
Direct slots
Slot: %since

The version of the parent interface since the enum was introduced

Type

xyz.shunter.wayflan:wl-uint

Initform

1

Initargs

:since

Readers

wl-since.

Writers

This slot is read-only.

Slot: %bitfield
Type

boolean

Initargs

:bitfield

Readers

wl-bitfield.

Writers

This slot is read-only.

Slot: %description
Type

(or xyz.shunter.wayflan:wl-description null)

Initargs

:description

Readers

wl-description.

Writers

This slot is read-only.

Slot: %entries
Initargs

:entries

Readers

wl-entries.

Writers

This slot is read-only.

Class: wl-event

Represents a message from the compositor to a client

Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-message.

Class: wl-interface

Interfaces consist of requests that a client can invoke as a method, and requests that a server can emit. All Wayland objects implement one interface.
Interfaces are message-based. Requests are actuated as server-bound messages, while events are client-bound. Both requests and events have opcodes set by the order each was defined, and identify which request or event to act on.

Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct methods
Direct slots
Slot: %version
Type

xyz.shunter.wayflan:wl-uint

Initform

1

Initargs

:version

Readers

wl-version.

Writers

This slot is read-only.

Slot: %description
Type

(or xyz.shunter.wayflan:wl-description null)

Initargs

:description

Readers

wl-description.

Writers

This slot is read-only.

Slot: %requests
Initargs

:requests

Readers

wl-requests.

Writers

This slot is read-only.

Slot: %events
Initargs

:events

Readers

wl-events.

Writers

This slot is read-only.

Slot: %enums
Initargs

:enums

Readers

wl-enums.

Writers

This slot is read-only.

Class: wl-interface-class
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: %version
Type

xyz.shunter.wayflan:wl-uint

Initargs

:version

Readers

wl-interface-version.

Writers

This slot is read-only.

Slot: %interface-name
Type

string

Initargs

:interface-name

Readers

wl-interface-name.

Writers

This slot is read-only.

Class: wl-keyboard

keyboard input device

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-output

compositor output region

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-pointer

pointer input device

The wl_pointer interface represents one or more input devices,
such as mice, which control the pointer location and pointer_focus of a seat.

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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-protocol

A protocol (as opposed to *the* Wayland protocol) is a collection of interfaces and their requests and events all meant to accomplish some shared aim. Protocols are typically defined in XML documents and are defined by libwayland’s wayland-scanner program.

Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct methods
Direct slots
Slot: %copyright
Type

(or string null)

Initargs

:copyright

Readers

wl-copyright.

Writers

This slot is read-only.

Slot: %description
Type

(or xyz.shunter.wayflan:wl-description null)

Initargs

:description

Readers

wl-description.

Writers

This slot is read-only.

Slot: %interfaces
Initargs

:interfaces

Readers

wl-interfaces.

Writers

This slot is read-only.

Class: wl-proxy

A protocol object on the client side

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: %object-id
Type

xyz.shunter.wayflan:wl-uint

Readers
Writers

(setf %wl-proxy-id).

Slot: %display
Type

xyz.shunter.wayflan.client:wl-display

Initargs

:display

Readers
Writers

(setf %wl-proxy-display).

Slot: %version
Type

xyz.shunter.wayflan:wl-uint

Initargs

:version

Readers

wl-proxy-version.

Writers

This slot is read-only.

Slot: %deletedp
Type

boolean

Readers

deletedp.

Writers

This slot is read-only.

Slot: %hooks
Readers

wl-proxy-hooks.

Writers

(setf wl-proxy-hooks).

Class: wl-region

region interface

A region object describes an area.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: wl-registry

global registry object

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-request

Represents a message from a client to the compositor

Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-message.

Class: wl-seat

group of input devices

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-shell

create desktop-style surfaces

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Class: wl-shell-surface

desktop-style metadata interface

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-shm

shared memory support

A singleton global object that provides support for shared memory.

Clients can create wl_shm_pool objects using the create_pool request.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

%read-event.

Class: wl-shm-pool

a shared memory pool

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: wl-subcompositor

sub-surface compositing

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: wl-subsurface

sub-surface interface to a wl_surface

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

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

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

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

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

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

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.

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: wl-surface

an onscreen surface

A surface is a rectangular area that may be displayed on zero
or more outputs, and shown any number of times at the compositor’s discretion. They can present wl_buffers, receive user input, and define a local coordinate system.

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

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

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

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

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wl-touch

touchscreen input device

The wl_touch interface represents a touchscreen
associated with a seat.

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

Package

xyz.shunter.wayflan.client.

Source

wayland-protocol.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wp-presentation

timed presentation related wl_surface requests

Introduction

The main feature of this interface is accurate presentation timing feedback to ensure smooth video playback while maintaining audio/video synchronization. Some features use the concept of a presentation clock, which is defined in the presentation.clock_id event.

A content update for a wl_surface is submitted by a wl_surface.commit request. Request ’feedback’ associates with the wl_surface.commit and provides feedback on the content update, particularly the final realized presentation time.

Completing presentation

When the final realized presentation time is available, e.g. after a framebuffer flip completes, the requested presentation_feedback.presented events are sent. The final presentation time can differ from the compositor’s predicted display update time and the update’s target time, especially when the compositor misses its target vertical blanking period.

Package

xyz.shunter.wayflan.client.presentation-time.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wp-presentation-feedback

presentation time feedback event

A presentation_feedback object returns an indication that a wl_surface content update has become visible to the user. One object corresponds to one content update submission (wl_surface.commit). There are two possible outcomes: the content update is presented to the user, and a presentation timestamp delivered; or, the user did not see the content update because it was superseded or its surface destroyed, and the content update is discarded.

Once a presentation_feedback object has delivered a ’presented’ or ’discarded’ event it is automatically destroyed.

Package

xyz.shunter.wayflan.client.presentation-time.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: wp-viewport

crop and scale interface to a wl_surface

An additional interface to a wl_surface object, which allows the
client to specify the cropping and scaling of the surface contents.

This interface works with two concepts: the source rectangle (src_x, src_y, src_width, src_height), and the destination size (dst_width, dst_height). The contents of the source rectangle are scaled to the destination size, and content outside the source rectangle is ignored. This state is double-buffered, and is applied on the next wl_surface.commit.

The two parts of crop and scale state are independent: the source rectangle, and the destination size. Initially both are unset, that is, no scaling is applied. The whole of the current wl_buffer is used as the source, and the surface size is as defined in wl_surface.attach.

If the destination size is set, it causes the surface size to become dst_width, dst_height. The source (rectangle) is scaled to exactly this size. This overrides whatever the attached wl_buffer size is, unless the wl_buffer is NULL. If the wl_buffer is NULL, the surface has no content and therefore no size. Otherwise, the size is always at least 1x1 in surface local coordinates.

If the source rectangle is set, it defines what area of the wl_buffer is taken as the source. If the source rectangle is set and the destination size is not set, then src_width and src_height must be integers, and the surface size becomes the source rectangle size. This results in cropping without scaling. If src_width or src_height are not integers and destination size is not set, the bad_size protocol error is raised when the surface state is applied.

The coordinate transformations from buffer pixel coordinates up to the surface-local coordinates happen in the following order:
1. buffer_transform (wl_surface.set_buffer_transform)
2. buffer_scale (wl_surface.set_buffer_scale)
3. crop and scale (wp_viewport.set*)
This means, that the source rectangle coordinates of crop and scale are given in the coordinates after the buffer transform and scale, i.e. in the coordinates that would be the surface-local coordinates if the crop and scale was not applied.

If src_x or src_y are negative, the bad_value protocol error is raised. Otherwise, if the source rectangle is partially or completely outside of the non-NULL wl_buffer, then the out_of_buffer protocol error is raised when the surface state is applied. A NULL wl_buffer does not raise the out_of_buffer error.

If the wl_surface associated with the wp_viewport is destroyed,
all wp_viewport requests except ’destroy’ raise the protocol error no_surface.

If the wp_viewport object is destroyed, the crop and scale
state is removed from the wl_surface. The change will be applied
on the next wl_surface.commit.

Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: wp-viewporter

surface cropping and scaling

The global interface exposing surface cropping and scaling capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow cropping and scaling the surface contents, effectively disconnecting the direct relationship between the buffer and the surface size.

Package

xyz.shunter.wayflan.client.viewporter.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: xdg-popup

short-lived, popup surfaces for menus

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.

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 client must call wl_surface.commit on the corresponding wl_surface for the xdg_popup state to take effect.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: xdg-positioner

child surface positioner

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.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods

destroy-proxy.

Class: xdg-surface

desktop user interface surface base interface

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.

After creating a role-specific object and setting it up, the client must perform an initial commit without any buffer attached. The compositor will reply with an xdg_surface.configure event. The client must acknowledge it and is then allowed to attach a buffer to map the surface.

Mapping an xdg_surface-based role surface is defined as making it possible for the surface to be shown by the compositor. Note that
a mapped surface is not guaranteed to be visible once it is mapped.

For an xdg_surface to be mapped by the compositor, the following conditions must be met:
(1) the client has assigned an 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
(3) the client has committed a buffer to the surface

A newly-unmapped surface is considered to have met condition (1) out of the 3 required conditions for mapping a surface if its role surface has not been destroyed, i.e. the client must perform the initial commit again before attaching a buffer.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: xdg-toplevel

toplevel surface

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.

Unmapping an xdg_toplevel means that the surface cannot be shown
by the compositor until it is explicitly mapped again.
All active operations (e.g., move, resize) are canceled and all attributes (e.g. title, state, stacking, ...) are discarded for
an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to the state it had right after xdg_surface.get_toplevel. The client
can re-map the toplevel by perfoming a commit without any buffer attached, waiting for a configure event and handling it as usual (see xdg_surface description).

Attaching a null buffer to a toplevel unmaps the surface.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods
Class: xdg-wm-base

create desktop-style surfaces

The xdg_wm_base interface is exposed as a global object enabling clients to turn their wl_surfaces into windows in a desktop environment. It defines the basic functionality needed for clients and the compositor to create windows that can be dragged, resized, maximized, etc, as well as creating transient windows such as popup menus.

Package

xyz.shunter.wayflan.client.xdg-shell.

Source

stable-protocols.lisp.

Direct superclasses

wl-proxy.

Direct methods

6.1.9 Types

Type: wl-array (&optional size)
Package

xyz.shunter.wayflan.

Source

types.lisp.

Type: wl-fixed ()
Package

xyz.shunter.wayflan.

Source

types.lisp.

Type: wl-int ()
Package

xyz.shunter.wayflan.

Source

types.lisp.

Type: wl-uint ()
Package

xyz.shunter.wayflan.

Source

types.lisp.


6.2 Internals


6.2.1 Constants

Constant: +buf-size+

Size, in octets, of all circular buffers

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Constant: +cspace+
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Constant: +header-length+
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Constant: +max-fds-out+

Maximum # of file descriptors buffered before each flush

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Constant: +sun-path-length+
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Constant: +wl-word-size+
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.


6.2.2 Special variables

Special Variable: *exclude-defclasses*
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Special Variable: *interface-table*

Maps all Wayland interface names to their proxy class

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Special Variable: *syms-to-export*
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.


6.2.3 Macros

Macro: %check-proxy (proxy interface &optional version)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %event-xcase (xcase event &body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %option-bind ((&rest option-names) options &body body)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %optionally ((sym node name) &body keyword)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Macro: %optionally* ((sym node name) &body keyword)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Macro: %slambda (lambda-list &body body)

Return a single-arity lambda that destructures the argument as a specifier. before evaluating the body.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %specifier-bind (lambda-list specifier &body body)

Bind the given LAMBDA-LIST to SPECIFIER, which is transformed to a list of itself if it’s not already a list.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %wl-message-size (types &rest objects)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Macro: %wl-primitive-size (type object)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Macro: %wltype-case (keyform &body cases)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %wltype-ecase (keyform &body cases)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: %wltype-xcase (casename keyform &body cases)

Evaluate the clause sleected by the matching Wayland type.

A lisp Wayland type (an s-expr form of libwayland’s wl_message) is either a keyword that specifies the primary type, or a list that contains the keyword at the start, followed by a symbol, its secondary type.

Parameterized typenames may be consed as the head of a property list, e.g. a :UINT type may be specialized as (:UINT :ENUM WL-SHM-FORMAT), or an :OBJECT may be (:OBJECT :INTERFACE WL-SURFACE :ALLOW-NULL T).

Type specializers:

:ENUM - specializes a :UINT to be a member of an enum.
:INTERFACE - specializes an :OBJECT or :NEW-ID to be an instance of an interface.
:ALLOW-NULL - specializes an :OBJECT or :STRING to be nullable. Lisp calls may pass in NIL.

A WLTYPE-XCASE key is a list containing the matching keyword, followed by a destructuring lambda-list bound under the case’s body.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: @and (&rest clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Macro: evxlambda (event-xcase &body clauses)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.


6.2.4 Ordinary functions

Function: %arg-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %children (element name)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %clear-proxies (display)

Mark all owned proxies as removed.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %clear-socket-input (socket)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %decode-bitfield-enum (table value zero-value)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %decode-standard-enum (enum table value)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %description-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %destroy-proxy (proxy)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %dispatch-event (sender event)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %documentation (description)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %dot (&rest objects)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %encode-bitfield-enum (enum table values)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %encode-standard-enum (enum table value)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %entry-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %enum-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %event-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %find-proxy! (display id)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %flush-output (socket)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %hyphenize (&rest objects)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %interface-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %keyword (string)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %lispify (object)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %make-proxy (class parent &key object-id version)

Make a new proxy. If OBJECT-ID is provided, it’s assumed it came from the server. Otherwise, it will allocate a new object-id from the client side.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %message-of (node class)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %next-proxy-id (display)

Return the next free proxy ID between 1 and #xFEFFFFFF.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %parse-integer (string)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %pathname-or-input (input)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %prepare-gather-cmsg (cmsg output-fdbuf)

Build the control message and return the real length.

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %protocol-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %read-once (socket nonblocking?)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %request-of (node)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %set-interface-named (interface name)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %set-proxy (display id new-proxy)

Assign a proxy with the given id to the table. Return NEW-PROXY.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %sgetf (indicator specifier)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %text (dom)
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Function: %transform-arg (arg-interface arg)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %transform-enum (interface enum)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %transform-event (interface opcode request)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %transform-interface (interface)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %transform-protocol (protocol)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %transform-request (interface opcode request)
Package

xyz.shunter.wayflan.client.scanner.

Source

scanner.lisp.

Function: %var-accessor-*errno* ()
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: (setf %var-accessor-*errno*) ()
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Function: %wltype= (name type)
Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: %write-wl-array (octet-vector cptr offset)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %write-wl-fixed (n cptr offset)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %write-wl-int (n cptr offset)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %write-wl-string (string cptr offset)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: %write-wl-uint (n cptr offset)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: buf-offset (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: buf-ptr (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: buf-size (buffer)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-clear (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-copy (cb dest-ptr)

Copy the entire contents of the circular buffer into dest-ptr

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Reader: cb-end (instance)
Writer: (setf cb-end) (instance)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Target Slot

end.

Function: cb-end* (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-free-space (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-length (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-prepare-gather-iovec (cb iov)

Given a pointer to at least two iovecs, point them to filled spaces in the circular buffer and return the number of iovecs used.

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-prepare-scatter-iovec (cb iov)

Given a pointer to at least two iovecs, point them to empty spaces in the circular buffer and return the number of iovecs used.

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Reader: cb-ptr (instance)
Writer: (setf cb-ptr) (instance)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Target Slot

ptr.

Function: cb-pull-foreign-octets (cb carray offset size)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-pull-number (cb ctype)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-push-foreign-octets (cb carray n)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-push-number (cb number ctype)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-shiftin (cb nbytes)

Mark that the given nubmer of bytes were written to the buffer.

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cb-shiftout (cb nbytes)

Mark that the given number of bytes were consumed.

Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Reader: cb-start (instance)
Writer: (setf cb-start) (instance)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Target Slot

start.

Function: cb-start* (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: check-size (buffer size)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cmsg-align (length)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cmsg-data (cmsg)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cmsg-firsthdr (msghdr)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cmsg-nxthdr (msghdr cmsghdr)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: cmsg-space (length)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: display-pathname (&optional display-name)

Returns the absolute pathname to a Wayland display given its pathname designator.

DISPLAY-PATHNAME roughly emulates libwayland’s algorithm to search a Wayland socket, and is sensitive to the environment variables $WAYLAND_DISPLAY and $XDG_RUNTIME_DIR.

If DISPLAY-NAME is nil, $WAYLAND_DISPLAY is used instead, and then if it describes a relative pathname, it is merged with $XDG_RUNITME_DIR.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Function: free-circular-buffer (cb)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: incf-buf (buffer delta)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: make-buf (ptr size)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: make-circular-buffer (&key ptr start end)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: padded-size (size)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Function: wayflan-doc-to-forms (c)
Package

xyz.shunter.wayflan.

Source

asdf.lisp.

Function: wayflan-scan-output-file (c)
Package

xyz.shunter.wayflan.

Source

asdf.lisp.


6.2.5 Generic functions

Generic Function: %call-with-message (socket function)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: %call-with-message ((socket data-socket) function)
Generic Reader: %proxy-table (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: %proxy-table ((wl-display wl-display))

automatically generated reader method

Source

client.lisp.

Target Slot

%proxy-table.

Generic Function: %read-event (sender opcode buffer)

Read an event sent from PROXY with the given OPCODE and fast-io BUFFER. READ-EVENT methods are defined by DEFINE-EVENT-READER.

Package

xyz.shunter.wayflan.client.

Source

client.lisp.

Methods
Method: %read-event ((proxy3059 xdg-popup) (opcode-sym3060 (eql 2)) buffer3061)

signal the completion of a repositioned request

The repositioned event is sent as part of a popup configuration sequence, together with xdg_popup.configure and lastly xdg_surface.configure to notify the completion of a reposition request.

The repositioned event is to notify about the completion of a xdg_popup.reposition request. The token argument is the token passed in the xdg_popup.reposition request.

Immediately after this event is emitted, xdg_popup.configure and xdg_surface.configure will be sent with the updated size and position, as well as a new configure serial.

The client should optionally update the content of the popup, but must acknowledge the new popup configuration for the new position to take effect. See xdg_surface.ack_configure for details.

Source

stable-protocols.lisp.

Method: %read-event ((proxy3043 xdg-popup) (opcode-sym3044 (eql 1)) buffer3045)

popup interaction is done

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.

Source

stable-protocols.lisp.

Method: %read-event ((proxy3027 xdg-popup) (opcode-sym3028 (eql 0)) buffer3029)

configure the popup surface

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.

For version 2 or older, the configure event for an xdg_popup is only ever sent once for the initial configuration. Starting with version 3, it may be sent again if the popup is setup with an xdg_positioner with set_reactive requested, or in response to xdg_popup.reposition requests.

Source

stable-protocols.lisp.

Method: %read-event ((proxy2751 xdg-toplevel) (opcode-sym2752 (eql 3)) buffer2753)

compositor capabilities

This event advertises the capabilities supported by the compositor. If a capability isn’t supported, clients should hide or disable the UI elements that expose this functionality. For instance, if the compositor doesn’t advertise support for minimized toplevels, a button triggering the set_minimized request should not be displayed.

The compositor will ignore requests it doesn’t support. For instance, a compositor which doesn’t advertise support for minimized will ignore set_minimized requests.

Compositors must send this event once before the first xdg_surface.configure event. When the capabilities change, compositors must send this event again and then send an xdg_surface.configure event.

The configured state should not be applied immediately. See xdg_surface.configure for details.

The capabilities are sent as an array of 32-bit unsigned integers in native endianness.

Source

stable-protocols.lisp.

Method: %read-event ((proxy2735 xdg-toplevel) (opcode-sym2736 (eql 2)) buffer2737)

recommended window geometry bounds

The configure_bounds event may be sent prior to a xdg_toplevel.configure event to communicate the bounds a window geometry size is recommended to constrain to.

The passed width and height are in surface coordinate space. If width and height are 0, it means bounds is unknown and equivalent to as if no configure_bounds event was ever sent for this surface.

The bounds can for example correspond to the size of a monitor excluding any panels or other shell components, so that a surface isn’t created in a way that it cannot fit.

The bounds may change at any point, and in such a case, a new xdg_toplevel.configure_bounds will be sent, followed by xdg_toplevel.configure and xdg_surface.configure.

Source

stable-protocols.lisp.

Method: %read-event ((proxy2719 xdg-toplevel) (opcode-sym2720 (eql 1)) buffer2721)

surface wants to be closed

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

stable-protocols.lisp.

Method: %read-event ((proxy2703 xdg-toplevel) (opcode-sym2704 (eql 0)) buffer2705)

suggest a surface change

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.

Source

stable-protocols.lisp.

Method: %read-event ((proxy1546 xdg-surface) (opcode-sym1547 (eql 0)) buffer1548)

suggest a surface change

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.

Source

stable-protocols.lisp.

Method: %read-event ((proxy301 xdg-wm-base) (opcode-sym302 (eql 0)) buffer303)

check if the client is alive

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

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_wm_base object it created.

Source

stable-protocols.lisp.

Method: %read-event ((proxy268 wp-presentation-feedback) (opcode-sym269 (eql 2)) buffer270)

the content update was not displayed

The content update was never displayed to the user.

Source

stable-protocols.lisp.

Method: %read-event ((proxy252 wp-presentation-feedback) (opcode-sym253 (eql 1)) buffer254)

the content update was displayed

The associated content update was displayed to the user at the indicated time (tv_sec_hi/lo, tv_nsec). For the interpretation of the timestamp, see presentation.clock_id event.

The timestamp corresponds to the time when the content update turned into light the first time on the surface’s main output. Compositors may approximate this from the framebuffer flip completion events from the system, and the latency of the physical display path if known.

This event is preceded by all related sync_output events telling which output’s refresh cycle the feedback corresponds to, i.e. the main output for the surface. Compositors are recommended to choose the output containing the largest part of the wl_surface, or keeping the output they previously chose. Having a stable presentation output association helps clients predict future output refreshes (vblank).

The ’refresh’ argument gives the compositor’s prediction of how many nanoseconds after tv_sec, tv_nsec the very next output refresh may occur. This is to further aid clients in predicting future refreshes, i.e., estimating the timestamps targeting the next few vblanks. If such prediction cannot usefully be done, the argument is zero.

If the output does not have a constant refresh rate, explicit video mode switches excluded, then the refresh argument must be zero.

The 64-bit value combined from seq_hi and seq_lo is the value of the output’s vertical retrace counter when the content update was first scanned out to the display. This value must be compatible with the definition of MSC in GLX_OML_sync_control specification. Note, that if the display path has a non-zero latency, the time instant specified by this counter may differ from the timestamp’s.

If the output does not have a concept of vertical retrace or a refresh cycle, or the output device is self-refreshing without a way to query the refresh count, then the arguments seq_hi and seq_lo must be zero.

Source

stable-protocols.lisp.

Method: %read-event ((proxy218 wp-presentation-feedback) (opcode-sym219 (eql 0)) buffer220)

presentation synchronized to this output

As presentation can be synchronized to only one output at a
time, this event tells which output it was. This event is only sent prior to the presented event.

As clients may bind to the same global wl_output multiple times, this event is sent for each bound instance that matches the synchronized output. If a client has not bound to the right wl_output global at all, this event is not sent.

Source

stable-protocols.lisp.

Method: %read-event ((proxy174 wp-presentation) (opcode-sym175 (eql 0)) buffer176)

clock ID for timestamps

This event tells the client in which clock domain the
compositor interprets the timestamps used by the presentation extension. This clock is called the presentation clock.

The compositor sends this event when the client binds to the presentation interface. The presentation clock does not change during the lifetime of the client connection.

The clock identifier is platform dependent. On Linux/glibc, the identifier value is one of the clockid_t values accepted by clock_gettime(). clock_gettime() is defined by POSIX.1-2001.

Timestamps in this clock domain are expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, each component being an unsigned 32-bit value. Whole seconds are in tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, and the additional fractional part in tv_nsec as nanoseconds. Hence, for valid timestamps tv_nsec must be in [0, 999999999].

Note that clock_id applies only to the presentation clock, and implies nothing about e.g. the timestamps used in the Wayland core protocol input events.

Compositors should prefer a clock which does not jump and is not slewed e.g. by NTP. The absolute value of the clock is irrelevant. Precision of one millisecond or better is recommended. Clients must be able to query the current clock value directly, not by asking the compositor.

Source

stable-protocols.lisp.

Method: %read-event ((proxy6043 wl-output) (opcode-sym6044 (eql 5)) buffer6045)

human-readable description of this output

Many compositors can produce human-readable descriptions of their outputs. The client may wish to know this description as well, e.g. for output selection purposes.

The description is a UTF-8 string with no convention defined for its contents. The description is not guaranteed to be unique among all wl_output globals. Examples might include ’Foocorp 11" Display’ or ’Virtual X11 output via :1’.

The description event is sent after binding the output object and whenever the description changes. The description is optional, and may not be sent at all.

The description event will be followed by a done event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy6027 wl-output) (opcode-sym6028 (eql 4)) buffer6029)

name of this output

Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc. The client may wish to know this name as well to offer the user similar behaviors.

The name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_output globals. The name is only guaranteed to be unique for the compositor instance.

The same output name is used for all clients for a given wl_output global. Thus, the name can be shared across processes to refer to a specific wl_output global.

The name is not guaranteed to be persistent across sessions, thus cannot be used to reliably identify an output in e.g. configuration files.

Examples of names include ’HDMI-A-1’, ’WL-1’, ’X11-1’, etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc.

The name event is sent after binding the output object. This event is only sent once per output object, and the name does not change over the lifetime of the wl_output global.

Compositors may re-use the same output name if the wl_output global is destroyed and re-created later. Compositors should avoid re-using the same name if possible.

The name event will be followed by a done event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy6011 wl-output) (opcode-sym6012 (eql 3)) buffer6013)

output scaling properties

This event contains scaling geometry information
that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. 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.

The scale event will be followed by a done event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5995 wl-output) (opcode-sym5996 (eql 2)) buffer5997)

sent all information about output

This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5979 wl-output) (opcode-sym5980 (eql 1)) buffer5981)

advertise available modes for the output

The mode event describes an available mode for the output.

The event is sent when binding to the output object and there will always be one mode, the current mode. The event is sent again if an output changes mode, for the mode that is now current. In other words, the current mode is always the last mode that was received with the current flag set.

Non-current modes are deprecated. A compositor can decide to only advertise the current mode and never send other modes. Clients should not rely on non-current modes.

The size of a mode is given in physical hardware units of
the output device. This is not necessarily the same as
the output size in the global compositor space. For instance,
the output may be scaled, as described in wl_output.scale,
or transformed, as described in wl_output.transform. Clients willing to retrieve the output size in the global compositor space should use xdg_output.logical_size instead.

The vertical refresh rate can be set to zero if it doesn’t make sense for this output (e.g. for virtual outputs).

The mode event will be followed by a done event (starting from version 2).

Clients should not use the refresh rate to schedule frames. Instead, they should use the wl_surface.frame event or the presentation-time protocol.

Note: this information is not always meaningful for all outputs. Some compositors, such as those exposing virtual outputs, might fake the refresh rate or the size.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5963 wl-output) (opcode-sym5964 (eql 0)) buffer5965)

properties of the output

The geometry event describes geometric properties of the output.
The event is sent when binding to the output object and whenever
any of the properties change.

The physical size can be set to zero if it doesn’t make sense for this output (e.g. for projectors or virtual outputs).

The geometry event will be followed by a done event (starting from version 2).

Note: wl_output only advertises partial information about the output position and identification. Some compositors, for instance those not implementing a desktop-style output layout or those exposing virtual outputs, might fake this information. Instead of using x and y, clients should use xdg_output.logical_position. Instead of using make and model, clients should use name and description.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5785 wl-touch) (opcode-sym5786 (eql 6)) buffer5787)

update orientation of touch point

Sent when a touchpoint has changed its orientation.

This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for
any previously reported, or new touch points of that frame.

Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.shape may be sent within the
same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed.
A wl_touch.down event is guaranteed to occur before the first wl_touch.orientation event for this touch ID but both events may occur within the same wl_touch.frame.

The orientation describes the clockwise angle of a touchpoint’s major axis to the positive surface y-axis and is normalized to the -180 to +180 degree range. The granularity of orientation depends on the touch device, some devices only support binary rotation values between 0 and 90 degrees.

This event is only sent by the compositor if the touch device supports orientation reports.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5769 wl-touch) (opcode-sym5770 (eql 5)) buffer5771)

update shape of touch point

Sent when a touchpoint has changed its shape.

This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for
any previously reported, or new touch points of that frame.

Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.orientation may be sent within the
same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed.
A wl_touch.down event is guaranteed to occur before the first wl_touch.shape event for this touch ID but both events may occur within the same wl_touch.frame.

A touchpoint shape is approximated by an ellipse through the major and minor axis length. The major axis length describes the longer diameter of the ellipse, while the minor axis length describes the shorter diameter. Major and minor are orthogonal and both are specified in surface-local coordinates. The center of the ellipse is always at the touchpoint location as reported by wl_touch.down or wl_touch.move.

This event is only sent by the compositor if the touch device supports shape reports. The client has to make reasonable assumptions about the shape if it did not receive this event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5753 wl-touch) (opcode-sym5754 (eql 4)) buffer5755)

touch session cancelled

Sent if the compositor decides the touch stream is a global gesture. No further events are sent to the clients from that particular gesture. Touch cancellation applies to all touch points currently active on this client’s surface. The client is responsible for finalizing the touch points, future touch points on this surface may reuse the touch point ID.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5737 wl-touch) (opcode-sym5738 (eql 3)) buffer5739)

end of touch frame event

Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding.

A wl_touch.frame terminates at least one event but otherwise no guarantee is provided about the set of events within a frame. A client must assume that any state not updated in a frame is unchanged from the previously known state.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5721 wl-touch) (opcode-sym5722 (eql 2)) buffer5723)

update of touch point coordinates

A touch point has changed coordinates.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5705 wl-touch) (opcode-sym5706 (eql 1)) buffer5707)

end of a touch event sequence

The touch point has disappeared. No further events will be sent for this touch point and the touch point’s ID is released and may be reused in a future touch down event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5671 wl-touch) (opcode-sym5672 (eql 0)) buffer5673)

touch down event and beginning of a touch sequence

A new touch point has appeared on the surface. This touch point is assigned a unique ID. Future events from this touch point reference this ID. The ID ceases to be valid after a touch up event and may be reused in the future.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5573 wl-keyboard) (opcode-sym5574 (eql 5)) buffer5575)

repeat rate and delay

Informs the client about the keyboard’s repeat rate and delay.

This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event.

Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay).

This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wl_keyboard.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5557 wl-keyboard) (opcode-sym5558 (eql 4)) buffer5559)

modifier and group state

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5541 wl-keyboard) (opcode-sym5542 (eql 3)) buffer5543)

key event

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

The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event).

If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5507 wl-keyboard) (opcode-sym5508 (eql 2)) buffer5509)

leave event

Notification that this seat’s keyboard focus is no longer on
a certain surface.

The leave notification is sent before the enter notification
for the new focus.

After this event client must assume that all keys, including modifiers, are lifted and also it must stop key repeating if there’s some going on.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5473 wl-keyboard) (opcode-sym5474 (eql 1)) buffer5475)

enter event

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

The compositor must send the wl_keyboard.modifiers event after this event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5457 wl-keyboard) (opcode-sym5458 (eql 0)) buffer5459)

keyboard mapping

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

From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the recipient, as MAP_SHARED may fail.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5319 wl-pointer) (opcode-sym5320 (eql 9)) buffer5321)

axis high-resolution scroll event

Discrete high-resolution scroll information.

This event carries high-resolution wheel scroll information,
with each multiple of 120 representing one logical scroll step
(a wheel detent). For example, an axis_value120 of 30 is one quarter of a logical scroll step in the positive direction, a value120 of
-240 are two logical scroll steps in the negative direction within the same hardware event.
Clients that rely on discrete scrolling should accumulate the value120 to multiples of 120 before processing the event.

The value120 must not be zero.

This event replaces the wl_pointer.axis_discrete event in clients supporting wl_pointer version 8 or later.

Where a wl_pointer.axis_source event occurs in the same wl_pointer.frame, the axis source applies to this event.

The order of wl_pointer.axis_value120 and wl_pointer.axis_source is not guaranteed.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5283 wl-pointer) (opcode-sym5284 (eql 8)) buffer5285)

axis click event

Discrete step information for scroll and other axes.

This event carries the axis value of the wl_pointer.axis event in discrete steps (e.g. mouse wheel clicks).

This event is deprecated with wl_pointer version 8 - this event is not sent to clients supporting version 8 or later.

This event does not occur on its own, it is coupled with a wl_pointer.axis event that represents this axis value on a continuous scale. The protocol guarantees that each axis_discrete event is always followed by exactly one axis event with the same axis number within the same wl_pointer.frame. Note that the protocol allows for other events to occur between the axis_discrete and
its coupled axis event, including other axis_discrete or axis events. A wl_pointer.frame must not contain more than one axis_discrete event per axis type.

This event is optional; continuous scrolling devices
like two-finger scrolling on touchpads do not have discrete
steps and do not generate this event.

The discrete value carries the directional information. e.g. a value of -2 is two steps towards the negative direction of this axis.

The axis number is identical to the axis number in the associated axis event.

The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5267 wl-pointer) (opcode-sym5268 (eql 7)) buffer5269)

axis stop event

Stop notification for scroll and other axes.

For some wl_pointer.axis_source types, a wl_pointer.axis_stop event is sent to notify a client that the axis sequence has terminated. This enables the client to implement kinetic scrolling.
See the wl_pointer.axis_source documentation for information on when this event may be generated.

Any wl_pointer.axis events with the same axis_source after this event should be considered as the start of a new axis motion.

The timestamp is to be interpreted identical to the timestamp in the wl_pointer.axis event. The timestamp value may be the same as a preceding wl_pointer.axis event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5251 wl-pointer) (opcode-sym5252 (eql 6)) buffer5253)

axis source event

Source information for scroll and other axes.

This event does not occur on its own. It is sent before a wl_pointer.frame event and carries the source information for all events within that frame.

The source specifies how this event was generated. If the source is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be sent when the user lifts the finger off the device.

If the source is wl_pointer.axis_source.wheel, wl_pointer.axis_source.wheel_tilt or wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may or may not be sent. Whether a compositor sends an axis_stop event for these sources is hardware-specific and implementation-dependent; clients must not rely on receiving an axis_stop event for these scroll sources and should treat scroll sequences from these scroll sources as unterminated by default.

This event is optional. If the source is unknown for a particular axis event sequence, no event is sent.
Only one wl_pointer.axis_source event is permitted per frame.

The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5235 wl-pointer) (opcode-sym5236 (eql 5)) buffer5237)

end of a pointer event sequence

Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding.

All wl_pointer events before a wl_pointer.frame event belong logically together. For example, in a diagonal scroll motion the compositor will send an optional wl_pointer.axis_source event, two wl_pointer.axis events (horizontal and vertical) and finally a wl_pointer.frame event. The client may use this information to calculate a diagonal vector for scrolling.

When multiple wl_pointer.axis events occur within the same frame, the motion vector is the combined motion of all events.
When a wl_pointer.axis and a wl_pointer.axis_stop event occur within the same frame, this indicates that axis movement in one axis has stopped but continues in the other axis.
When multiple wl_pointer.axis_stop events occur within the same frame, this indicates that these axes stopped in the same instance.

A wl_pointer.frame event is sent for every logical event group, even if the group only contains a single wl_pointer event. Specifically, a client may get a sequence: motion, frame, button, frame, axis, frame, axis_stop, frame.

The wl_pointer.enter and wl_pointer.leave events are logical events generated by the compositor and not the hardware. These events are also grouped by a wl_pointer.frame. When a pointer moves from one surface to another, a compositor should group the wl_pointer.leave event within the same wl_pointer.frame. However, a client must not rely on wl_pointer.leave and wl_pointer.enter being in the same wl_pointer.frame. Compositor-specific policies may require the wl_pointer.leave and wl_pointer.enter event being split across multiple wl_pointer.frame groups.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5219 wl-pointer) (opcode-sym5220 (eql 4)) buffer5221)

axis event

Scroll and other axis notifications.

For scroll events (vertical and horizontal scroll axes), the value parameter is the length of a vector along the specified axis in a coordinate space identical to those of motion events, representing a relative movement along the specified axis.

For devices that support movements non-parallel to axes multiple axis events will be emitted.

When applicable, for example for touch pads, the server can choose to emit scroll events where the motion vector is equivalent to a motion event vector.

When applicable, a client can transform its content relative to the scroll distance.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5203 wl-pointer) (opcode-sym5204 (eql 3)) buffer5205)

pointer button event

Mouse button click and release notifications.

The location of the click is given by the last motion or
enter event.
The time argument is a timestamp with millisecond
granularity, with an undefined base.

The button is a button code as defined in the Linux kernel’s linux/input-event-codes.h header file, e.g. BTN_LEFT.

Any 16-bit button code value is reserved for future additions to the kernel’s event code list. All other button codes above 0xFFFF are currently undefined but may be used in future versions of this protocol.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5187 wl-pointer) (opcode-sym5188 (eql 2)) buffer5189)

pointer motion event

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5153 wl-pointer) (opcode-sym5154 (eql 1)) buffer5155)

leave event

Notification that this seat’s pointer is no longer focused on a certain surface.

The leave notification is sent before the enter notification for the new focus.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy5119 wl-pointer) (opcode-sym5120 (eql 0)) buffer5121)

enter event

Notification that this seat’s pointer is focused on a certain surface.

When a seat’s focus enters a surface, the pointer image
is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy4822 wl-seat) (opcode-sym4823 (eql 1)) buffer4824)

unique identifier for this seat

In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents.

The seat name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_seat globals. The name is only guaranteed to be unique for the current compositor instance.

The same seat names are used for all clients. Thus, the name can be shared across processes to refer to a specific wl_seat global.

The name event is sent after binding to the seat global. This event is only sent once per seat object, and the name does not change over the lifetime of the wl_seat global.

Compositors may re-use the same seat name if the wl_seat global is destroyed and re-created later.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy4806 wl-seat) (opcode-sym4807 (eql 0)) buffer4808)

seat capabilities changed

This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities. The argument is a capability enum containing the complete set of capabilities this seat has.

When the pointer capability is added, a client may create a wl_pointer object using the wl_seat.get_pointer request. This object will receive pointer events until the capability is removed in the future.

When the pointer capability is removed, a client should destroy the wl_pointer objects associated with the seat where the capability was removed, using the wl_pointer.release request. No further pointer events will be received on these objects.

In some compositors, if a seat regains the pointer capability and a client has a previously obtained wl_pointer object of version 4 or less, that object may start sending pointer events again. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client. wl_pointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability.

The above behavior also applies to wl_keyboard and wl_touch with the keyboard and touch capabilities, respectively.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy4459 wl-surface) (opcode-sym4460 (eql 1)) buffer4461)

surface leaves an output

This is emitted whenever a surface’s creation, movement, or resizing results in it no longer having any part of it within the scanout region of an output.

Clients should not use the number of outputs the surface is on for frame throttling purposes. The surface might be hidden even if no leave event has been sent, and the compositor might expect new surface content updates even if no enter event has been sent. The frame event should be used instead.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy4425 wl-surface) (opcode-sym4426 (eql 0)) buffer4427)

surface enters an output

This is emitted whenever a surface’s creation, movement, or resizing results in some part of it being within the scanout region of an output.

Note that a surface may be overlapping with zero or more outputs.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy3562 wl-shell-surface) (opcode-sym3563 (eql 2)) buffer3564)

popup interaction is done

The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn’t belong to the client owning the popup surface.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy3546 wl-shell-surface) (opcode-sym3547 (eql 1)) buffer3548)

suggest resize

The configure event asks the client to resize its surface.

The size is a hint, in the sense that the client is free to ignore it if it doesn’t resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels).

The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved).

The client is free to dismiss all but the last configure event it received.

The width and height arguments specify the size of the window in surface-local coordinates.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy3530 wl-shell-surface) (opcode-sym3531 (eql 0)) buffer3532)

ping client

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2263 wl-data-device) (opcode-sym2264 (eql 5)) buffer2265)

advertise new selection

The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device. The data_device.data_offer and the data_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The data_offer is valid until a new data_offer or NULL is received or until the client loses keyboard focus. Switching surface with keyboard focus within the same client doesn’t mean a new selection will be sent. The client must destroy the previous selection data_offer, if any, upon receiving this event.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2247 wl-data-device) (opcode-sym2248 (eql 4)) buffer2249)

end drag-and-drop session successfully

The event is sent when a drag-and-drop operation is ended
because the implicit grab is removed.

The drag-and-drop destination is expected to honor the last action received through wl_data_offer.action, if the resulting action is "copy" or "move", the destination can still perform wl_data_offer.receive requests, and is expected to end all transfers with a wl_data_offer.finish request.

If the resulting action is "ask", the action will not be considered final. The drag-and-drop destination is expected to perform one last wl_data_offer.set_actions request, or wl_data_offer.destroy in order to cancel the operation.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2231 wl-data-device) (opcode-sym2232 (eql 3)) buffer2233)

drag-and-drop session motion

This event is sent when the drag-and-drop pointer moves within the currently focused surface. The new position of the pointer is provided by the x and y arguments, in surface-local coordinates.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2215 wl-data-device) (opcode-sym2216 (eql 2)) buffer2217)

end drag-and-drop session

This event is sent when the drag-and-drop pointer leaves the surface and the session ends. The client must destroy the wl_data_offer introduced at enter time at this point.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2163 wl-data-device) (opcode-sym2164 (eql 1)) buffer2165)

initiate drag-and-drop session

This event is sent when an active drag-and-drop pointer enters a surface owned by the client. The position of the pointer at enter time is provided by the x and y arguments, in surface-local coordinates.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy2147 wl-data-device) (opcode-sym2148 (eql 0)) buffer2149)

introduce a new wl_data_offer

The data_offer event introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections). Immediately following the data_device.data_offer event, the new data_offer object will send out data_offer.offer events to describe the mime types it offers.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1835 wl-data-source) (opcode-sym1836 (eql 5)) buffer1837)

notify the selected action

This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here.

This event can be emitted multiple times during the drag-and-drop operation, mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces.

It is only possible to receive this event after wl_data_source.dnd_drop_performed if the drag-and-drop operation ended in an "ask" action, in which case the final wl_data_source.action event will happen immediately before wl_data_source.dnd_finished.

Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation.

The most recent action received is always the valid one. The chosen action may change alongside negotiation (e.g. an "ask" action can turn into a "move" operation), so the effects of the final action must always be applied in wl_data_offer.dnd_finished.

Clients can trigger cursor surface changes from this point, so
they reflect the current action.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1819 wl-data-source) (opcode-sym1820 (eql 4)) buffer1821)

the drag-and-drop operation concluded

The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data.

If the action used to perform the operation was "move", the source can now delete the transferred data.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1803 wl-data-source) (opcode-sym1804 (eql 3)) buffer1805)

the drag-and-drop operation physically finished

The user performed the drop action. This event does not indicate acceptance, wl_data_source.cancelled may still be emitted afterwards if the drop destination does not accept any mime type.

However, this event might however not be received if the compositor cancelled the drag-and-drop operation before this event could happen.

Note that the data_source may still be used in the future and should not be destroyed here.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1787 wl-data-source) (opcode-sym1788 (eql 2)) buffer1789)

selection was cancelled

This data source is no longer valid. There are several reasons why this could happen:

- The data source has been replaced by another data source.
- The drag-and-drop operation was performed, but the drop destination did not accept any of the mime types offered through wl_data_source.target.
- The drag-and-drop operation was performed, but the drop destination did not select any of the actions present in the mask offered through wl_data_source.action.
- The drag-and-drop operation was performed but didn’t happen over a surface.
- The compositor cancelled the drag-and-drop operation (e.g. compositor dependent timeouts to avoid stale drag-and-drop transfers).

The client should clean up and destroy this data source.

For objects of version 2 or older, wl_data_source.cancelled will only be emitted if the data source was replaced by another data source.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1771 wl-data-source) (opcode-sym1772 (eql 1)) buffer1773)

send the data

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1755 wl-data-source) (opcode-sym1756 (eql 0)) buffer1757)

a target accepts an offered mime type

Sent when a target accepts pointer_focus or motion events. If a target does not accept any of the offered types, type is NULL.

Used for feedback during drag-and-drop.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1477 wl-data-offer) (opcode-sym1478 (eql 2)) buffer1479)

notify the selected action

This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here.

This event can be emitted multiple times during the drag-and-drop operation in response to destination side action changes through wl_data_offer.set_actions.

This event will no longer be emitted after wl_data_device.drop happened on the drag-and-drop destination, the client must
honor the last action received, or the last preferred one set through wl_data_offer.set_actions when handling an "ask" action.

Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation.

The most recent action received is always the valid one. Prior to receiving wl_data_device.drop, the chosen action may change (e.g. due to keyboard modifiers being pressed). At the time of receiving wl_data_device.drop the drag-and-drop destination must honor the last action received.

Action changes may still happen after wl_data_device.drop, especially on "ask" actions, where the drag-and-drop destination may choose another action afterwards. Action changes happening
at this stage are always the result of inter-client negotiation, the compositor shall no longer be able to induce a different action.

Upon "ask" actions, it is expected that the drag-and-drop destination may potentially choose a different action and/or mime type,
based on wl_data_offer.source_actions and finally chosen by the user (e.g. popping up a menu with the available options). The final wl_data_offer.set_actions and wl_data_offer.accept requests must happen before the call to wl_data_offer.finish.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1461 wl-data-offer) (opcode-sym1462 (eql 1)) buffer1463)

notify the source-side available actions

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.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy1445 wl-data-offer) (opcode-sym1446 (eql 0)) buffer1447)

advertise offered mime type

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy992 wl-buffer) (opcode-sym993 (eql 0)) buffer994)

compositor releases buffer

Sent when this wl_buffer is no longer used by the compositor. The client is now free to reuse or destroy this buffer and its backing storage.

If a client receives a release event before the frame callback requested in the same wl_surface.commit that attaches this wl_buffer to a surface, then the client is immediately free to reuse the buffer and its backing storage, and does not need a second buffer for the next surface content update. Typically this is possible, when the compositor maintains a copy of the wl_surface contents, e.g. as a GL texture. This is an important optimization for GL(ES) compositors with wl_shm clients.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy906 wl-shm) (opcode-sym907 (eql 0)) buffer908)

pixel format description

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

Source

wayland-protocol.lisp.

Method: %read-event ((proxy368 wl-callback) (opcode-sym369 (eql 0)) buffer370)

done event

Notify the client when the related request is done.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy352 wl-registry) (opcode-sym353 (eql 1)) buffer354)

announce removal of global object

Notify the client of removed global objects.

This event notifies the client that the global identified by name is no longer available. If the client bound to the global using the bind request, the client should now destroy that object.

The object remains valid and requests to the object will be ignored until the client destroys it, to avoid races between the global going away and a client sending a request to it.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy336 wl-registry) (opcode-sym337 (eql 0)) buffer338)

announce global object

Notify the client of global objects.

The event notifies the client that a global object with the given name is now available, and it implements the given version of the given interface.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy181 wl-display) (opcode-sym182 (eql 1)) buffer183)

acknowledge object ID deletion

This event is used internally by the object ID management logic. When a client deletes an object that it had created, 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.

Source

wayland-protocol.lisp.

Method: %read-event ((proxy152 wl-display) (opcode-sym153 (eql 0)) buffer154)

fatal error event

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.

Source

wayland-protocol.lisp.

Generic Reader: %wl-display-socket (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: %wl-display-socket ((wl-display wl-display))

automatically generated reader method

Source

client.lisp.

Target Slot

%socket.

Generic Reader: %wl-proxy-display (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: %wl-proxy-display ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%display.

Generic Writer: (setf %wl-proxy-display) (object)
Package

xyz.shunter.wayflan.client.

Methods
Writer Method: (setf %wl-proxy-display) ((wl-proxy wl-proxy))

automatically generated writer method

Source

client.lisp.

Target Slot

%display.

Generic Reader: %wl-proxy-id (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: %wl-proxy-id ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%object-id.

Generic Writer: (setf %wl-proxy-id) (object)
Package

xyz.shunter.wayflan.client.

Methods
Writer Method: (setf %wl-proxy-id) ((wl-proxy wl-proxy))

automatically generated writer method

Source

client.lisp.

Target Slot

%object-id.

Generic Function: %write-fd (socket fd)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: %write-fd ((socket data-socket) fd)
Generic Function: %write-message (socket carray size)
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Methods
Method: %write-message ((socket data-socket) carray size)
Generic Reader: deletedp (object)
Package

xyz.shunter.wayflan.client.

Methods
Reader Method: deletedp ((wl-proxy wl-proxy))

automatically generated reader method

Source

client.lisp.

Target Slot

%deletedp.


6.2.6 Structures

Structure: circular-buffer
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: ptr
Type

cffi-sys:foreign-pointer

Initform

(cffi:foreign-alloc :uint8 :count xyz.shunter.wayflan.wire::+buf-size+)

Readers

cb-ptr.

Writers

(setf cb-ptr).

Slot: start
Type

fixnum

Initform

0

Readers

cb-start.

Writers

(setf cb-start).

Slot: end
Type

fixnum

Initform

0

Readers

cb-end.

Writers

(setf cb-end).


6.2.7 Classes

Class: %socket
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Direct subclasses

data-socket.

Class: %wl-message
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct superclasses

%wl-named-object.

Direct subclasses
Direct methods
Direct slots
Slot: %type
Type

xyz.shunter.wayflan::%wl-message-type

Initargs

:type

Readers

wl-type.

Writers

This slot is read-only.

Slot: %since

The version of the parent interface since the message was introduced

Type

xyz.shunter.wayflan:wl-uint

Initform

1

Initargs

:since

Readers

wl-since.

Writers

This slot is read-only.

Slot: %description
Type

(or xyz.shunter.wayflan:wl-description null)

Initargs

:description

Readers

wl-description.

Writers

This slot is read-only.

Slot: %args
Initargs

:args

Readers

wl-args.

Writers

This slot is read-only.

Class: %wl-named-object
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: %name
Type

string

Initargs

:name

Readers

wl-name.

Writers

This slot is read-only.

Class: cmsghdr-tclass
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: iovec-tclass
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: msghdr-tclass
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: sockaddr-un-tclass
Package

xyz.shunter.wayflan.ffi.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: wayflan-client-impl
Package

xyz.shunter.wayflan.

Source

asdf.lisp.

Direct superclasses

cl-source-file.

Direct methods
Direct slots
Slot: type
Package

common-lisp.

Initform

"xml"

Slot: in-package
Package

common-lisp.

Initargs

:in-package

Slot: export
Package

common-lisp.

Initargs

:export

Class: wayflan-scan-op
Package

xyz.shunter.wayflan.

Source

asdf.lisp.

Direct superclasses

downward-operation.

Direct methods

6.2.8 Types

Type: %wl-message-type ()
Package

xyz.shunter.wayflan.

Source

protocol.lisp.

Type: c-sized-int ()
Package

xyz.shunter.wayflan.wire.

Source

wire.lisp.

Type: octet ()
Package

xyz.shunter.wayflan.

Source

types.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (   @  
A   B   C   D   E   F   G   I   L   M   O   P   R   S   V   W   X  
Index Entry  Section

%
%arg-of: Private ordinary functions
%call-with-message: Private generic functions
%call-with-message: Private generic functions
%check-proxy: Private macros
%children: Private ordinary functions
%clear-proxies: Private ordinary functions
%clear-socket-input: Private ordinary functions
%decode-bitfield-enum: Private ordinary functions
%decode-standard-enum: Private ordinary functions
%description-of: Private ordinary functions
%destroy-proxy: Private ordinary functions
%dispatch-event: Private ordinary functions
%documentation: Private ordinary functions
%dot: Private ordinary functions
%encode-bitfield-enum: Private ordinary functions
%encode-standard-enum: Private ordinary functions
%entry-of: Private ordinary functions
%enum-of: Private ordinary functions
%event-of: Private ordinary functions
%event-xcase: Private macros
%find-proxy!: Private ordinary functions
%flush-output: Private ordinary functions
%hyphenize: Private ordinary functions
%interface-of: Private ordinary functions
%keyword: Private ordinary functions
%lispify: Private ordinary functions
%make-proxy: Private ordinary functions
%message-of: Private ordinary functions
%next-proxy-id: Private ordinary functions
%option-bind: Private macros
%optionally: Private macros
%optionally*: Private macros
%parse-integer: Private ordinary functions
%pathname-or-input: Private ordinary functions
%prepare-gather-cmsg: Private ordinary functions
%protocol-of: Private ordinary functions
%proxy-table: Private generic functions
%proxy-table: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-event: Private generic functions
%read-once: Private ordinary functions
%request-of: Private ordinary functions
%set-interface-named: Private ordinary functions
%set-proxy: Private ordinary functions
%sgetf: Private ordinary functions
%slambda: Private macros
%specifier-bind: Private macros
%text: Private ordinary functions
%transform-arg: Private ordinary functions
%transform-enum: Private ordinary functions
%transform-event: Private ordinary functions
%transform-interface: Private ordinary functions
%transform-protocol: Private ordinary functions
%transform-request: Private ordinary functions
%var-accessor-*errno*: Private ordinary functions
%wl-display-socket: Private generic functions
%wl-display-socket: Private generic functions
%wl-message-size: Private macros
%wl-primitive-size: Private macros
%wl-proxy-display: Private generic functions
%wl-proxy-display: Private generic functions
%wl-proxy-id: Private generic functions
%wl-proxy-id: Private generic functions
%wltype-case: Private macros
%wltype-ecase: Private macros
%wltype-xcase: Private macros
%wltype=: Private ordinary functions
%write-fd: Private generic functions
%write-fd: Private generic functions
%write-message: Private generic functions
%write-message: Private generic functions
%write-wl-array: Private ordinary functions
%write-wl-fixed: Private ordinary functions
%write-wl-int: Private ordinary functions
%write-wl-string: Private ordinary functions
%write-wl-uint: Private ordinary functions

(
(setf %var-accessor-*errno*): Private ordinary functions
(setf %wl-proxy-display): Private generic functions
(setf %wl-proxy-display): Private generic functions
(setf %wl-proxy-id): Private generic functions
(setf %wl-proxy-id): Private generic functions
(setf cb-end): Private ordinary functions
(setf cb-ptr): Private ordinary functions
(setf cb-start): Private ordinary functions
(setf wl-proxy-hooks): Public generic functions
(setf wl-proxy-hooks): Public generic functions

@
@and: Private macros

A
accept: Public ordinary functions

B
bind: Public ordinary functions
buf-offset: Private ordinary functions
buf-ptr: Private ordinary functions
buf-size: Private ordinary functions
bzero: Public ordinary functions

C
cb-clear: Private ordinary functions
cb-copy: Private ordinary functions
cb-end: Private ordinary functions
cb-end*: Private ordinary functions
cb-free-space: Private ordinary functions
cb-length: Private ordinary functions
cb-prepare-gather-iovec: Private ordinary functions
cb-prepare-scatter-iovec: Private ordinary functions
cb-ptr: Private ordinary functions
cb-pull-foreign-octets: Private ordinary functions
cb-pull-number: Private ordinary functions
cb-push-foreign-octets: Private ordinary functions
cb-push-number: Private ordinary functions
cb-shiftin: Private ordinary functions
cb-shiftout: Private ordinary functions
cb-start: Private ordinary functions
cb-start*: Private ordinary functions
check-size: Private ordinary functions
close-fd: Public ordinary functions
close-socket: Public generic functions
close-socket: Public generic functions
cmsg-align: Private ordinary functions
cmsg-data: Private ordinary functions
cmsg-firsthdr: Private ordinary functions
cmsg-len: Public ordinary functions
cmsg-nxthdr: Private ordinary functions
cmsg-space: Private ordinary functions
component-depends-on: Public standalone methods
component-depends-on: Public standalone methods
connect: Public ordinary functions
connect-fd: Public ordinary functions

D
define-enum: Public macros
define-event: Public macros
define-interface: Public macros
define-request: Public macros
deletedp: Private generic functions
deletedp: Private generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
destroy-proxy: Public generic functions
display-pathname: Private ordinary functions

E
evclambda: Public macros
evelambda: Public macros
event-case: Public macros
event-ccase: Public macros
event-ecase: Public macros
evlambda: Public macros
evxlambda: Private macros

F
find-interface-named: Public ordinary functions
find-proxy: Public ordinary functions
free-circular-buffer: Private ordinary functions
Function, %arg-of: Private ordinary functions
Function, %children: Private ordinary functions
Function, %clear-proxies: Private ordinary functions
Function, %clear-socket-input: Private ordinary functions
Function, %decode-bitfield-enum: Private ordinary functions
Function, %decode-standard-enum: Private ordinary functions
Function, %description-of: Private ordinary functions
Function, %destroy-proxy: Private ordinary functions
Function, %dispatch-event: Private ordinary functions
Function, %documentation: Private ordinary functions
Function, %dot: Private ordinary functions
Function, %encode-bitfield-enum: Private ordinary functions
Function, %encode-standard-enum: Private ordinary functions
Function, %entry-of: Private ordinary functions
Function, %enum-of: Private ordinary functions
Function, %event-of: Private ordinary functions
Function, %find-proxy!: Private ordinary functions
Function, %flush-output: Private ordinary functions
Function, %hyphenize: Private ordinary functions
Function, %interface-of: Private ordinary functions
Function, %keyword: Private ordinary functions
Function, %lispify: Private ordinary functions
Function, %make-proxy: Private ordinary functions
Function, %message-of: Private ordinary functions
Function, %next-proxy-id: Private ordinary functions
Function, %parse-integer: Private ordinary functions
Function, %pathname-or-input: Private ordinary functions
Function, %prepare-gather-cmsg: Private ordinary functions
Function, %protocol-of: Private ordinary functions
Function, %read-once: Private ordinary functions
Function, %request-of: Private ordinary functions
Function, %set-interface-named: Private ordinary functions
Function, %set-proxy: Private ordinary functions
Function, %sgetf: Private ordinary functions
Function, %text: Private ordinary functions
Function, %transform-arg: Private ordinary functions
Function, %transform-enum: Private ordinary functions
Function, %transform-event: Private ordinary functions
Function, %transform-interface: Private ordinary functions
Function, %transform-protocol: Private ordinary functions
Function, %transform-request: Private ordinary functions
Function, %var-accessor-*errno*: Private ordinary functions
Function, %wltype=: Private ordinary functions
Function, %write-wl-array: Private ordinary functions
Function, %write-wl-fixed: Private ordinary functions
Function, %write-wl-int: Private ordinary functions
Function, %write-wl-string: Private ordinary functions
Function, %write-wl-uint: Private ordinary functions
Function, (setf %var-accessor-*errno*): Private ordinary functions
Function, (setf cb-end): Private ordinary functions
Function, (setf cb-ptr): Private ordinary functions
Function, (setf cb-start): Private ordinary functions
Function, accept: Public ordinary functions
Function, bind: Public ordinary functions
Function, buf-offset: Private ordinary functions
Function, buf-ptr: Private ordinary functions
Function, buf-size: Private ordinary functions
Function, bzero: Public ordinary functions
Function, cb-clear: Private ordinary functions
Function, cb-copy: Private ordinary functions
Function, cb-end: Private ordinary functions
Function, cb-end*: Private ordinary functions
Function, cb-free-space: Private ordinary functions
Function, cb-length: Private ordinary functions
Function, cb-prepare-gather-iovec: Private ordinary functions
Function, cb-prepare-scatter-iovec: Private ordinary functions
Function, cb-ptr: Private ordinary functions
Function, cb-pull-foreign-octets: Private ordinary functions
Function, cb-pull-number: Private ordinary functions
Function, cb-push-foreign-octets: Private ordinary functions
Function, cb-push-number: Private ordinary functions
Function, cb-shiftin: Private ordinary functions
Function, cb-shiftout: Private ordinary functions
Function, cb-start: Private ordinary functions
Function, cb-start*: Private ordinary functions
Function, check-size: Private ordinary functions
Function, close-fd: Public ordinary functions
Function, cmsg-align: Private ordinary functions
Function, cmsg-data: Private ordinary functions
Function, cmsg-firsthdr: Private ordinary functions
Function, cmsg-len: Public ordinary functions
Function, cmsg-nxthdr: Private ordinary functions
Function, cmsg-space: Private ordinary functions
Function, connect: Public ordinary functions
Function, connect-fd: Public ordinary functions
Function, display-pathname: Private ordinary functions
Function, find-interface-named: Public ordinary functions
Function, find-proxy: Public ordinary functions
Function, free-circular-buffer: Private ordinary functions
Function, incf-buf: Private ordinary functions
Function, make-buf: Private ordinary functions
Function, make-circular-buffer: Private ordinary functions
Function, make-socket: Public ordinary functions
Function, memcpy: Public ordinary functions
Function, padded-size: Private ordinary functions
Function, read-wl-array: Public ordinary functions
Function, read-wl-fixed: Public ordinary functions
Function, read-wl-int: Public ordinary functions
Function, read-wl-string: Public ordinary functions
Function, read-wl-uint: Public ordinary functions
Function, recvmsg: Public ordinary functions
Function, sendmsg: Public ordinary functions
Function, socket: Public ordinary functions
Function, strerror: Public ordinary functions
Function, wayflan-doc-to-forms: Private ordinary functions
Function, wayflan-scan-output-file: Private ordinary functions
Function, wl-buffer.destroy: Public ordinary functions
Function, wl-compositor.create-region: Public ordinary functions
Function, wl-compositor.create-surface: Public ordinary functions
Function, wl-data-device-manager.create-data-source: Public ordinary functions
Function, wl-data-device-manager.get-data-device: Public ordinary functions
Function, wl-data-device.release: Public ordinary functions
Function, wl-data-device.set-selection: Public ordinary functions
Function, wl-data-device.start-drag: Public ordinary functions
Function, wl-data-offer.accept: Public ordinary functions
Function, wl-data-offer.destroy: Public ordinary functions
Function, wl-data-offer.finish: Public ordinary functions
Function, wl-data-offer.receive: Public ordinary functions
Function, wl-data-offer.set-actions: Public ordinary functions
Function, wl-data-source.destroy: Public ordinary functions
Function, wl-data-source.offer: Public ordinary functions
Function, wl-data-source.set-actions: Public ordinary functions
Function, wl-display-connect: Public ordinary functions
Function, wl-display-dispatch-event: Public ordinary functions
Function, wl-display-listen: Public ordinary functions
Function, wl-display-roundtrip: Public ordinary functions
Function, wl-display.get-registry: Public ordinary functions
Function, wl-display.sync: Public ordinary functions
Function, wl-keyboard.release: Public ordinary functions
Function, wl-output.release: Public ordinary functions
Function, wl-parse: Public ordinary functions
Function, wl-pointer.release: Public ordinary functions
Function, wl-pointer.set-cursor: Public ordinary functions
Function, wl-region.add: Public ordinary functions
Function, wl-region.destroy: Public ordinary functions
Function, wl-region.subtract: Public ordinary functions
Function, wl-registry.bind: Public ordinary functions
Function, wl-seat.get-keyboard: Public ordinary functions
Function, wl-seat.get-pointer: Public ordinary functions
Function, wl-seat.get-touch: Public ordinary functions
Function, wl-seat.release: Public ordinary functions
Function, wl-shell-surface.move: Public ordinary functions
Function, wl-shell-surface.pong: Public ordinary functions
Function, wl-shell-surface.resize: Public ordinary functions
Function, wl-shell-surface.set-class: Public ordinary functions
Function, wl-shell-surface.set-fullscreen: Public ordinary functions
Function, wl-shell-surface.set-maximized: Public ordinary functions
Function, wl-shell-surface.set-popup: Public ordinary functions
Function, wl-shell-surface.set-title: Public ordinary functions
Function, wl-shell-surface.set-toplevel: Public ordinary functions
Function, wl-shell-surface.set-transient: Public ordinary functions
Function, wl-shell.get-shell-surface: Public ordinary functions
Function, wl-shm-pool.create-buffer: Public ordinary functions
Function, wl-shm-pool.destroy: Public ordinary functions
Function, wl-shm-pool.resize: Public ordinary functions
Function, wl-shm.create-pool: Public ordinary functions
Function, wl-subcompositor.destroy: Public ordinary functions
Function, wl-subcompositor.get-subsurface: Public ordinary functions
Function, wl-subsurface.destroy: Public ordinary functions
Function, wl-subsurface.place-above: Public ordinary functions
Function, wl-subsurface.place-below: Public ordinary functions
Function, wl-subsurface.set-desync: Public ordinary functions
Function, wl-subsurface.set-position: Public ordinary functions
Function, wl-subsurface.set-sync: Public ordinary functions
Function, wl-surface.attach: Public ordinary functions
Function, wl-surface.commit: Public ordinary functions
Function, wl-surface.damage: Public ordinary functions
Function, wl-surface.damage-buffer: Public ordinary functions
Function, wl-surface.destroy: Public ordinary functions
Function, wl-surface.frame: Public ordinary functions
Function, wl-surface.offset: Public ordinary functions
Function, wl-surface.set-buffer-scale: Public ordinary functions
Function, wl-surface.set-buffer-transform: Public ordinary functions
Function, wl-surface.set-input-region: Public ordinary functions
Function, wl-surface.set-opaque-region: Public ordinary functions
Function, wl-touch.release: Public ordinary functions
Function, wp-presentation.destroy: Public ordinary functions
Function, wp-presentation.feedback: Public ordinary functions
Function, wp-viewport.destroy: Public ordinary functions
Function, wp-viewport.set-destination: Public ordinary functions
Function, wp-viewport.set-source: Public ordinary functions
Function, wp-viewporter.destroy: Public ordinary functions
Function, wp-viewporter.get-viewport: Public ordinary functions
Function, xdg-popup.destroy: Public ordinary functions
Function, xdg-popup.grab: Public ordinary functions
Function, xdg-popup.reposition: Public ordinary functions
Function, xdg-positioner.destroy: Public ordinary functions
Function, xdg-positioner.set-anchor: Public ordinary functions
Function, xdg-positioner.set-anchor-rect: Public ordinary functions
Function, xdg-positioner.set-constraint-adjustment: Public ordinary functions
Function, xdg-positioner.set-gravity: Public ordinary functions
Function, xdg-positioner.set-offset: Public ordinary functions
Function, xdg-positioner.set-parent-configure: Public ordinary functions
Function, xdg-positioner.set-parent-size: Public ordinary functions
Function, xdg-positioner.set-reactive: Public ordinary functions
Function, xdg-positioner.set-size: Public ordinary functions
Function, xdg-surface.ack-configure: Public ordinary functions
Function, xdg-surface.destroy: Public ordinary functions
Function, xdg-surface.get-popup: Public ordinary functions
Function, xdg-surface.get-toplevel: Public ordinary functions
Function, xdg-surface.set-window-geometry: Public ordinary functions
Function, xdg-toplevel.destroy: Public ordinary functions
Function, xdg-toplevel.move: Public ordinary functions
Function, xdg-toplevel.resize: Public ordinary functions
Function, xdg-toplevel.set-app-id: Public ordinary functions
Function, xdg-toplevel.set-fullscreen: Public ordinary functions
Function, xdg-toplevel.set-max-size: Public ordinary functions
Function, xdg-toplevel.set-maximized: Public ordinary functions
Function, xdg-toplevel.set-min-size: Public ordinary functions
Function, xdg-toplevel.set-minimized: Public ordinary functions
Function, xdg-toplevel.set-parent: Public ordinary functions
Function, xdg-toplevel.set-title: Public ordinary functions
Function, xdg-toplevel.show-window-menu: Public ordinary functions
Function, xdg-toplevel.unset-fullscreen: Public ordinary functions
Function, xdg-toplevel.unset-maximized: Public ordinary functions
Function, xdg-wm-base.create-positioner: Public ordinary functions
Function, xdg-wm-base.destroy: Public ordinary functions
Function, xdg-wm-base.get-xdg-surface: Public ordinary functions
Function, xdg-wm-base.pong: Public ordinary functions

G
Generic Function, %call-with-message: Private generic functions
Generic Function, %proxy-table: Private generic functions
Generic Function, %read-event: Private generic functions
Generic Function, %wl-display-socket: Private generic functions
Generic Function, %wl-proxy-display: Private generic functions
Generic Function, %wl-proxy-id: Private generic functions
Generic Function, %write-fd: Private generic functions
Generic Function, %write-message: Private generic functions
Generic Function, (setf %wl-proxy-display): Private generic functions
Generic Function, (setf %wl-proxy-id): Private generic functions
Generic Function, (setf wl-proxy-hooks): Public generic functions
Generic Function, close-socket: Public generic functions
Generic Function, deletedp: Private generic functions
Generic Function, destroy-proxy: Public generic functions
Generic Function, listen-socket: Public generic functions
Generic Function, read-fd: Public generic functions
Generic Function, wl-args: Public generic functions
Generic Function, wl-bitfield: Public generic functions
Generic Function, wl-copyright: Public generic functions
Generic Function, wl-description: Public generic functions
Generic Function, wl-display-disconnect: Public generic functions
Generic Function, wl-display-pathname: Public generic functions
Generic Function, wl-entries: Public generic functions
Generic Function, wl-enum-keyword: Public generic functions
Generic Function, wl-enum-value: Public generic functions
Generic Function, wl-enums: Public generic functions
Generic Function, wl-events: Public generic functions
Generic Function, wl-interface-name: Public generic functions
Generic Function, wl-interface-version: Public generic functions
Generic Function, wl-interfaces: Public generic functions
Generic Function, wl-name: Public generic functions
Generic Function, wl-proxy-display: Public generic functions
Generic Function, wl-proxy-hooks: Public generic functions
Generic Function, wl-proxy-id: Public generic functions
Generic Function, wl-proxy-version: Public generic functions
Generic Function, wl-requests: Public generic functions
Generic Function, wl-since: Public generic functions
Generic Function, wl-summary: Public generic functions
Generic Function, wl-text: Public generic functions
Generic Function, wl-type: Public generic functions
Generic Function, wl-value: Public generic functions
Generic Function, wl-version: Public generic functions

I
incf-buf: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
input-files: Public standalone methods
input-files: Public standalone methods
input-files: Public standalone methods

L
listen-socket: Public generic functions
listen-socket: Public generic functions

M
Macro, %check-proxy: Private macros
Macro, %event-xcase: Private macros
Macro, %option-bind: Private macros
Macro, %optionally: Private macros
Macro, %optionally*: Private macros
Macro, %slambda: Private macros
Macro, %specifier-bind: Private macros
Macro, %wl-message-size: Private macros
Macro, %wl-primitive-size: Private macros
Macro, %wltype-case: Private macros
Macro, %wltype-ecase: Private macros
Macro, %wltype-xcase: Private macros
Macro, @and: Private macros
Macro, define-enum: Public macros
Macro, define-event: Public macros
Macro, define-interface: Public macros
Macro, define-request: Public macros
Macro, evclambda: Public macros
Macro, evelambda: Public macros
Macro, event-case: Public macros
Macro, event-ccase: Public macros
Macro, event-ecase: Public macros
Macro, evlambda: Public macros
Macro, evxlambda: Private macros
Macro, send-wl-message: Public macros
Macro, with-incoming-message: Public macros
Macro, with-open-display: Public macros
Macro, with-proxy: Public macros
Macro, wl-include: Public macros
make-buf: Private ordinary functions
make-circular-buffer: Private ordinary functions
make-socket: Public ordinary functions
memcpy: Public ordinary functions
Method, %call-with-message: Private generic functions
Method, %proxy-table: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event: Private generic functions
Method, %read-event</