b30f2c2d95cf249ef217aae9c731e3c35e4620d0
[framework/uifw/xorg/lib/libxext.git] / man / XdbeGetBackBufferAttributes.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 XdbeGetBackBufferAttributes __libmansuffix__ __xorgversion__ "X FUNCTIONS"
27 .SH NAME
28 XdbeGetBackBufferAttributes - returns attributes of a DBE buffer.
29 .SH SYNOPSIS
30 \&#include <X11/extensions/Xdbe.h>
31
32 XdbeBackBufferAttributes *XdbeGetBackBufferAttributes(
33     Display        *dpy,
34     XdbeBackBuffer buffer)
35 .SH DESCRIPTION
36 This function returns the attributes associated with the specified buffer.
37
38 The
39 .I XdbeBackBufferAttributes
40 structure has the following fields:
41
42 .RS
43 Window     window     window that buffer belongs to
44 .RE
45     
46 If buffer is not a valid
47 .I XdbeBackBuffer,
48 window returns None.
49
50 The returned
51 .I XdbeBackBufferAttributes
52 structure can be freed with the 
53 Xlib function
54 .B Xfree().
55 .SH SEE ALSO
56 DBE,
57 .I XdbeAllocateBackBufferName(),
58 .I XdbeBeginIdiom(),
59 .I XdbeDeallocateBackBufferName(),
60 .I XdbeEndIdiom(),
61 .I XdbeFreeVisualInfo(),
62 .I XdbeGetVisualInfo(),
63 .I XdbeQueryExtension(),
64 .I XdbeSwapBuffers().
65