package wayland

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

Handler for a proxy with version >= 1.

constraint 'a = [< `V1 ]
method private virtual on_sync : [> `V1 ] t -> ([ `Wl_callback ], 'b, [ `Server ]) Wayland__.Proxy.t -> unit

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.

method private virtual on_get_registry : [> `V1 ] t -> ([ `Wl_registry ], 'b, [ `Server ]) Wayland__.Proxy.t -> unit

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.

method min_version : 'a v1 -> int32
method bind_version : 'c -> [ `V1 ]