Wayland Protocol Specification

    Copyright © 2008-2011 Kristian Høgsberg
    Copyright © 2010-2011 Intel Corporation

    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, provided that the above copyright notice appear in
    all copies and that both that copyright notice and this permission
    notice appear in supporting documentation, and that the name of
    the copyright holders not be used in advertising or publicity
    pertaining to distribution of the software without specific,
    written prior permission.  The copyright holders make no
    representations about the suitability of this software for any
    purpose.  It is provided "as is" without express or implied
    warranty.

    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
    THIS SOFTWARE.

A.1. wl_display - core global object

The core global object. This is a special singleton object. It is used for internal wayland protocol features.

A.1.1. Requests provided by wl_display

A.1.1.1. wl_display::bind - bind an object to the display

Binds a new, client-created object to the server using @name as the identifier.

wl_display::bind arguments

name: Type: uint
unique number id for object
interface: Type: string
version: Type: uint
id: Type: new_id

A.1.1.2. wl_display::sync - asynchronous roundtrip

The sync request asks the server to invoke the 'done' request on the provided wl_callback object. Since requests are handled in-order, this can be used as a barrier to ensure all previous requests have been handled.

wl_display::sync arguments

callback: Type: new_id

A.1.2. Events provided by wl_display events

A.1.2.1. wl_display::error - fatal error event

The error event is sent out when a fatal (non-recoverable) error has occurred.

wl_display::error arguments

object_id: Type: object
code: Type: uint
message: Type: string

A.1.2.2. wl_display::global - announce global object

Notify the client of global objects. These are objects that are created by the server. Globals are published on the initial client connection sequence, upon device hotplugs, device disconnects, reconfiguration or other events. A client can 'bind' to a global object by using the bind request. This creates a client side handle that lets the object emit events to the client and lets the client invoke requests on the object.

wl_display::global arguments

name: Type: uint
interface: Type: string
version: Type: uint

A.1.2.3. wl_display::global_remove - announce removal of global object

Notify the client of removed global objects.

wl_display::global_remove arguments

name: Type: uint

A.1.2.4. wl_display::delete_id - acknowledge object id deletion

Server has deleted the id and client can now reuse it.

wl_display::delete_id arguments

id: Type: uint

A.1.3. Enums provided by wl_display enums

A.1.3.1. wl_display::error - global error values

These errors are global and can be emitted in response to any server request.

wl_display::error values

invalid_object: Value: 0
server couldn't find object
invalid_method: Value: 1
method doesn't exist on the specified interface
no_memory: Value: 2
server is out of memory