The wayflan Reference Manual

4.1.1 wayflan/wayflan.asd

Source

wayflan.asd.

Parent Component

wayflan (system).

ASDF Systems

• wayflan.
• wayflan/common.

---

4.1.2 wayflan-client/wayflan-client.asd

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

ASDF Systems

wayflan-client.

---

4.1.3 wayflan-client/packages.lisp

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Packages

• xyz.shunter.wayflan.client.scanner.
• xyz.shunter.wayflan.client.viewporter.
• xyz.shunter.wayflan.client.presentation-time.
• xyz.shunter.wayflan.client.
• xyz.shunter.wayflan.client.xdg-shell.

---

4.1.4 wayflan-client/client.lisp

Dependency

packages.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface

• define-enum (macro).
• define-event (macro).
• define-interface (macro).
• define-request (macro).
• destroy-proxy (generic function).
• evclambda (macro).
• evelambda (macro).
• event-case (macro).
• event-ccase (macro).
• event-ecase (macro).
• evlambda (macro).
• find-interface-named (function).
• find-proxy (function).
• initialize-instance (method).
• initialize-instance (method).
• print-object (method).
• print-object (method).
• reinitialize-instance (method).
• validate-superclass (method).
• with-open-display (macro).
• with-proxy (macro).
• wl-destroyed-proxy (class).
• wl-display (class).
• wl-display-connect (function).
• wl-display-disconnect (generic function).
• wl-display-dispatch-event (function).
• wl-display-listen (function).
• wl-display-pathname (reader method).
• wl-display-roundtrip (function).
• wl-enum-keyword (generic function).
• wl-enum-value (generic function).
• wl-interface-class (class).
• wl-interface-name (generic function).
• wl-interface-version (generic function).
• wl-proxy (class).
• wl-proxy-display (reader method).
• wl-proxy-hooks (reader method).
• (setf wl-proxy-hooks) (writer method).
• wl-proxy-id (reader method).
• wl-proxy-version (reader method).

Internals

• %check-proxy (macro).
• %clear-proxies (function).
• %decode-bitfield-enum (function).
• %decode-standard-enum (function).
• %destroy-proxy (function).
• %dispatch-event (function).
• %encode-bitfield-enum (function).
• %encode-standard-enum (function).
• %event-xcase (macro).
• %find-proxy! (function).
• %make-proxy (function).
• %next-proxy-id (function).
• %option-bind (macro).
• %proxy-table (reader method).
• %read-event (function).
• %set-interface-named (function).
• %set-proxy (function).
• %sgetf (function).
• %slambda (macro).
• %specifier-bind (macro).
• %wl-display-socket (reader method).
• %wl-event-function (type).
• %wl-proxy-display (reader method).
• (setf %wl-proxy-display) (writer method).
• %wl-proxy-id (reader method).
• (setf %wl-proxy-id) (writer method).
• %wltype-case (macro).
• %wltype-ecase (macro).
• %wltype-xcase (macro).
• %wltype= (function).
• *interface-table* (special variable).
• @and (macro).
• deletedp (reader method).
• display-pathname (function).
• evxlambda (macro).

---

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

• %documentation (function).
• %dot (function).
• %lispify (function).
• %pathname-or-input (function).
• %transform-arg (function).
• %transform-enum (function).
• %transform-event (function).
• %transform-interface (function).
• %transform-protocol (function).
• %transform-request (function).
• *exclude-defclasses* (special variable).
• *syms-to-export* (special variable).

---

4.1.6 wayflan-client/asdf.lisp

Dependency

scanner.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface

• component-depends-on (method).
• component-depends-on (method).
• input-files (method).
• input-files (method).
• input-files (method).
• output-files (method).
• perform (method).

Internals

• wayflan-client-impl (class).
• wayflan-doc-to-forms (function).
• wayflan-scan-op (class).
• wayflan-scan-output-file (function).

---

4.1.7 wayflan-client/wayland-protocol.lisp

