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="gluQuadricCallback"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>gluQuadricCallback</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>gluQuadricCallback</refname> | |
17 | <refpurpose>define a callback for a quadrics object</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>gluQuadricCallback</function></funcdef> | |
23 | <paramdef>GLUquadric* <parameter>quad</parameter></paramdef> | |
24 | <paramdef>GLenum <parameter>which</parameter></paramdef> | |
25 | <paramdef>_GLUfuncptr <parameter>CallBackFunc</parameter></paramdef> | |
26 | </funcprototype> | |
27 | </funcsynopsis> | |
28 | </refsynopsisdiv> | |
29 | <!-- eqn: ignoring delim $$ --> | |
30 | <refsect1 id="parameters"><title>Parameters</title> | |
31 | <variablelist> | |
32 | <varlistentry> | |
33 | <term><parameter>quad</parameter></term> | |
34 | <listitem> | |
35 | <para> | |
36 | Specifies the quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>). | |
37 | </para> | |
38 | </listitem> | |
39 | </varlistentry> | |
40 | <varlistentry> | |
41 | <term><parameter>which</parameter></term> | |
42 | <listitem> | |
43 | <para> | |
44 | Specifies the callback being defined. | |
45 | The only valid value is <constant>GLU_ERROR</constant>. | |
46 | </para> | |
47 | </listitem> | |
48 | </varlistentry> | |
49 | <varlistentry> | |
50 | <term><parameter>CallBackFunc</parameter></term> | |
51 | <listitem> | |
52 | <para> | |
53 | Specifies the function to be called. | |
54 | </para> | |
55 | </listitem> | |
56 | </varlistentry> | |
57 | </variablelist> | |
58 | </refsect1> | |
59 | <refsect1 id="description"><title>Description</title> | |
60 | <para> | |
61 | <function>gluQuadricCallback</function> is used to define a new callback to be used by a quadrics object. | |
62 | If the specified callback is already defined, then it is replaced. If | |
63 | <parameter>CallBackFunc</parameter> is NULL, then any existing callback is erased. | |
64 | </para> | |
65 | <para> | |
66 | The one legal callback is <constant>GLU_ERROR</constant>: | |
67 | </para> | |
68 | <variablelist> | |
69 | <varlistentry> | |
70 | <term><constant>GLU_ERROR</constant></term> | |
71 | <listitem> | |
72 | <para> | |
73 | The function is called when an error is encountered. Its single argument | |
74 | is of type GLenum, and it indicates the specific error that occurred. | |
75 | Character strings describing these errors can be retrieved with the | |
76 | <citerefentry><refentrytitle>gluErrorString</refentrytitle></citerefentry> call. | |
77 | </para> | |
78 | </listitem> | |
79 | </varlistentry> | |
80 | </variablelist> | |
81 | </refsect1> | |
82 | <refsect1 id="seealso"><title>See Also</title> | |
83 | <para> | |
84 | <citerefentry><refentrytitle>gluErrorString</refentrytitle></citerefentry>, | |
85 | <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry> | |
86 | </para> | |
87 | </refsect1> | |
88 | <refsect1 id="Copyright"><title>Copyright</title> | |
89 | <para> | |
90 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
91 | Silicon Graphics, Inc. This document is licensed under the SGI | |
92 | Free Software B License. For details, see | |
93 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
94 | </para> | |
95 | </refsect1> | |
96 | </refentry> |