man/XdbeGetVisualInfo.man

   1 .\" Copyright (c) 1995  Hewlett-Packard Company
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice shall be included in
  11 .\" all copies or substantial portions of the Software.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  16 .\" HEWLETT-PACKARD COMPANY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  17 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  18 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19 .\" SOFTWARE.
  20 .\"
  21 .\" Except as contained in this notice, the name of the Hewlett-Packard Company shall not
  22 .\" be used in advertising or otherwise to promote the sale, use or other
  23 .\" dealing in this Software without prior written authorization from the
  24 .\" Hewlett-Packard Company.
  25 .\"
  26 .TH XdbeGetVisualInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  27 .SH NAME
  28 XdbeGetVisualInfo - Get dbe Visual Informations
  29 .SH SYNOPSIS
  30 \&#include <X11/extensions/Xdbe.h>
  31
  32 XdbeScreenVisualInfo *XdbeGetVisualInfo(
  33     Display  *dpy,
  34     Drawable *screen_specifiers,
  35     int      *num_screens)
  36 .SH DESCRIPTION
  37 This function returns information about which visuals support double
  38 buffering.  The argument
  39 .I num_screens
  40 specifies how many elements there are
  41 in the
  42 .I screen_specifiers
  43 list.  Each drawable in
  44 .I screen_specifiers
  45 designates a
  46 screen for which the supported visuals are being requested.  If
  47 .I num_screens
  48 is zero, information for all screens is requested.  In this case, upon return
  49 from this function,
  50 .I num_screens
  51 will be set to the number of screens that were
  52 found.  If an error occurs, this function returns NULL, else it returns a
  53 pointer to a list of
  54 .I XdbeScreenVisualInfo
  55 structures of length
  56 .I num_screens.
  57 The nth
  58 element in the returned list corresponds to the nth drawable in the
  59 .I screen_specifiers
  60 list, unless
  61 .I num_screens
  62 was passed in with the value zero,
  63 in which case the nth element in the returned list corresponds to the nth screen
  64 of the server, starting with screen zero.  The
  65 .I XdbeScreenVisualInfo
  66 structure has the following fields:
  67
  68      int            count
  69      XdbeVisualInfo *visinfo
  70
  71 .I count
  72 specifies the number of items in
  73 .I visinfo.
  74 .I visinfo
  75 specifies a list of visuals, depths, and performance hints for this screen.
  76
  77 The
  78 .I XdbeVisualInfo
  79 structure has the following fields:
  80
  81      VisualID visual
  82      int      depth
  83      int      perflevel
  84
  85 .I visual
  86 specifies one visual ID that supports double-buffering.
  87 .I depth
  88 specifies the depth of the visual.
  89 .I perflevel
  90 is a performance hint.
  91
  92 The only operation defined on a
  93 .I perflevel
  94 is comparison to a
  95 .I perflevel
  96 of another visual on the same screen.  The visual having the higher
  97 .I perflevel
  98 is likely to have better double-buffering graphics performance than the visual
  99 having the lower
 100 .I perflevel.
 101 Nothing can be deduced from the following: the magnitude of the difference
 102 of two
 103 .I perflevels,
 104 a
 105 .I perflevel
 106 value in isolation, or comparing
 107 .I perflevels
 108 from different servers.
 109
 110 .SH ERRORS
 111 .IP BadDrawable
 112 One or more values passed in
 113 .I screen_specifiers
 114 is not a valid drawable.
 115 .SH SEE ALSO
 116 DBE,
 117 .I XdbeAllocateBackBufferName(),
 118 .I XdbeBeginIdiom(),
 119 .I XdbeDeallocateBackBufferName(),
 120 .I XdbeEndIdiom(),
 121 .I XdbeFreeVisualInfo(),
 122 .I XdbeGetBackBufferAttributes(),
 123 .I XdbeQueryExtension(),
 124 .I XdbeSwapBuffers().
 125