upstream-man-pages/man2/xhtml/glXCreateWindow.xml

   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>glXCreateWindow</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glXCreateWindow"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glXCreateWindow — create an on-screen 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">GLXWindow <b class="fsfunc">glXCreateWindow</b>(</code></td><td>Display *  </td><td><var class="pdparam">dpy</var>, </td></tr><tr><td> </td><td>GLXFBConfig  </td><td><var class="pdparam">config</var>, </td></tr><tr><td> </td><td>Window  </td><td><var class="pdparam">win</var>, </td></tr><tr><td> </td><td>const int *  </td><td><var class="pdparam">attrib_list</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>config</code></em></span></dt><dd><p>
   6                     Specifies a GLXFBConfig structure with the desired attributes for the
   7                     window.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>win</code></em></span></dt><dd><p>
   9                     Specifies the X window to be used as the rendering area.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>attrib_list</code></em></span></dt><dd><p>
  11                     Currently unused. This must be set to <code class="constant">NULL</code> or be an empty list
  12                     (i.e., one in which the first element is <code class="constant">None</code>).
  13                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  14             <code class="function">glXCreateWindow</code> creates an on-screen rendering area from an existing X window
  15             that was created with a visual matching <em class="parameter"><code>config</code></em>. The XID of the
  16             GLXWindow is returned.
  17             Any GLX rendering context that was created with respect to <em class="parameter"><code>config</code></em>
  18             can be used to render into this window.
  19             Use <a class="citerefentry" href="glXMakeContextCurrent.xml"><span class="citerefentry"><span class="refentrytitle">glXMakeContextCurrent</span></span></a> to associate the rendering area with a GLX
  20             rendering context.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  22             <code class="function">glXCreateWindow</code> is available only if the GLX version is 1.3 or greater.
  23         </p><p>
  24             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  25             If the GLX version is 1.2, then the GL version must be 1.1.
  26             If the GLX version is 1.3, then the GL version must be 1.2.
  27         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  28             <code class="constant">BadMatch</code> is generated if <em class="parameter"><code>win</code></em> was not created with a visual
  29             that corresponds to <em class="parameter"><code>config</code></em>.
  30         </p><p>
  31             <code class="constant">BadMatch</code> is generated if <em class="parameter"><code>config</code></em> does not support rendering to
  32             windows (i.e., <code class="constant">GLX_DRAWABLE_TYPE</code> does not contain
  33             <code class="constant">GLX_WINDOW_BIT</code>).
  34         </p><p>
  35             <code class="constant">BadWindow</code> is generated if <em class="parameter"><code>win</code></em> is not a valid pixmap XID.
  36         </p><p>
  37             <code class="constant">BadAlloc</code> is generated if there is already a GLXFBConfig
  38             associated with <em class="parameter"><code>win</code></em>.
  39         </p><p>
  40             <code class="constant">BadAlloc</code> is generated if the X server cannot allocate a new
  41             GLX window.
  42         </p><p>
  43             <code class="constant">GLXBadFBConfig</code> is generated if <em class="parameter"><code>config</code></em> is not a valid
  44             GLXFBConfig.
  45         </p><p>
  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="glXChooseFBConfig.xml"><span class="citerefentry"><span class="refentrytitle">glXChooseFBConfig</span></span></a>,
  48             <a class="citerefentry" href="glXDestroyPixmap.xml"><span class="citerefentry"><span class="refentrytitle">glXDestroyPixmap</span></span></a>,
  49             <a class="citerefentry" href="glXMakeContextCurrent.xml"><span class="citerefentry"><span class="refentrytitle">glXMakeContextCurrent</span></span></a>
  50         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  51             Copyright <span class="trademark"></span>© 1991-2006
  52             Silicon Graphics, Inc. This document is licensed under the SGI
  53             Free Software B License. For details, see
  54             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  55         </p></div></div></body></html>