package oxbow

  1. Overview
  2. Docs
Dynamic window manager for the river Wayland compositor

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (2)

Authors

  1. 3
    3L0C

Maintainers

  1. 3
    3L0C

Sources

v0.1.1.tar.gz
md5=a182e6d368a65e6752771e41e651713f
sha512=020d2c7f9f4e06966ca56695e24eb0b41dd12500aa65d2cd9b56e03068bbb6ea7770de0a33c04f0d054bd474bee8c2b36bb46af86266c9823490e1bd0810c027

doc/oxbow.river/River/Window_management/River_decoration_v1/index.html

Module Window_management.River_decoration_v1Source

A window decoration.

The rendering order of windows with decorations is follows:

1. Decorations created with get_decoration_below at the bottom 2. Window content 3. Borders configured with river_window_v1.set_borders 4. Decorations created with get_decoration_above at the top

The relative ordering of decoration surfaces above/below a window is undefined by this protocol and left up to the compositor.

Sourcetype 'v t = ([ `River_decoration_v1 ], 'v, [ `Client ]) Wayland.Proxy.t
Sourcemodule Error : sig ... end

Version 1, 2, 3, 4, 5

Sourceval sync_next_commit : [< `V1 | `V2 | `V3 | `V4 | `V5 ] t -> unit

Sync next commit with other rendering state.

Synchronize application of the next wl_surface.commit request on the decoration surface with rest of the state atomically applied with the next river_window_manager_v1.render_finish request.

The client must make a wl_surface.commit request on the decoration surface after this request and before the render_finish request, failure to do so is a protocol error.

This request modifies rendering state and may only be made as part of a render sequence, see the river_window_manager_v1 description.

Sourceval set_offset : [< `V1 | `V2 | `V3 | `V4 | `V5 ] t -> x:int32 -> y:int32 -> unit

Set offset from the window's top left corner.

This request sets the offset of the decoration surface from the top left corner of the window.

If this request is never sent, the x and y offsets are undefined by this protocol and left up to the compositor.

This request modifies rendering state and may only be made as part of a render sequence, see the river_window_manager_v1 description.

Sourceval destroy : [< `V1 | `V2 | `V3 | `V4 | `V5 ] t -> unit

Destroy the decoration object.

This request indicates that the client will no longer use the decoration object and that it may be safely destroyed.

Handlers

Note: Servers will always want to use v1.

Sourceclass +'a v1 : object ... end

Handler for a proxy with version >= 1.

Sourceclass +'a v2 : object ... end

Handler for a proxy with version >= 2.

Sourceclass +'a v3 : object ... end

Handler for a proxy with version >= 3.

Sourceclass +'a v4 : object ... end

Handler for a proxy with version >= 4.

Sourceclass +'a v5 : object ... end

Handler for a proxy with version >= 5.