Dependency

scanner.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface

• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• wl-buffer (class).
• wl-buffer.destroy (function).
• wl-callback (class).
• wl-compositor (class).
• wl-compositor.create-region (function).
• wl-compositor.create-surface (function).
• wl-data-device (class).
• wl-data-device-manager (class).
• wl-data-device-manager.create-data-source (function).
• wl-data-device-manager.get-data-device (function).
• wl-data-device.release (function).
• wl-data-device.set-selection (function).
• wl-data-device.start-drag (function).
• wl-data-offer (class).
• wl-data-offer.accept (function).
• wl-data-offer.destroy (function).
• wl-data-offer.finish (function).
• wl-data-offer.receive (function).
• wl-data-offer.set-actions (function).
• wl-data-source (class).
• wl-data-source.destroy (function).
• wl-data-source.offer (function).
• wl-data-source.set-actions (function).
• wl-display.get-registry (function).
• wl-display.sync (function).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-keyboard (class).
• wl-keyboard.release (function).
• wl-output (class).
• wl-output.release (function).
• wl-pointer (class).
• wl-pointer.release (function).
• wl-pointer.set-cursor (function).
• wl-region (class).
• wl-region.add (function).
• wl-region.destroy (function).
• wl-region.subtract (function).
• wl-registry (class).
• wl-registry.bind (function).
• wl-seat (class).
• wl-seat.get-keyboard (function).
• wl-seat.get-pointer (function).
• wl-seat.get-touch (function).
• wl-seat.release (function).
• wl-shell (class).
• wl-shell-surface (class).
• wl-shell-surface.move (function).
• wl-shell-surface.pong (function).
• wl-shell-surface.resize (function).
• wl-shell-surface.set-class (function).
• wl-shell-surface.set-fullscreen (function).
• wl-shell-surface.set-maximized (function).
• wl-shell-surface.set-popup (function).
• wl-shell-surface.set-title (function).
• wl-shell-surface.set-toplevel (function).
• wl-shell-surface.set-transient (function).
• wl-shell.get-shell-surface (function).
• wl-shm (class).
• wl-shm-pool (class).
• wl-shm-pool.create-buffer (function).
• wl-shm-pool.destroy (function).
• wl-shm-pool.resize (function).
• wl-shm.create-pool (function).
• wl-subcompositor (class).
• wl-subcompositor.destroy (function).
• wl-subcompositor.get-subsurface (function).
• wl-subsurface (class).
• wl-subsurface.destroy (function).
• wl-subsurface.place-above (function).
• wl-subsurface.place-below (function).
• wl-subsurface.set-desync (function).
• wl-subsurface.set-position (function).
• wl-subsurface.set-sync (function).
• wl-surface (class).
• wl-surface.attach (function).
• wl-surface.commit (function).
• wl-surface.damage (function).
• wl-surface.damage-buffer (function).
• wl-surface.destroy (function).
• wl-surface.frame (function).
• wl-surface.offset (function).
• wl-surface.set-buffer-scale (function).
• wl-surface.set-buffer-transform (function).
• wl-surface.set-input-region (function).
• wl-surface.set-opaque-region (function).
• wl-touch (class).
• wl-touch.release (function).

---

4.1.8 wayflan-client/stable-protocols.lisp

Dependencies

• scanner.lisp (file).
• wayland-protocol.lisp (file).

Source

wayflan-client.asd.

Parent Component

wayflan-client (system).

Public Interface

• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• destroy-proxy (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-keyword (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wl-enum-value (method).
• wp-presentation (class).
• wp-presentation-feedback (class).
• wp-presentation.destroy (function).
• wp-presentation.feedback (function).
• wp-viewport (class).
• wp-viewport.destroy (function).
• wp-viewport.set-destination (function).
• wp-viewport.set-source (function).
• wp-viewporter (class).
• wp-viewporter.destroy (function).
• wp-viewporter.get-viewport (function).
• xdg-popup (class).
• xdg-popup.destroy (function).
• xdg-popup.grab (function).
• xdg-popup.reposition (function).
• xdg-positioner (class).
• xdg-positioner.destroy (function).
• xdg-positioner.set-anchor (function).
• xdg-positioner.set-anchor-rect (function).
• xdg-positioner.set-constraint-adjustment (function).
• xdg-positioner.set-gravity (function).
• xdg-positioner.set-offset (function).
• xdg-positioner.set-parent-configure (function).
• xdg-positioner.set-parent-size (function).
• xdg-positioner.set-reactive (function).
• xdg-positioner.set-size (function).
• xdg-surface (class).
• xdg-surface.ack-configure (function).
• xdg-surface.destroy (function).
• xdg-surface.get-popup (function).
• xdg-surface.get-toplevel (function).
• xdg-surface.set-window-geometry (function).
• xdg-toplevel (class).
• xdg-toplevel.destroy (function).
• xdg-toplevel.move (function).
• xdg-toplevel.resize (function).
• xdg-toplevel.set-app-id (function).
• xdg-toplevel.set-fullscreen (function).
• xdg-toplevel.set-max-size (function).
• xdg-toplevel.set-maximized (function).
• xdg-toplevel.set-min-size (function).
• xdg-toplevel.set-minimized (function).
• xdg-toplevel.set-parent (function).
• xdg-toplevel.set-title (function).
• xdg-toplevel.show-window-menu (function).
• xdg-toplevel.unset-fullscreen (function).
• xdg-toplevel.unset-maximized (function).
• xdg-wm-base (class).
• xdg-wm-base.create-positioner (function).
• xdg-wm-base.destroy (function).
• xdg-wm-base.get-xdg-surface (function).
• xdg-wm-base.pong (function).

---

4.1.9 wayflan/common/packages.lisp

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Packages

• xyz.shunter.wayflan.
• xyz.shunter.wayflan.ffi.
• xyz.shunter.wayflan.wire.

---

4.1.10 wayflan/common/protocol.lisp

Dependency

packages.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface

• print-object (method).
• wl-arg (class).
• wl-args (reader method).
• wl-bitfield (reader method).
• wl-copyright (reader method).
• wl-description (reader method).
• wl-description (reader method).
• wl-description (reader method).
• wl-description (reader method).
• wl-description (reader method).
• wl-description (class).
• wl-entries (reader method).
• wl-entry (class).
• wl-enum (class).
• wl-enums (reader method).
• wl-event (class).
• wl-events (reader method).
• wl-interface (class).
• wl-interfaces (reader method).
• wl-name (reader method).
• wl-parse (function).
• wl-protocol (class).
• wl-request (class).
• wl-requests (reader method).
• wl-since (reader method).
• wl-since (reader method).
• wl-since (reader method).
• wl-summary (reader method).
• wl-summary (reader method).
• wl-summary (reader method).
• wl-text (reader method).
• wl-type (reader method).
• wl-type (reader method).
• wl-value (reader method).
• wl-version (reader method).

Internals

• %arg-of (function).
• %children (function).
• %description-of (function).
• %entry-of (function).
• %enum-of (function).
• %event-of (function).
• %folding-text (function).
• %interface-of (function).
• %keyword (function).
• %literal-text (function).
• %message-of (function).
• %optionally (macro).
• %optionally* (macro).
• %parse-integer (function).
• %protocol-of (function).
• %request-of (function).
• %text (function).
• %wl-message (class).
• %wl-message-type (type).
• %wl-named-object (class).

---

4.1.11 wayflan/common/types.lisp

Dependency

packages.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface

• +most-negative-wl-fixed+ (constant).
• +most-negative-wl-int+ (constant).
• +most-positive-wl-fixed+ (constant).
• +most-positive-wl-int+ (constant).
• +most-positive-wl-uint+ (constant).
• wl-array (type).
• wl-fixed (type).
• wl-int (type).
• wl-uint (type).

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

• *errno* (symbol macro).
• accept (function).
• bind (function).
• bzero (function).
• close-fd (function).
• connect-fd (function).
• memcpy (function).
• recvmsg (function).
• sendmsg (function).
• socket (function).
• strerror (function).

Internals

• %var-accessor-*errno* (function).
• (setf %var-accessor-*errno*) (function).
• cmsghdr-tclass (class).
• iovec-tclass (class).
• msghdr-tclass (class).
• sockaddr-un-tclass (class).

---

4.1.14 wayflan/common/conditions.lisp

Dependencies

• packages.lisp (file).
• ffi.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface

• wl-error (condition).
• wl-message-error (condition).
• wl-server-error (condition).
• wl-socket-error (condition).

---

4.1.15 wayflan/common/wire.lisp

Dependencies

• ffi.lisp (file).
• types.lisp (file).
• conditions.lisp (file).

Source

wayflan.asd.

Parent Component

wayflan/common (system).

Public Interface

• close-socket (generic function).
• cmsg-len (function).
• connect (function).
• data-socket (class).
• listen-socket (generic function).
• make-socket (function).
• print-object (method).
• read-fd (generic function).
• read-wl-array (function).
• read-wl-fixed (function).
• read-wl-int (function).
• read-wl-string (function).
• read-wl-uint (function).
• send-wl-message (macro).
• with-incoming-message (macro).

Internals

• %call-with-message (generic function).
• %clear-socket-input (function).
• %flush-output (function).
• %prepare-gather-cmsg (function).
• %read-once (function).
• %socket (class).
• %wl-message-size (macro).
• %wl-primitive-size (macro).
• %write-fd (generic function).
• %write-message (generic function).
• %write-wl-array (function).
• %write-wl-fixed (function).
• %write-wl-int (function).
• %write-wl-string (function).
• %write-wl-uint (function).
• +buf-size+ (constant).
• +cspace+ (constant).
• +header-length+ (constant).
• +max-fds-out+ (constant).
• +sun-path-length+ (constant).
• +wl-word-size+ (constant).
• buf-offset (function).
• buf-ptr (function).
• buf-size (function).
• c-sized-int (type).
• cb-clear (function).
• cb-copy (function).
• cb-end (reader).
• (setf cb-end) (writer).
• cb-end* (function).
• cb-free-space (function).
• cb-length (function).
• cb-prepare-gather-iovec (function).
• cb-prepare-scatter-iovec (function).
• cb-ptr (reader).
• (setf cb-ptr) (writer).
• cb-pull-foreign-octets (function).
• cb-pull-number (function).
• cb-push-foreign-octets (function).
• cb-push-number (function).
• cb-shiftin (function).
• cb-shiftout (function).
• cb-start (reader).
• (setf cb-start) (writer).
• cb-start* (function).
• check-size (function).
• circular-buffer (structure).
• cmsg-align (function).
• cmsg-data (function).
• cmsg-firsthdr (function).
• cmsg-nxthdr (function).
• cmsg-space (function).
• free-circular-buffer (function).
• incf-buf (function).
• make-buf (function).
• make-circular-buffer (function).
• padded-size (function).

---

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

---

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

Defines an argument subtype that associates integer values with keyword symbols.
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.
(:bitfield BOOLEAN) - Whether individual bits have specific meanings. If set, enums are coded as a list of keywords, rather than a single keyword. (:documentation DOCSTRING) - Ignored.

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) - Describes the event. This option does not change any behavior. (:TYPE TYPE) - So far, only :DESTRUCTOR is a valid type. This option does not change any behavior. (:SINCE VERSION) - 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 wayland object interface as subclass of wl-proxy.

NAME - The name of the interface class.

OPTIONS:

(:version VERSION) - Latest supported version of the interface.
(:documentation DOCSTRING) - Docstring attached to the defined class.
(: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 interface’s 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:

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

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.

---