WLDISPLAYCONNECT(3) wldisplayconnect WLDISPLAYCONNECT(3)

NAME
       wldisplayconnect, wldisplayconnecttofd - Connect to a Wayland
       socket

SYNOPSIS
       #include 

       struct wldisplay *wldisplayconnect(const char *name);

       struct wldisplay *wldisplayconnecttofd(int fd);

DESCRIPTION
       wldisplayconnect connects to a Wayland socket that was previously
       opened by a Wayland server. The server socket must be placed in
       XDGRUNTIMEDIR when WAYLANDDISPLAY (or name, 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.

       The name argument specifies the name of the socket or NULL to use the
       default (which is "wayland-0"). The environment variable
       WAYLANDDISPLAY replaces the default value. If name is 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 setting
       WAYLANDDISPLAY to an absolute path will implicitly cause name to take
       on that absolute path if name is NULL. If WAYLANDSOCKET is set, this
       function behaves like wldisplayconnecttofd with the file-descriptor
       number taken from the environment variable.

       Support for interpreting WAYLANDDISPLAY as an absolute path is a
       change in behavior compared to wldisplayconnect'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 concatenating
       XDGRUNTIMEDIR and WAYLANDDISPLAY. Manual construction of the socket
       path must account for the possibility that WAYLANDDISPLAY contains an
       absolute path.

       wldisplayconnecttofd connects to a Wayland socket with an explicit
       file-descriptor. The file-descriptor is passed as argument fd.

RETURN VALUE
       wldisplayconnect and wldisplayconnecttofd return a new display
       context object or NULL on failure.  errno is set correspondingly.

SEE ALSO
       wayland-client(7), wldisplaydisconnect(3), wldisplayiterate(3)



wayland-client                  September 2012           WLDISPLAYCONNECT(3)