man/XdbeSwapBuffers.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 XdbeSwapBuffers __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  27 .SH NAME
  28 XdbeSwapBuffers - swaps front and back DBE buffers.
  29 .SH SYNOPSIS
  30 \&#include <X11/extensions/Xdbe.h>
  31
  32 Status XdbeSwapBuffers(
  33     Display      *dpy,
  34     XdbeSwapInfo *swap_info,
  35     int          num_windows)
  36 .SH DESCRIPTION
  37 This function swaps the front and back buffers for a list of windows.  The
  38 argument
  39 .I num_windows
  40 specifies how many windows are to have their buffers
  41 swapped; it is the number of elements in the
  42 .I swap_info
  43 array.  The argument
  44 .I swap_info
  45 specifies the information needed per window to do the swap.
  46
  47 The
  48 .I XdbeSwapInfo
  49 structure has the following fields:
  50
  51      Window            swap_window
  52      XdbeSwapAction    swap_action
  53
  54 .I swap_window
  55 specifies the window for which to swap buffers.
  56 .I swap_action
  57 specifies the swap action to use for this
  58 .I swap_window.
  59
  60 .I swap_action
  61 determines what will happen to the new back buffer of the
  62 .I swap_window
  63 it is paired with in the list in addition to making the old back buffer
  64 become visible.  The defined actions are as follows:
  65
  66 .IP XdbeUndefined
  67 The contents of the new back buffer become undefined.  This may be the most
  68 efficient action since it allows the implementation to discard the contents of
  69 the buffer if it needs to.
  70 .IP XdbeBackground
  71 The unobscured region of the new back buffer will be tiled with the
  72 window background.  The background action allows devices to use a fast clear
  73 capability during a swap.
  74 .IP XdbeUntouched
  75 The unobscured region of the new back buffer will be unmodified by the swap.
  76 .IP XdbeCopied
  77 The unobscured region of the new back buffer will be the contents of the old
  78 back buffer
  79 .SH ERRORS
  80 .IP BadMatch
  81 A non-double-buffered window was specified or a window was specified twice.
  82 .IP BadWindow
  83 An invalid window was specified.
  84 .IP BadValue
  85 An invalid swap action was specified.
  86 .SH SEE ALSO
  87 DBE,
  88 .I XdbeAllocateBackBufferName(),
  89 .I XdbeBeginIdiom(),
  90 .I XdbeDeallocateBackBufferName(),
  91 .I XdbeEndIdiom(),
  92 .I XdbeFreeVisualInfo(),
  93 .I XdbeGetBackBufferAttributes(),
  94 .I XdbeGetVisualInfo(),
  95 .I XdbeQueryExtension().
  96