package wayland

  1. Overview
  2. Docs
package wayland
Legend:
Library
Module
Module type
Parameter
Class
Class type

Core global object.

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

type 'v t = ([ `Wl_display ], 'v, [ `Client ]) Proxy.t

Version 1

val get_registry : [< `V1 ] as 'a t -> [[ `Wl_registry ], 'b, [ `Client ]] Proxy.Handler.t -> ([ `Wl_registry ], 'c, [ `Client ]) Proxy.t

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.

val sync : [< `V1 ] as 'a t -> [[ `Wl_callback ], 'b, [ `Client ]] Proxy.Handler.t -> ([ `Wl_callback ], 'c, [ `Client ]) Proxy.t

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.

Handlers

Note: Servers will always want to use v1.

class virtual +'a v1 : object ... end

Handler for a proxy with version >= 1.