158 lines
4.8 KiB
HTML
158 lines
4.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XINERAMA</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XINERAMA</H1>
|
|
Section: C Library Functions (3)<BR>Updated: libXinerama 1.1.4<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Xinerama - API for Xinerama extension to X11 Protocol
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
#include <<A HREF="file:///usr/include/X11/extensions/Xinerama.h">X11/extensions/Xinerama.h</A>>
|
|
<PRE>
|
|
|
|
Bool XineramaQueryExtension (Display *<I>dpy</I>,
|
|
int *<I>event_base_return</I>, int *<I>error_base_return</I>);
|
|
|
|
Status XineramaQueryVersion (Display *<I>dpy</I>,
|
|
int *<I>major_version_return</I>,
|
|
int *<I>minor_version_return</I>);
|
|
|
|
Bool XineramaIsActive (Display *<I>dpy</I>);
|
|
|
|
XineramaScreenInfo * XineramaQueryScreens (Display *<I>dpy</I>,
|
|
int *<I>number</I>);
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>ARGUMENTS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><I>display</I><DD>
|
|
Specifies the connection to the X server.
|
|
<DT id="2"><I>event_base_return</I><DD>
|
|
Specifies the return location for the assigned base event code
|
|
<DT id="3"><I>error_base_return</I><DD>
|
|
Specifies the return location for the assigned base error code
|
|
<DT id="4"><I>major_version_return</I><DD>
|
|
Returns the major version supported by the server
|
|
<DT id="5"><I>minor_version_return</I><DD>
|
|
Returns the minor version supported by the server
|
|
<DT id="6"><I>number</I><DD>
|
|
Returns the number of entries in the returned XineramaScreenInfo array.
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>Xinerama</B>
|
|
|
|
is a simple library designed to interface the Xinerama Extension for
|
|
retrieving information about physical output devices which may be combined
|
|
into a single logical X screen.
|
|
<P>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>FUNCTIONS</H2>
|
|
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H3><B>XineramaQueryExtension()</B></H3>
|
|
|
|
<P>
|
|
<P>
|
|
|
|
The XineramaQueryExtension function queries the Xserver to determine the
|
|
availability of the Xinerama Extension. If the extension is available, the
|
|
return value is True, and event_base_return and error_base_return are set to
|
|
the base event number and base error number for the extension, respectively.
|
|
Otherwise, the return value is False, and the values of event_base_return and
|
|
error_base_return are undefined.
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAH"> </A>
|
|
<H3><B>XineramaQueryVersion()</B></H3>
|
|
|
|
<P>
|
|
<P>
|
|
|
|
The XineramaQueryVersion function returns the version of the Xinerama extension
|
|
implemented by the Xserver. The version is returned in major_version_return
|
|
and minor_version_return. The major version will be incremented for protocol
|
|
incompatible changes, and the minor version will be incremented for small,
|
|
upwardly compatible changes.
|
|
<P>
|
|
|
|
If the Xinerama library is compatible with the version returned by the
|
|
server, it returns nonzero. If the server does not support the
|
|
XINERAMA extension, or if there was an error during communications
|
|
with the server, or if the server and library protocol versions are
|
|
incompatible, it returns zero.
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H3><B>XineramaIsActive()</B></H3>
|
|
|
|
<P>
|
|
<P>
|
|
|
|
The XineramaIsActive function returns a Boolean operator used to determine if
|
|
Xinerama is activated on the screen. Returns True for active and False for
|
|
not active.
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAJ"> </A>
|
|
<H3><B>XineramaQueryScreens()</B></H3>
|
|
|
|
<P>
|
|
<P>
|
|
|
|
The <B>XineramaQueryScreens()</B> function returns info about each
|
|
individual output device within the Xinerama Screen. The integer
|
|
pointed to by the <I>number</I> argument is updated to the number of
|
|
output devices listed in the returned array of <I>XineramaScreenInfo</I>
|
|
structures. <B>XineramaQueryScreens()</B> returns NULL and sets <I>number</I>
|
|
to 0 if Xinerama is not active.
|
|
<P>
|
|
The pointer returned should be released with <A HREF="/cgi-bin/man/man2html?3+XFree">XFree</A>(3)
|
|
when no longer needed.
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>NOTE</H2>
|
|
|
|
The original API provided for interacting with the XINERAMA extension used
|
|
function names beginning with <I>XPanoramiX</I>. That API is now deprecated
|
|
and this API should be used instead in new software.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="8"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="9"><A HREF="#lbAD">ARGUMENTS</A><DD>
|
|
<DT id="10"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
|
<DT id="11"><A HREF="#lbAF">FUNCTIONS</A><DD>
|
|
<DL>
|
|
<DT id="12"><A HREF="#lbAG"><B>XineramaQueryExtension()</B></A><DD>
|
|
<DT id="13"><A HREF="#lbAH"><B>XineramaQueryVersion()</B></A><DD>
|
|
<DT id="14"><A HREF="#lbAI"><B>XineramaIsActive()</B></A><DD>
|
|
<DT id="15"><A HREF="#lbAJ"><B>XineramaQueryScreens()</B></A><DD>
|
|
</DL>
|
|
<DT id="16"><A HREF="#lbAK">NOTE</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:01 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|