1XINERAMA(3)                Library Functions Manual                XINERAMA(3)
2
3
4

NAME

6       Xinerama - API for Xinerama extension to X11 Protocol
7

SYNOPSIS

9       #include <X11/extensions/Xinerama.h>
10
11       Bool XineramaQueryExtension (Display *dpy,
12            int *event_base_return, int *error_base_return);
13
14       Status XineramaQueryVersion (Display *dpy,
15            int *major_version_return,
16            int *minor_version_return);
17
18       Bool XineramaIsActive (Display *dpy);
19
20       XineramaScreenInfo * XineramaQueryScreens (Display *dpy,
21            int *number);
22

ARGUMENTS

24       display   Specifies the connection to the X server.
25
26       event_base_return
27                 Specifies  the  return  location  for the assigned base event
28                 code
29
30       error_base_return
31                 Specifies the return location for  the  assigned  base  error
32                 code
33
34       major_version_return
35                 Returns the major version supported by the server
36
37       minor_version_return
38                 Returns the minor version supported by the server
39
40       number    Returns the number of entries in the returned XineramaScreen‐
41                 Info array.
42

DESCRIPTION

44       Xinerama is a simple library designed to interface the Xinerama  Exten‐
45       sion for retrieving information about physical output devices which may
46       be combined into a single logical X screen.
47
48

FUNCTIONS

50   XineramaQueryExtension()
51       The XineramaQueryExtension function queries the  Xserver  to  determine
52       the  availability of the Xinerama Extension. If the extension is avail‐
53       able,  the  return   value   is   True,   and   event_base_return   and
54       error_base_return  are set to the base event number and base error num‐
55       ber for the extension, respectively.  Otherwise, the  return  value  is
56       False,  and  the  values of event_base_return and error_base_return are
57       undefined.
58
59
60
61   XineramaQueryVersion()
62       The XineramaQueryVersion function returns the version of  the  Xinerama
63       extension  implemented  by  the  Xserver.  The  version  is returned in
64       major_version_return and minor_version_return. The major  version  will
65       be incremented for protocol incompatible changes, and the minor version
66       will be incremented for small, upwardly compatible changes.
67
68       If the Xinerama library is compatible with the version returned by  the
69       server, it returns nonzero. If the server does not support the XINERAMA
70       extension, or if there was an  error  during  communications  with  the
71       server,  or  if the server and library protocol versions are incompati‐
72       ble, it returns zero.
73
74
75
76   XineramaIsActive()
77       The XineramaIsActive function returns a Boolean operator used to deter‐
78       mine  if  Xinerama  is activated on the screen. Returns True for active
79       and False for not active.
80
81
82
83   XineramaQueryScreens()
84       The XineramaQueryScreens() function returns info about each  individual
85       output  device  within  the Xinerama Screen.  The integer pointed to by
86       the number argument is updated to the number of output  devices  listed
87       in  the  returned array of XineramaScreenInfo structures.  XineramaQue‐
88       ryScreens() returns NULL and sets  number  to  0  if  Xinerama  is  not
89       active.
90
91       The  pointer  returned  should be released with XFree(3) when no longer
92       needed.
93
94
95

NOTE

97       The original API provided for interacting with the  XINERAMA  extension
98       used function names beginning with XPanoramiX.   That API is now depre‐
99       cated and this API should be used instead in new software.
100
101
102
103
104
105
106X Version 11                   libXinerama 1.1.3                   XINERAMA(3)