man-pages/man3/XdbeSwapBuffers.3.html
2021-03-31 01:06:50 +01:00

128 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XdbeSwapBuffers</TITLE>
</HEAD><BODY>
<H1>XdbeSwapBuffers</H1>
Section: X FUNCTIONS (3)<BR>Updated: libXext 1.3.4<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
XdbeSwapBuffers - swaps front and back DBE buffers.
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
#include &lt;<A HREF="file:///usr/include/X11/extensions/Xdbe.h">X11/extensions/Xdbe.h</A>&gt;
<P>
Status XdbeSwapBuffers(
<BR>&nbsp;&nbsp;&nbsp;&nbsp;Display&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*dpy,
<BR>&nbsp;&nbsp;&nbsp;&nbsp;XdbeSwapInfo&nbsp;*swap_info,
<BR>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;num_windows)
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
This function swaps the front and back buffers for a list of windows. The
argument
<I>num_windows</I>
specifies how many windows are to have their buffers
swapped; it is the number of elements in the
<I>swap_info</I>
array. The argument
<I>swap_info</I>
specifies the information needed per window to do the swap.
<P>
The
<I>XdbeSwapInfo</I>
structure has the following fields:
<P>
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Window&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;swap_window
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XdbeSwapAction&nbsp;&nbsp;&nbsp;&nbsp;swap_action
<P>
<I>swap_window</I>
specifies the window for which to swap buffers.
<I>swap_action</I>
specifies the swap action to use for this
<I>swap_window.</I>
<P>
<I>swap_action</I>
determines what will happen to the new back buffer of the
<I>swap_window</I>
it is paired with in the list in addition to making the old back buffer
become visible. The defined actions are as follows:
<P>
<DL COMPACT>
<DT id="1">XdbeUndefined<DD>
The contents of the new back buffer become undefined. This may be the most
efficient action since it allows the implementation to discard the contents of
the buffer if it needs to.
<DT id="2">XdbeBackground<DD>
The unobscured region of the new back buffer will be tiled with the
window background. The background action allows devices to use a fast clear
capability during a swap.
<DT id="3">XdbeUntouched<DD>
The unobscured region of the new back buffer will be unmodified by the swap.
<DT id="4">XdbeCopied<DD>
The unobscured region of the new back buffer will be the contents of the old
back buffer
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="5">BadMatch<DD>
A non-double-buffered window was specified or a window was specified twice.
<DT id="6">BadWindow<DD>
An invalid window was specified.
<DT id="7">BadValue<DD>
An invalid swap action was specified.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
DBE,
<I>XdbeAllocateBackBufferName(),</I>
<I>XdbeBeginIdiom(),</I>
<I>XdbeDeallocateBackBufferName(),</I>
<I>XdbeEndIdiom(),</I>
<I>XdbeFreeVisualInfo(),</I>
<I>XdbeGetBackBufferAttributes(),</I>
<I>XdbeGetVisualInfo(),</I>
<I>XdbeQueryExtension().</I>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAE">ERRORS</A><DD>
<DT id="12"><A HREF="#lbAF">SEE ALSO</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:00 GMT, March 31, 2021
</BODY>
</HTML>