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>glXQueryDrawable</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glXQueryDrawable"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glXQueryDrawable — returns an attribute assoicated with a GLX drawable</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">int <b class="fsfunc">glXQueryDrawable</b>(</code></td><td>Display * </td><td><var class="pdparam">dpy</var>, </td></tr><tr><td> </td><td>GLXDrawable </td><td><var class="pdparam">draw</var>, </td></tr><tr><td> </td><td>int </td><td><var class="pdparam">attribute</var>, </td></tr><tr><td> </td><td>unsigned int * </td><td><var class="pdparam">value</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>draw</code></em></span></dt><dd><p> | |
6 | Specifies the GLX drawable to be queried. | |
7 | </p></dd><dt><span class="term"><em class="parameter"><code>attribute</code></em></span></dt><dd><p> | |
8 | Specifies the attribute to be returned. Must be one of | |
9 | <code class="constant">GLX_WIDTH</code>, | |
10 | <code class="constant">GLX_HEIGHT</code>, | |
11 | <code class="constant">GLX_PRESERVED_CONTENTS</code>, | |
12 | <code class="constant">GLX_LARGEST_PBUFFER</code>, or | |
13 | <code class="constant">GLX_FBCONFIG_ID</code>. | |
14 | </p></dd><dt><span class="term"><em class="parameter"><code>value</code></em></span></dt><dd><p> | |
15 | Contains the return value for | |
16 | <em class="parameter"><code>attribute</code></em>. | |
17 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
18 | <code class="function">glXQueryDrawable</code> sets | |
19 | <em class="parameter"><code>value</code></em> to the value of | |
20 | <em class="parameter"><code>attribute</code></em> with respect to the GLXDrawable | |
21 | <em class="parameter"><code>draw</code></em>. | |
22 | </p><p> | |
23 | <em class="parameter"><code>attribute</code></em> may be one of the following: | |
24 | </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GLX_WIDTH</code></span></dt><dd><p> | |
25 | Returns the width of <em class="parameter"><code>ctx</code></em>. | |
26 | </p></dd><dt><span class="term"><code class="constant">GLX_HEIGHT</code></span></dt><dd><p> | |
27 | Returns the height of <em class="parameter"><code>ctx</code></em>. | |
28 | </p></dd><dt><span class="term"><code class="constant">GLX_PRESERVED_CONTENTS</code></span></dt><dd><p> | |
29 | Returns <code class="constant">True</code> if the contents | |
30 | of a GLXPbuffer are preserved when a resource | |
31 | conflict occurs; <code class="constant">False</code> otherwise. | |
32 | </p></dd><dt><span class="term"><code class="constant">GLX_LARGEST_PBUFFER</code></span></dt><dd><p> | |
33 | Returns the value set when | |
34 | <code class="function">glXCreatePbuffer</code> was called to | |
35 | create the GLXPbuffer. If | |
36 | <code class="constant">False</code> is returned, then the | |
37 | call to <code class="function">glXCreatePbuffer</code> will | |
38 | fail to create a GLXPbuffer if the requested size | |
39 | is larger than the implementation maximum or | |
40 | available resources. If <code class="constant">True</code> | |
41 | is returned, a GLXPbuffer of the maximum availble | |
42 | size (if less than the requested width and height) | |
43 | is created. | |
44 | </p></dd><dt><span class="term"><code class="constant">GLX_FBCONFIG_ID</code></span></dt><dd><p> | |
45 | Returns the XID for <em class="parameter"><code>draw</code></em>. | |
46 | </p></dd></dl></div><p> | |
47 | If <em class="parameter"><code>draw</code></em> is a GLXWindow or GLXPixmap and | |
48 | <em class="parameter"><code>attribute</code></em> is set to | |
49 | <code class="constant">GLX_PRESERVED_CONTENTS</code> or | |
50 | <code class="constant">GLX_LARGETST_PBUFFER</code>, the contents of | |
51 | <em class="parameter"><code>value</code></em> are undefined. If | |
52 | <em class="parameter"><code>attribute</code></em> is not one of the attributes | |
53 | listed above, the contents of <em class="parameter"><code>value</code></em> are | |
54 | unedfined. | |
55 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
56 | A <code class="constant">GLXBadDrawable</code> is generated if | |
57 | <em class="parameter"><code>draw</code></em> is not a valid GLXDrawable. | |
58 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
59 | <a class="citerefentry" href="glXCreateWindow.xml"><span class="citerefentry"><span class="refentrytitle">glXCreateWindow</span></span></a>, | |
60 | <a class="citerefentry" href="glXCreatePixmap.xml"><span class="citerefentry"><span class="refentrytitle">glXCreatePixmap</span></span></a>, | |
61 | <a class="citerefentry" href="glXCreatePbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glXCreatePbuffer</span></span></a>, | |
62 | <a class="citerefentry" href="glXGetFBConfigAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glXGetFBConfigAttrib</span></span></a>, | |
63 | <a class="citerefentry" href="glXChooseFBConfig.xml"><span class="citerefentry"><span class="refentrytitle">glXChooseFBConfig</span></span></a> | |
64 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
65 | Copyright <span class="trademark"></span>© 1991-2006 | |
66 | Silicon Graphics, Inc. This document is licensed under the SGI | |
67 | Free Software B License. For details, see | |
68 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
69 | </p></div></div></body></html> |