package wayland

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

Module WaylandSource

Sourcemodule Unix_transport : sig ... end

Send messages over a Unix-domain socket.

Sourcemodule Client : sig ... end

Connect to a Wayland server and interact with the initial display object.

Sourcemodule Registry : sig ... end

A simple wrapper for the Wayland_client.Wl_registry API.

Sourceval callback : (int32 -> unit) -> < dispatch : [< `V1 ] Wayland_client.Wl_callback.t -> (Wayland_proto.Wl_callback.t, [ `R ]) Msg.t -> unit ; max_version : int32 ; metadata : (module Metadata.S with type t = Wayland_proto.Wl_callback.t) ; min_version : int32 ; on_done : callback_data:int32 -> unit ; user_data : (Wayland_proto.Wl_callback.t, [ `Client ]) S.user_data >

callback fn is a simple wrapper for the Wayland_client.Wl_callback API. It calls fn data when the callback's "done" signal is received. Wl_callback seems to be an exception to the usual Wayland versioning rules (a wl_callback can be created by multiple objects).

Sourcemodule Server : sig ... end

Code for writing Wayland servers.

Sourcemodule Proxy : sig ... end

A proxy corresponds to an object on the connection.

Sourcemodule Fixed : sig ... end

Wayland's 24.8 fixed-point type.

Sourceval src : Logs.src

Control the library's log level.

Generated bindings for the core Wayland protocol

Sourcemodule Wayland_client : sig ... end

Bindings for use by Wayland clients.

Sourcemodule Wayland_server : sig ... end

Bindings for use by Wayland servers.

Sourcemodule Wayland_proto : sig ... end

Type metadata for use by bindings.

Low-level API

Sourcemodule Metadata : sig ... end

Describing interfaces.

Sourcemodule Msg : sig ... end

Building and parsing messages.

Sourcemodule S : sig ... end

Type signatures.

Sourcemodule Iface_reg : sig ... end

Registry of known interfaces. Used by the generated code.

OCaml

Innovation. Community. Security.