SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from CentOS 8 wayland-devel-1.17.0-1.el8.x86_64.rpm

WL_DISPLAY_CONNECT

Section: wl_display_connect (3)
Updated: September 2012
Index 

NAME

wl_display_connect, wl_display_connect_to_fd - Connect to a Wayland socket 

SYNOPSIS

#include <wayland-client.h>
struct wl_display *wl_display_connect(const char *name);
struct wl_display *wl_display_connect_to_fd(int fd);
 

DESCRIPTION

wl_display_connect

connects to a Wayland socket that was previously opened by a Wayland server. The server socket must be placed inXDG_RUNTIME_DIRwhenWAYLAND_DISPLAY(orname, see below) is a simple name, for this function to find it. The server socket is also allowed to exist at an arbitrary path; usage details follow. See below for compatibility issue details.

Thenameargument specifies the name of the socket orNULLto use the default (which is"wayland-0"). The environment variableWAYLAND_DISPLAYreplaces the default value. Ifnameis an absolute path, then that path is used as the Wayland socket to which the connection is attempted. Note that in combination with the default-value behavior described above, this implies that settingWAYLAND_DISPLAYto an absolute path will implicitly causenameto take on that absolute path ifnameisNULL. IfWAYLAND_SOCKETis set, this function behaves likewl_display_connect_to_fdwith the file-descriptor number taken from the environment variable.

Support for interpretingWAYLAND_DISPLAYas an absolute path is a change in behavior compared towl_display_connect's behavior in versions 1.14 and older of Wayland. It is no longer guaranteed in versions 1.15 and higher that the Wayland socket chosen is equivalent to manually constructing a socket pathname by concatenatingXDG_RUNTIME_DIRandWAYLAND_DISPLAY. Manual construction of the socket path must account for the possibility thatWAYLAND_DISPLAYcontains an absolute path.

wl_display_connect_to_fdconnects to a Wayland socket with an explicit file-descriptor. The file-descriptor is passed as argumentfd. 

RETURN VALUE

wl_display_connectandwl_display_connect_to_fdreturn a new display context object or NULL on failure.errnois set correspondingly. 

SEE ALSO

wayland-client(7),wl_display_disconnect(3),wl_display_iterate(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO

This document was created byman2html,using the manual pages.