package wayland

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

Handler for a proxy with version >= 5.

constraint 'a = [< `V5 ]
method private virtual on_get_layer_surface : [> `V5 ] t -> ([ `Zwlr_layer_surface_v1 ], 'b, [ `Server ]) {Proxy}2.t -> surface: ([ `Wl_surface ], [> {Imports}1.Wl_surface.versions ], [ `Server ]) {Proxy}2.t -> output: ([ `Wl_output ], [> {Imports}1.Wl_output.versions ], [ `Server ]) {Proxy}2.t option -> layer:{Imports}1.Zwlr_layer_shell_v1.Layer.t -> namespace:string -> unit

Create a layer_surface from a surface.

Create a layer surface for an existing surface. This assigns the role of layer_surface, or raises a protocol error if another role is already assigned.

Creating a layer surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first layer_surface.configure call must also be treated as errors.

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

You may pass NULL for output to allow the compositor to decide which output to use. Generally this will be the one that the user most recently interacted with.

Clients can specify a namespace that defines the purpose of the layer surface.

method private virtual on_destroy : [> `V5 ] t -> unit

Destroy the layer_shell object.

This request indicates that the client will not use the layer_shell object any more. Objects that have been created through this instance are not affected.

method min_version : int32
method bind_version : [ `V5 ]
OCaml

Innovation. Community. Security.