1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glXCreateGLXPixmap">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glXCreateGLXPixmap
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glXCreateGLXPixmap
</refname>
17 <refpurpose>create an off-screen GLX rendering area
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>GLXPixmap
<function>glXCreateGLXPixmap
</function></funcdef>
23 <paramdef>Display *
<parameter>dpy
</parameter></paramdef>
24 <paramdef>XVisualInfo *
<parameter>vis
</parameter></paramdef>
25 <paramdef>Pixmap
<parameter>pixmap
</parameter></paramdef>
29 <!-- eqn: ignoring delim $$ -->
30 <refsect1 id=
"parameters"><title>Parameters
</title>
33 <term><parameter>dpy
</parameter></term>
36 Specifies the connection to the X server.
41 <term><parameter>vis
</parameter></term>
44 Specifies the visual that defines the structure of the rendering area.
45 It is a pointer to an
<constant>XVisualInfo
</constant> structure,
46 not a visual ID or a pointer to a
<constant>Visual
</constant>.
51 <term><parameter>pixmap
</parameter></term>
54 Specifies the X pixmap that will be used as the front left color buffer
55 of the off-screen rendering area.
61 <refsect1 id=
"description"><title>Description
</title>
63 <function>glXCreateGLXPixmap
</function> creates an off-screen rendering area and returns its XID.
64 Any GLX rendering context that was created with respect to
<parameter>vis
</parameter>
65 can be used to render into this off-screen area.
66 Use
<citerefentry><refentrytitle>glXMakeCurrent
</refentrytitle></citerefentry> to associate the rendering area with a GLX
70 The X pixmap identified by
<parameter>pixmap
</parameter> is used as the front left buffer of the
71 resulting off-screen rendering area.
72 All other buffers specified by
<parameter>vis
</parameter>,
73 including color buffers other than the front left buffer,
74 are created without externally visible names.
75 GLX pixmaps with double-buffering are supported.
76 However,
<citerefentry><refentrytitle>glXSwapBuffers
</refentrytitle></citerefentry> is ignored by these pixmaps.
79 Some implementations may not support GLX pixmaps with direct rendering
83 <refsect1 id=
"notes"><title>Notes
</title>
85 <constant>XVisualInfo
</constant> is defined in
<emphasis>Xutil.h.
</emphasis>
86 It is a structure that includes
<emphasis>visual
</emphasis>,
<emphasis>visualID
</emphasis>,
<emphasis>screen
</emphasis>, and
87 <emphasis>depth
</emphasis> elements.
90 <refsect1 id=
"errors"><title>Errors
</title>
92 <constant>BadMatch
</constant> is generated if the depth of
<parameter>pixmap
</parameter> does not match
93 the depth value reported by core X11 for
<parameter>vis
</parameter>,
94 or if
<parameter>pixmap
</parameter> was not created with respect to the same screen as
<parameter>vis
</parameter>.
97 <constant>BadValue
</constant> is generated
98 if
<parameter>vis
</parameter> is not a valid XVisualInfo pointer (for example, if a
99 particular GLX implementation does not support this visual).
102 <constant>BadPixmap
</constant> is generated if
<parameter>pixmap
</parameter> is not a valid pixmap.
105 <constant>BadAlloc
</constant> is generated if the server cannot allocate the GLX
109 <refsect1 id=
"seealso"><title>See Also
</title>
111 <citerefentry><refentrytitle>glXCreateContext
</refentrytitle></citerefentry>,
112 <citerefentry><refentrytitle>glXCreatePixmap
</refentrytitle></citerefentry>,
113 <citerefentry><refentrytitle>glXDestroyGLXPixmap
</refentrytitle></citerefentry>,
114 <citerefentry><refentrytitle>glXIsDirect
</refentrytitle></citerefentry>,
115 <citerefentry><refentrytitle>glXMakeCurrent
</refentrytitle></citerefentry>
118 <refsect1 id=
"Copyright"><title>Copyright
</title>
120 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
121 Silicon Graphics, Inc. This document is licensed under the SGI
122 Free Software B License. For details, see
123 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.