Package org.freedesktop.wayland.client

Class WlDisplayProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<Void>

org.freedesktop.wayland.client.Display

org.freedesktop.wayland.client.WlDisplayProxy

All Implemented Interfaces:

WaylandObject

public class WlDisplayProxy
extends Display

core global object

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

See Also:

• Display

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Display

OBJECT_ID

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor	Description
WlDisplayProxy(MemorySegment pointer)

Method Summary

Modifier and Type	Method	Description
static WlDisplayProxy	connect(String name)	Connect to a Wayland display
static WlDisplayProxy	connectToFd(int fd)	Connect to Wayland display on an already open fd
Void	getImplementation()	Get a proxy's listener
WlRegistryProxy	getRegistry(WlRegistryEvents implementation)	get global registry object
WlCallbackProxy	sync(WlCallbackEvents implementation)	asynchronous roundtrip

Methods inherited from class org.freedesktop.wayland.client.Display

_connect, _connect, _connect, cancelRead, createQueue, disconnect, dispatch, dispatchPending, dispatchQueue, dispatchQueuePending, flush, getError, getFD, prepareRead, prepareReadQueue, readEvents, roundtrip

Methods inherited from class org.freedesktop.wayland.client.Proxy

destroy, equals, getId, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

WlDisplayProxy

public WlDisplayProxy(MemorySegment pointer)

Method Details

sync

public WlCallbackProxy sync(WlCallbackEvents implementation)

asynchronous roundtrip

The sync request asks the server to emit the 'done' event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is undefined and should be ignored.

Parameters:

implementation - A protocol event listener for the newly created proxy.

getRegistry

public WlRegistryProxy getRegistry(WlRegistryEvents implementation)

get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor.

It should be noted that the server side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke get_registry as infrequently as possible to avoid wasting memory.

Parameters:

implementation - A protocol event listener for the newly created proxy.

connect

public static WlDisplayProxy connect(String name)

Connect to a Wayland display

Connect to the Wayland display named 'name'. If 'name' is 'null', its value will be replaced with the WAYLAND_DISPLAY environment variable if it is set, otherwise display "wayland-0" will be used.

Parameters:

name - Name of the Wayland display to connect to

Returns:

A WlDisplayProxy object or null on failure.

connectToFd

public static WlDisplayProxy connectToFd(int fd)

Connect to Wayland display on an already open fd

The WlDisplayProxy takes ownership of the fd and will close it when the display is destroyed. The fd will also be closed in case of failure.

Parameters:

fd - The fd to use for the connection

Returns:

A WlDisplayProxy object or null on failure.

getImplementation

public Void getImplementation()

Description copied from class: Proxy

Get a proxy's listener

Gets the proxy's listener; which is the implementation set when this proxy was constructed.

This function is useful in client with multiple listeners on the same interface to allow the identification of which code to execute.

Specified by:

getImplementation in interface WaylandObject

Overrides:

getImplementation in class Proxy<Void>

Returns:

The proxy's listener or NULL if no listener is set