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="glXCreateWindow"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glXCreateWindow</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glXCreateWindow</refname> | |
17 | <refpurpose>create an on-screen rendering area</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLXWindow <function>glXCreateWindow</function></funcdef> | |
23 | <paramdef>Display * <parameter>dpy</parameter></paramdef> | |
24 | <paramdef>GLXFBConfig <parameter>config</parameter></paramdef> | |
25 | <paramdef>Window <parameter>win</parameter></paramdef> | |
26 | <paramdef>const int * <parameter>attrib_list</parameter></paramdef> | |
27 | </funcprototype> | |
28 | </funcsynopsis> | |
29 | </refsynopsisdiv> | |
30 | <!-- eqn: ignoring delim $$ --> | |
31 | <refsect1 id="parameters"><title>Parameters</title> | |
32 | <variablelist> | |
33 | <varlistentry> | |
34 | <term><parameter>dpy</parameter></term> | |
35 | <listitem> | |
36 | <para> | |
37 | Specifies the connection to the X server. | |
38 | </para> | |
39 | </listitem> | |
40 | </varlistentry> | |
41 | <varlistentry> | |
42 | <term><parameter>config</parameter></term> | |
43 | <listitem> | |
44 | <para> | |
45 | Specifies a GLXFBConfig structure with the desired attributes for the | |
46 | window. | |
47 | </para> | |
48 | </listitem> | |
49 | </varlistentry> | |
50 | <varlistentry> | |
51 | <term><parameter>win</parameter></term> | |
52 | <listitem> | |
53 | <para> | |
54 | Specifies the X window to be used as the rendering area. | |
55 | </para> | |
56 | </listitem> | |
57 | </varlistentry> | |
58 | <varlistentry> | |
59 | <term><parameter>attrib_list</parameter></term> | |
60 | <listitem> | |
61 | <para> | |
62 | Currently unused. This must be set to <constant>NULL</constant> or be an empty list | |
63 | (i.e., one in which the first element is <constant>None</constant>). | |
64 | </para> | |
65 | </listitem> | |
66 | </varlistentry> | |
67 | </variablelist> | |
68 | </refsect1> | |
69 | <refsect1 id="description"><title>Description</title> | |
70 | <para> | |
71 | <function>glXCreateWindow</function> creates an on-screen rendering area from an existing X window | |
72 | that was created with a visual matching <parameter>config</parameter>. The XID of the | |
73 | GLXWindow is returned. | |
74 | Any GLX rendering context that was created with respect to <parameter>config</parameter> | |
75 | can be used to render into this window. | |
76 | Use <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry> to associate the rendering area with a GLX | |
77 | rendering context. | |
78 | </para> | |
79 | </refsect1> | |
80 | <refsect1 id="notes"><title>Notes</title> | |
81 | <para> | |
82 | <function>glXCreateWindow</function> is available only if the GLX version is 1.3 or greater. | |
83 | </para> | |
84 | <para> | |
85 | If the GLX version is 1.1 or 1.0, the GL version must be 1.0. | |
86 | If the GLX version is 1.2, then the GL version must be 1.1. | |
87 | If the GLX version is 1.3, then the GL version must be 1.2. | |
88 | </para> | |
89 | </refsect1> | |
90 | <refsect1 id="errors"><title>Errors</title> | |
91 | <para> | |
92 | <constant>BadMatch</constant> is generated if <parameter>win</parameter> was not created with a visual | |
93 | that corresponds to <parameter>config</parameter>. | |
94 | </para> | |
95 | <para> | |
96 | <constant>BadMatch</constant> is generated if <parameter>config</parameter> does not support rendering to | |
97 | windows (i.e., <constant>GLX_DRAWABLE_TYPE</constant> does not contain | |
98 | <constant>GLX_WINDOW_BIT</constant>). | |
99 | </para> | |
100 | <para> | |
101 | <constant>BadWindow</constant> is generated if <parameter>win</parameter> is not a valid pixmap XID. | |
102 | </para> | |
103 | <para> | |
104 | <constant>BadAlloc</constant> is generated if there is already a GLXFBConfig | |
105 | associated with <parameter>win</parameter>. | |
106 | </para> | |
107 | <para> | |
108 | <constant>BadAlloc</constant> is generated if the X server cannot allocate a new | |
109 | GLX window. | |
110 | </para> | |
111 | <para> | |
112 | <constant>GLXBadFBConfig</constant> is generated if <parameter>config</parameter> is not a valid | |
113 | GLXFBConfig. | |
114 | </para> | |
115 | <para> | |
116 | </para> | |
117 | </refsect1> | |
118 | <refsect1 id="seealso"><title>See Also</title> | |
119 | <para> | |
120 | <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>, | |
121 | <citerefentry><refentrytitle>glXDestroyPixmap</refentrytitle></citerefentry>, | |
122 | <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry> | |
123 | </para> | |
124 | </refsect1> | |
125 | <refsect1 id="Copyright"><title>Copyright</title> | |
126 | <para> | |
127 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
128 | Silicon Graphics, Inc. This document is licensed under the SGI | |
129 | Free Software B License. For details, see | |
130 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
131 | </para> | |
132 | </refsect1> | |
133 | </refentry> |