Git init
[framework/uifw/xorg/lib/libxext.git] / man / XdbeAllocateBackBufferName.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 XdbeAllocateBackBufferName __libmansuffix__ __xorgversion__ "X FUNCTIONS"
27 .SH NAME
28 XdbeAllocateBackBufferName - allocates a DBE buffer.
29 .SH SYNOPSIS
30 \&#include <X11/extensions/Xdbe.h>
31
32 XdbeBackBuffer XdbeAllocateBackBufferName(
33     Display        *dpy,
34     Window         window, 
35     XdbeSwapAction swap_action)
36 .SH DESCRIPTION
37 This function returns a drawable ID used to refer to the back buffer of the 
38 specified window.  The swap_action is a hint to indicate the swap action that 
39 will likely be used in subsequent calls to
40 .B XdbeSwapBuffers().
41 The actual swap
42 action used in calls to
43 .B XdbeSwapBuffers()
44 does not have to be the same as the 
45 swap_action passed to this function, though clients are encouraged to provide
46 accurate information whenever possible.
47 .SH ERRORS
48 .IP BadAlloc
49 .IP BadIDChoice
50 .IP BadMatch
51 The specified window is not an InputOutput window or its visual does not
52 support DBE.
53 .IP BadValue
54 An invalid swap action was specified.
55 .IP BadWindow
56 An invalid window was specified.
57 .SH SEE ALSO
58 DBE,
59 .I XdbeBeginIdiom(),
60 .I XdbeDeallocateBackBufferName(),
61 .I XdbeEndIdiom(),
62 .I XdbeFreeVisualInfo(),
63 .I XdbeGetBackBufferAttributes(),
64 .I XdbeGetVisualInfo(),
65 .I XdbeQueryExtension(),
66 .I XdbeSwapBuffers().
67