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="glGetClipPlane"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glGetClipPlane</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glGetClipPlane</refname> | |
17 | <refpurpose>return the coefficients of the specified clipping plane</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glGetClipPlane</function></funcdef> | |
23 | <paramdef>GLenum <parameter>plane</parameter></paramdef> | |
24 | <paramdef>GLdouble * <parameter>equation</parameter></paramdef> | |
25 | </funcprototype> | |
26 | </funcsynopsis> | |
27 | </refsynopsisdiv> | |
28 | <!-- eqn: ignoring delim $$ --> | |
29 | <refsect1 id="parameters"><title>Parameters</title> | |
30 | <variablelist> | |
31 | <varlistentry> | |
32 | <term><parameter>plane</parameter></term> | |
33 | <listitem> | |
34 | <para> | |
35 | Specifies a clipping plane. | |
36 | The number of clipping planes depends on the implementation, | |
37 | but at least six clipping planes are supported. | |
38 | They are identified by symbolic names of the form <constant>GL_CLIP_PLANE</constant> | |
39 | <inlineequation><mml:math><mml:mi mathvariant="italic">i</mml:mi></mml:math></inlineequation> | |
40 | where i ranges from 0 to the value of <constant>GL_MAX_CLIP_PLANES</constant> - 1. | |
41 | </para> | |
42 | </listitem> | |
43 | </varlistentry> | |
44 | <varlistentry> | |
45 | <term><parameter>equation</parameter></term> | |
46 | <listitem> | |
47 | <para> | |
48 | Returns four double-precision values that are the coefficients of the plane equation of <parameter>plane</parameter> in eye coordinates. | |
49 | The initial value is (0, 0, 0, 0). | |
50 | </para> | |
51 | </listitem> | |
52 | </varlistentry> | |
53 | </variablelist> | |
54 | </refsect1> | |
55 | <refsect1 id="description"><title>Description</title> | |
56 | <para> | |
57 | <function>glGetClipPlane</function> returns in <parameter>equation</parameter> the four coefficients of the plane equation | |
58 | for <parameter>plane</parameter>. | |
59 | </para> | |
60 | </refsect1> | |
61 | <refsect1 id="notes"><title>Notes</title> | |
62 | <para> | |
63 | It is always the case that <constant>GL_CLIP_PLANE</constant> | |
64 | <inlineequation><mml:math><mml:mi mathvariant="italic">i</mml:mi></mml:math></inlineequation> | |
65 | = <constant>GL_CLIP_PLANE0</constant> + | |
66 | <inlineequation><mml:math><mml:mi mathvariant="italic">i</mml:mi></mml:math></inlineequation>. | |
67 | </para> | |
68 | <para> | |
69 | If an error is generated, | |
70 | no change is made to the contents of <parameter>equation</parameter>. | |
71 | </para> | |
72 | </refsect1> | |
73 | <refsect1 id="errors"><title>Errors</title> | |
74 | <para> | |
75 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>plane</parameter> is not an accepted value. | |
76 | </para> | |
77 | <para> | |
78 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGetClipPlane</function> | |
79 | is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> | |
80 | and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. | |
81 | </para> | |
82 | </refsect1> | |
83 | <refsect1 id="seealso"><title>See Also</title> | |
84 | <para> | |
85 | <citerefentry><refentrytitle>glClipPlane</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> |