Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glXCreateGLXPixmap</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glXCreateGLXPixmap</refname> | |
17 | <refpurpose>create an off-screen GLX rendering area</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
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> | |
26 | </funcprototype> | |
27 | </funcsynopsis> | |
28 | </refsynopsisdiv> | |
29 | <!-- eqn: ignoring delim $$ --> | |
30 | <refsect1 id="parameters"><title>Parameters</title> | |
31 | <variablelist> | |
32 | <varlistentry> | |
33 | <term><parameter>dpy</parameter></term> | |
34 | <listitem> | |
35 | <para> | |
36 | Specifies the connection to the X server. | |
37 | </para> | |
38 | </listitem> | |
39 | </varlistentry> | |
40 | <varlistentry> | |
41 | <term><parameter>vis</parameter></term> | |
42 | <listitem> | |
43 | <para> | |
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>. | |
47 | </para> | |
48 | </listitem> | |
49 | </varlistentry> | |
50 | <varlistentry> | |
51 | <term><parameter>pixmap</parameter></term> | |
52 | <listitem> | |
53 | <para> | |
54 | Specifies the X pixmap that will be used as the front left color buffer | |
55 | of the off-screen rendering area. | |
56 | </para> | |
57 | </listitem> | |
58 | </varlistentry> | |
59 | </variablelist> | |
60 | </refsect1> | |
61 | <refsect1 id="description"><title>Description</title> | |
62 | <para> | |
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 | |
67 | rendering context. | |
68 | </para> | |
69 | <para> | |
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. | |
77 | </para> | |
78 | <para> | |
79 | Some implementations may not support GLX pixmaps with direct rendering | |
80 | contexts. | |
81 | </para> | |
82 | </refsect1> | |
83 | <refsect1 id="notes"><title>Notes</title> | |
84 | <para> | |
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. | |
88 | </para> | |
89 | </refsect1> | |
90 | <refsect1 id="errors"><title>Errors</title> | |
91 | <para> | |
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>. | |
95 | </para> | |
96 | <para> | |
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). | |
100 | </para> | |
101 | <para> | |
102 | <constant>BadPixmap</constant> is generated if <parameter>pixmap</parameter> is not a valid pixmap. | |
103 | </para> | |
104 | <para> | |
105 | <constant>BadAlloc</constant> is generated if the server cannot allocate the GLX | |
106 | pixmap. | |
107 | </para> | |
108 | </refsect1> | |
109 | <refsect1 id="seealso"><title>See Also</title> | |
110 | <para> | |
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> | |
116 | </para> | |
117 | </refsect1> | |
118 | <refsect1 id="Copyright"><title>Copyright</title> | |
119 | <para> | |
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>. | |
124 | </para> | |
125 | </refsect1> | |
126 | </refentry> |