Introduction to Library Functions                     XINERAMA(3)



NAME
     Xinerama - API for Xinerama extension to X11 Protocol

SYNOPSIS
     cc [ _f_l_a_g... ] _f_i_l_e... -lXinerama [ _l_i_b_r_a_r_y... ]
     #include <X11/extensions/Xinerama.h>

     Bool XineramaQueryExtension (Display *_d_p_y,
          int *_e_v_e_n_t__b_a_s_e_p, int *_e_r_r_o_r__b_a_s_e_p);

     Status XineramaQueryVersion (Display *_d_p_y,
          int *_m_a_j_o_r__v_e_r_s_i_o_n_p,
          int *_m_i_n_o_r__v_e_r_s_i_o_n_p);

     Bool XineramaIsActive (Display *_d_p_y);

     XineramaScreenInfo * XineramaQueryScreens (Display *_d_p_y,
          int *_n_u_m_b_e_r);

ARGUMENTS
     _d_i_s_p_l_a_y   Specifies the connection to the X server.

     _e_v_e_n_t__b_a_s_e_p
               Specifies the return  location  for  the  assigned
               base event code

     _e_r_r_o_r__b_a_s_e_p
               Specifies the return  location  for  the  assigned
               base error code

     _m_a_j_o_r__v_e_r_s_i_o_n_p
               Returns the major version supported by the server

     _m_i_n_o_r__v_e_r_s_i_o_n_p
               Returns the minor version supported by the server

     _n_u_m_b_e_r    Returns the number  of  entries  in  the  returned
               XineramaScreenInfo array.

DESCRIPTION
     Xinerama 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.


FUNCTIONS
  XineramaQueryExtension()
     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  and  error_base are set to the base event number



X Version 11     Last change: libXinerama 1.0.1                 1






Introduction to Library Functions                     XINERAMA(3)



     and base error number for the extension, respectively.  Oth-
     erwise,  the  return  value  is  False,  and  the  values of
     event_base and error_base are undefined.



  XineramaQueryVersion()
     The XineramaQueryVersion function returns the version of the
     Xinerama  extension  implemented by the Xserver. The version
     is returned in major_versionp and minor_versionp. The  major
     version   will  be  incremented  for  protocol  incompatible
     changes, and the  minor  version  will  be  incremented  for
     small, upwardly compatible changes.

     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.



  XineramaIsActive()
     The XineramaActive function returns a Boolean operator  used
     to determine if Xinerama is activated on the screen. Returns
     True for active and False for not active.



  XineramaQueryScreens()
     The XineramaQueryScreens() function returns info about  each
     individual  output  device  within the Xinerama Screen.  The
     integer pointed to by the _n_u_m_b_e_r argument is updated to  the
     number  of  output  devices  listed in the returned array of
     _X_i_n_e_r_a_m_a_S_c_r_e_e_n_I_n_f_o    structures.     XineramaQueryScreens()
     returns NULL and sets _n_u_m_b_e_r to 0 if Xinerama is not active.

     The pointer returned should be released with  XFree(3)  when
     no longer needed.



NOTE
     The original API provided for interacting with the  XINERAMA
     extension  used  function  names  beginning with _X_P_a_n_o_r_a_m_i_X.
     That API is now deprecated  and  this  API  should  be  used
     instead in new software.







X Version 11     Last change: libXinerama 1.0.1                 2






Introduction to Library Functions                     XINERAMA(3)



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |______________________________|______________________________|
    | Availability                | SUNWxwplt                   |
    |______________________________|______________________________|
    | Interface Stability         | Uncommitted                 |
    |______________________________|______________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |______________________________|______________________________|










































X Version 11     Last change: libXinerama 1.0.1                 3