Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
2 | <!-- saved from url=(0013)about:internet --> | |
3 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glXCreateGLXPixmap</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glXCreateGLXPixmap"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glXCreateGLXPixmap — create an off-screen GLX rendering area</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">GLXPixmap <b class="fsfunc">glXCreateGLXPixmap</b>(</code></td><td>Display * </td><td><var class="pdparam">dpy</var>, </td></tr><tr><td> </td><td>XVisualInfo * </td><td><var class="pdparam">vis</var>, </td></tr><tr><td> </td><td>Pixmap </td><td><var class="pdparam">pixmap</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>dpy</code></em></span></dt><dd><p> | |
4 | Specifies the connection to the X server. | |
5 | </p></dd><dt><span class="term"><em class="parameter"><code>vis</code></em></span></dt><dd><p> | |
6 | Specifies the visual that defines the structure of the rendering area. | |
7 | It is a pointer to an <code class="constant">XVisualInfo</code> structure, | |
8 | not a visual ID or a pointer to a <code class="constant">Visual</code>. | |
9 | </p></dd><dt><span class="term"><em class="parameter"><code>pixmap</code></em></span></dt><dd><p> | |
10 | Specifies the X pixmap that will be used as the front left color buffer | |
11 | of the off-screen rendering area. | |
12 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
13 | <code class="function">glXCreateGLXPixmap</code> creates an off-screen rendering area and returns its XID. | |
14 | Any GLX rendering context that was created with respect to <em class="parameter"><code>vis</code></em> | |
15 | can be used to render into this off-screen area. | |
16 | Use <a class="citerefentry" href="glXMakeCurrent.xml"><span class="citerefentry"><span class="refentrytitle">glXMakeCurrent</span></span></a> to associate the rendering area with a GLX | |
17 | rendering context. | |
18 | </p><p> | |
19 | The X pixmap identified by <em class="parameter"><code>pixmap</code></em> is used as the front left buffer of the | |
20 | resulting off-screen rendering area. | |
21 | All other buffers specified by <em class="parameter"><code>vis</code></em>, | |
22 | including color buffers other than the front left buffer, | |
23 | are created without externally visible names. | |
24 | GLX pixmaps with double-buffering are supported. | |
25 | However, <a class="citerefentry" href="glXSwapBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glXSwapBuffers</span></span></a> is ignored by these pixmaps. | |
26 | </p><p> | |
27 | Some implementations may not support GLX pixmaps with direct rendering | |
28 | contexts. | |
29 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
30 | <code class="constant">XVisualInfo</code> is defined in <span class="emphasis"><em>Xutil.h.</em></span> | |
31 | It is a structure that includes <span class="emphasis"><em>visual</em></span>, <span class="emphasis"><em>visualID</em></span>, <span class="emphasis"><em>screen</em></span>, and | |
32 | <span class="emphasis"><em>depth</em></span> elements. | |
33 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
34 | <code class="constant">BadMatch</code> is generated if the depth of <em class="parameter"><code>pixmap</code></em> does not match | |
35 | the depth value reported by core X11 for <em class="parameter"><code>vis</code></em>, | |
36 | or if <em class="parameter"><code>pixmap</code></em> was not created with respect to the same screen as <em class="parameter"><code>vis</code></em>. | |
37 | </p><p> | |
38 | <code class="constant">BadValue</code> is generated | |
39 | if <em class="parameter"><code>vis</code></em> is not a valid XVisualInfo pointer (for example, if a | |
40 | particular GLX implementation does not support this visual). | |
41 | </p><p> | |
42 | <code class="constant">BadPixmap</code> is generated if <em class="parameter"><code>pixmap</code></em> is not a valid pixmap. | |
43 | </p><p> | |
44 | <code class="constant">BadAlloc</code> is generated if the server cannot allocate the GLX | |
45 | pixmap. | |
46 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
47 | <a class="citerefentry" href="glXCreateContext.xml"><span class="citerefentry"><span class="refentrytitle">glXCreateContext</span></span></a>, | |
48 | <a class="citerefentry" href="glXCreatePixmap.xml"><span class="citerefentry"><span class="refentrytitle">glXCreatePixmap</span></span></a>, | |
49 | <a class="citerefentry" href="glXDestroyGLXPixmap.xml"><span class="citerefentry"><span class="refentrytitle">glXDestroyGLXPixmap</span></span></a>, | |
50 | <a class="citerefentry" href="glXIsDirect.xml"><span class="citerefentry"><span class="refentrytitle">glXIsDirect</span></span></a>, | |
51 | <a class="citerefentry" href="glXMakeCurrent.xml"><span class="citerefentry"><span class="refentrytitle">glXMakeCurrent</span></span></a> | |
52 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
53 | Copyright <span class="trademark"></span>© 1991-2006 | |
54 | Silicon Graphics, Inc. This document is licensed under the SGI | |
55 | Free Software B License. For details, see | |
56 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
57 | </p></div></div></body></html> |