wau

• Index

Contents

• Methods

Classes

• wl_display
• wl_interface
• wl_proxy
• wl_cursor
• wl_cursor_image
• wl_cursor_theme

Protocols

• wayland

Manual

• README
• coming-from-c
• overview
• scanner

Examples

• foreign_toplevel_manager.lua
• layershell.lua
• list_globals.lua
• toplevel.lua
• xdg_top.lua

Class wl_display

A wl_display consist of two parts: The wl_display as defined in the wayland.xml protocol and the one that handles the connection to the wayland compositor.

In here only the connection handling aspect is documented.

Methods

wl_display:roundtrip ()	Work off all staging events through their respective event listeners
wl_display:disconnect ()	Disconnect from the wayland compositor
wl_display:connect (name)	Connect to an existing wayland compositor

Methods

wl_display:roundtrip ()

Work off all staging events through their respective event listeners

Returns:

wl_display Self

wl_display:disconnect ()

Disconnect from the wayland compositor

Returns:

wl_display self

wl_display:connect (name)

Connect to an existing wayland compositor

Parameters:

• name string If nil then XDG_RUNTIME_DIR and WAYLAND_DISPLAY will be concatenated

Returns:

optional wl_display A wl_display on success and nil on error

See also:

list_globals.lua

Usage:

local display = wau.wl_display.connect()