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="glXQueryContextInfoEXT"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glXQueryContextInfoEXT</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glXQueryContextInfoEXT</refname> | |
17 | <refpurpose>query context information</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>int <function>glXQueryContextInfoEXT</function></funcdef> | |
23 | <paramdef>Display * <parameter>dpy</parameter></paramdef> | |
24 | <paramdef>GLXContext <parameter>ctx</parameter></paramdef> | |
25 | <paramdef>int <parameter>attribute</parameter></paramdef> | |
26 | <paramdef>int * <parameter>value</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>ctx</parameter></term> | |
43 | <listitem> | |
44 | <para> | |
45 | Specifies a GLX rendering context. | |
46 | </para> | |
47 | </listitem> | |
48 | </varlistentry> | |
49 | <varlistentry> | |
50 | <term><parameter>attribute</parameter></term> | |
51 | <listitem> | |
52 | <para> | |
53 | Specifies that a context parameter should be retrieved. Must be one of | |
54 | <constant>GLX_SHARED_CONTEXT_EXT</constant>, <constant>GLX_VISUAL_ID_EXT</constant>, or <constant>GLX_SCREEN_EXT</constant>. | |
55 | </para> | |
56 | </listitem> | |
57 | </varlistentry> | |
58 | <varlistentry> | |
59 | <term><parameter>value</parameter></term> | |
60 | <listitem> | |
61 | <para> | |
62 | Contains the return value for <parameter>attribute</parameter>. | |
63 | </para> | |
64 | </listitem> | |
65 | </varlistentry> | |
66 | </variablelist> | |
67 | </refsect1> | |
68 | <refsect1 id="description"><title>Description</title> | |
69 | <para> | |
70 | <function>glXQueryContextInfoEXT</function> sets <parameter>value</parameter> to the value of <parameter>attribute</parameter> with respect to <parameter>ctx</parameter>. | |
71 | <function>glXQueryContextInfoEXT</function> returns an error code if it fails for any reason. Otherwise, | |
72 | <constant>Success</constant> is returned. | |
73 | </para> | |
74 | <para> | |
75 | <parameter>attribute</parameter> may be one of the following: | |
76 | </para> | |
77 | <variablelist> | |
78 | <varlistentry> | |
79 | <term><constant>GLX_SHARED_CONTEXT_EXT</constant></term> | |
80 | <listitem> | |
81 | <para> | |
82 | Returns the XID of the share list context associated with <parameter>ctx</parameter> at its | |
83 | creation. | |
84 | </para> | |
85 | </listitem> | |
86 | </varlistentry> | |
87 | <varlistentry> | |
88 | <term><constant>GLX_VISUAL_ID_EXT</constant></term> | |
89 | <listitem> | |
90 | <para> | |
91 | Returns the XID of the GLX Visual associated with <parameter>ctx</parameter>. | |
92 | </para> | |
93 | </listitem> | |
94 | </varlistentry> | |
95 | <varlistentry> | |
96 | <term><constant>GLX_SCREEN_EXT</constant></term> | |
97 | <listitem> | |
98 | <para> | |
99 | Returns the screen number associated with <parameter>ctx</parameter>. | |
100 | </para> | |
101 | </listitem> | |
102 | </varlistentry> | |
103 | </variablelist> | |
104 | <para> | |
105 | This call may cause a round-trip to the server. | |
106 | </para> | |
107 | <para> | |
108 | <function>glXQueryContextInfoEXT</function> is part of the <code>EXT_import_context</code> extension, | |
109 | not part of the core GLX command set. If _glxextstring(EXT_import_context) | |
110 | is included in the string returned by <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>, | |
111 | when called with argument <constant>GLX_EXTENSIONS</constant>, | |
112 | extension <code>EXT_import_context</code> is supported. | |
113 | </para> | |
114 | </refsect1> | |
115 | <refsect1 id="errors"><title>Errors</title> | |
116 | <para> | |
117 | <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> does not | |
118 | refer to a valid context. | |
119 | </para> | |
120 | <para> | |
121 | <constant>GLX_BAD_ATTRIBUTE</constant> is returned if <parameter>attribute</parameter> is not a valid GLX | |
122 | context attribute. | |
123 | </para> | |
124 | <para> | |
125 | fred <constant>GLX_BAD_CONTEXT</constant> is returned if <parameter>attribute</parameter> is not a valid context. | |
126 | </para> | |
127 | </refsect1> | |
128 | <refsect1 id="seealso"><title>See Also</title> | |
129 | <para> | |
130 | <citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>, | |
131 | <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>, | |
132 | <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry> | |
133 | </para> | |
134 | </refsect1> | |
135 | <refsect1 id="Copyright"><title>Copyright</title> | |
136 | <para> | |
137 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
138 | Silicon Graphics, Inc. This document is licensed under the SGI | |
139 | Free Software B License. For details, see | |
140 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
141 | </para> | |
142 | </refsect1> | |
143 | </refentry> |