5e014c81cc
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> [re-run of search/replace after rebasing] Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
89 lines
3.2 KiB
XML
89 lines
3.2 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
<!--
|
|
Written 2012 by David Herrmann <dh.herrmann@googlemail.com>
|
|
Dedicated to the Public Domain
|
|
-->
|
|
|
|
<refentry id="wl_display_connect">
|
|
<refentryinfo>
|
|
<title>wl_display_connect</title>
|
|
<productname>wayland-client</productname>
|
|
<date>September 2012</date>
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>David</firstname>
|
|
<surname>Herrmann</surname>
|
|
<email>dh.herrmann@googlemail.com</email>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>wl_display_connect</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>wl_display_connect</refname>
|
|
<refname>wl_display_connect_to_fd</refname>
|
|
<refpurpose>Connect to a Wayland socket</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
|
|
<funcsynopsisinfo>#include <wayland-client.h></funcsynopsisinfo>
|
|
|
|
<funcprototype>
|
|
<funcdef>struct wl_display *<function>wl_display_connect</function></funcdef>
|
|
<paramdef>const char *<parameter>name</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
<funcprototype>
|
|
<funcdef>struct wl_display *<function>wl_display_connect_to_fd</function></funcdef>
|
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para><function>wl_display_connect</function> connects to a Wayland socket
|
|
that was previously opened by a Wayland server. The server socket must
|
|
be placed in <envar>XDG_RUNTIME_DIR</envar> for this function to
|
|
find it. The <varname>name</varname> argument specifies the name of
|
|
the socket or <constant>NULL</constant> to use the default (which is
|
|
<constant>"wayland-0"</constant>). The environment variable
|
|
<envar>WAYLAND_DISPLAY</envar> replaces the default value. If
|
|
<envar>WAYLAND_SOCKET</envar> is set, this function behaves like
|
|
<function>wl_display_connect_to_fd</function> with the file-descriptor
|
|
number taken from the environment variable.</para>
|
|
|
|
<para><function>wl_display_connect_to_fd</function> connects to a Wayland
|
|
socket with an explicit file-descriptor. The file-descriptor is passed
|
|
as argument <varname>fd</varname>.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Return Value</title>
|
|
<para><function>wl_display_connect</function> and
|
|
<function>wl_display_connect_to_fd</function> return a new display
|
|
context object or NULL on failure. <varname>errno</varname> is set
|
|
correspondingly.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>wayland-client</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>wl_display_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>wl_display_iterate</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|