rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / xhtml / glXQueryContext.xml
CommitLineData
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>glXQueryContext</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glXQueryContext"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glXQueryContext — query context information</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">glXQueryContext</b>(</code></td><td>Display *  </td><td><var class="pdparam">dpy</var>, </td></tr><tr><td> </td><td>GLXContext  </td><td><var class="pdparam">ctx</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">attribute</var>, </td></tr><tr><td> </td><td>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>ctx</code></em></span></dt><dd><p>
6 Specifies a GLX rendering context.
7 </p></dd><dt><span class="term"><em class="parameter"><code>attribute</code></em></span></dt><dd><p>
8 Specifies that a context parameter should be retrieved. Must be one of
9 <code class="constant">GLX_FBCONFIG_ID</code>, <code class="constant">GLX_RENDER_TYPE</code>, or <code class="constant">GLX_SCREEN</code>.
10 </p></dd><dt><span class="term"><em class="parameter"><code>value</code></em></span></dt><dd><p>
11 Contains the return value for <em class="parameter"><code>attribute</code></em>.
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">glXQueryContext</code> sets <em class="parameter"><code>value</code></em> to the value of <em class="parameter"><code>attribute</code></em> with respect to <em class="parameter"><code>ctx</code></em>.
14 <em class="parameter"><code>attribute</code></em> may be one of the following:
15 </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GLX_FBCONFIG_ID</code></span></dt><dd><p>
16 Returns the XID of the GLXFBConfig associated with <em class="parameter"><code>ctx</code></em>.
17 </p></dd><dt><span class="term"><code class="constant">GLX_RENDER_TYPE</code></span></dt><dd><p>
18 Returns the rendering type supported by <em class="parameter"><code>ctx</code></em>.
19 </p></dd><dt><span class="term"><code class="constant">GLX_SCREEN</code></span></dt><dd><p>
20 Returns the screen number associated with <em class="parameter"><code>ctx</code></em>.
21 </p></dd></dl></div><p>
22 <code class="constant">Success</code> is returned unless <em class="parameter"><code>attribute</code></em> is not a valid GLX
23 context attribute, in which case <code class="constant">GLX_BAD_ATTRIBUTE</code> is returned.
24 </p><p>
25 This call may cause a round-trip to the server.
26 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
27 <code class="function">glXQueryContext</code> is available only if the GLX version is 1.3 or greater.
28 </p><p>
29 If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
30 If the GLX version is 1.2, then the GL version must be 1.1.
31 If the GLX version is 1.3, then the GL version must be 1.2.
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
33 <code class="constant">GLXBadContext</code> is generated if <em class="parameter"><code>ctx</code></em> does not
34 refer to a valid context.
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
36 <a class="citerefentry" href="glXCreateNewContext.xml"><span class="citerefentry"><span class="refentrytitle">glXCreateNewContext</span></span></a>,
37 <a class="citerefentry" href="glXGetCurrentContext.xml"><span class="citerefentry"><span class="refentrytitle">glXGetCurrentContext</span></span></a>,
38 <a class="citerefentry" href="glXQueryVersion.xml"><span class="citerefentry"><span class="refentrytitle">glXQueryVersion</span></span></a>,
39 <a class="citerefentry" href="glXQueryExtensionsString.xml"><span class="citerefentry"><span class="refentrytitle">glXQueryExtensionsString</span></span></a>
40 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
41 Copyright <span class="trademark"></span>© 1991-2006
42 Silicon Graphics, Inc. This document is licensed under the SGI
43 Free Software B License. For details, see
44 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
45 </p></div></div></body></html>