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="gluCheckExtension"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>gluCheckExtension</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>gluCheckExtension</refname> | |
17 | <refpurpose>determines if an extension name is supported</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLboolean <function>gluCheckExtension</function></funcdef> | |
23 | <paramdef>const GLubyte * <parameter>extName</parameter></paramdef> | |
24 | <paramdef>const GLubyte * <parameter>extString</parameter></paramdef> | |
25 | </funcprototype> | |
26 | </funcsynopsis> | |
27 | </refsynopsisdiv> | |
28 | <refsect1 id="parameters"><title>Parameters</title> | |
29 | <variablelist> | |
30 | <varlistentry> | |
31 | <term><parameter>extName</parameter></term> | |
32 | <listitem> | |
33 | <para> | |
34 | Specifies an extension name. | |
35 | </para> | |
36 | </listitem> | |
37 | </varlistentry> | |
38 | <varlistentry> | |
39 | <term><parameter>extString</parameter></term> | |
40 | <listitem> | |
41 | <para> | |
42 | Specifies a space-separated list of extension names supported. | |
43 | </para> | |
44 | </listitem> | |
45 | </varlistentry> | |
46 | </variablelist> | |
47 | </refsect1> | |
48 | <refsect1 id="description"><title>Description</title> | |
49 | <para> | |
50 | <function>gluCheckExtension</function> returns <constant>GLU_TRUE</constant> if <parameter>extName</parameter> is supported otherwise | |
51 | <constant>GLU_FALSE</constant> is returned. | |
52 | </para> | |
53 | <para> | |
54 | This is used to check for the presence for OpenGL, GLU, or GLX extension names | |
55 | by passing the extension strings returned by <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>, | |
56 | <citerefentry><refentrytitle>gluGetString</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>, | |
57 | <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>, or <citerefentry><refentrytitle>glXQueryServerString</refentrytitle></citerefentry>, | |
58 | respectively, as <parameter>extString</parameter>. | |
59 | </para> | |
60 | </refsect1> | |
61 | <refsect1 id="notes"><title>Notes</title> | |
62 | <para> | |
63 | Cases where one extension name is a substring of another are | |
64 | correctly handled. | |
65 | </para> | |
66 | <para> | |
67 | There may or may not be leading or trailing blanks in <parameter>extString</parameter>. | |
68 | </para> | |
69 | <para> | |
70 | Extension names should not contain embedded spaces. | |
71 | </para> | |
72 | <para> | |
73 | All strings are null-terminated. | |
74 | </para> | |
75 | </refsect1> | |
76 | <refsect1 id="seealso"><title>See Also</title> | |
77 | <para> | |
78 | <citerefentry><refentrytitle>gluGetString</refentrytitle></citerefentry>, | |
79 | <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>, | |
80 | <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>, | |
81 | <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>, | |
82 | <citerefentry><refentrytitle>glXQueryServerString</refentrytitle></citerefentry> | |
83 | </para> | |
84 | </refsect1> | |
85 | <refsect1 id="Copyright"><title>Copyright</title> | |
86 | <para> | |
87 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
88 | Silicon Graphics, Inc. This document is licensed under the SGI | |
89 | Free Software B License. For details, see | |
90 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
91 | </para> | |
92 | </refsect1> | |
93 | </refentry> |