forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glGetClipPlane.xhtml
40 lines (29 loc) · 3.83 KB
/
glGetClipPlane.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<div class="refentry" title="glGetClipPlane"><a id="glGetClipPlane"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetClipPlane — return the coefficients of the specified clipping
plane</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetClipPlanef</b>(</code></td><td>GLenum <var class="pdparam">plane</var>, </td></tr><tr><td> </td><td>GLfloat *<var class="pdparam">equation</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetClipPlanex</b>(</code></td><td>GLenum <var class="pdparam">plane</var>, </td></tr><tr><td> </td><td>GLfixed *<var class="pdparam">equation</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>plane</code></em></span></dt><dd><p>Specifies a clipping plane. The number of clipping planes
depends on the implementation, but at least six clipping planes are
supported. Symbolic names of the form
<code class="constant">GL_CLIP_PLANE</code> <span class="emphasis"><em>i</em></span>, where
<span class="emphasis"><em>i</em></span> is an integer between 0 and
<code class="constant">GL_MAX_CLIP_PLANES</code> <math overflow="scroll">
<mn>-1</mn>
</math>, are accepted.</p></dd><dt><span class="term"><em class="parameter"><code>equation</code></em></span></dt><dd><p>Returns four fixed-point or floating-point values that are the
coefficients of the plane equation of <em class="parameter"><code>plane</code></em>
in eye coordinates in the order <span class="emphasis"><em>p1</em></span>,
<span class="emphasis"><em>p2</em></span>, <span class="emphasis"><em>p3</em></span>, and
<span class="emphasis"><em>p4</em></span>. The initial value is (0, 0, 0, 0).</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p><code class="function">glGetClipPlane</code> returns in
<em class="parameter"><code>equation</code></em> the four coefficients of the plane
equation for <em class="parameter"><code>plane</code></em>. The coefficients are in eye
coordinates and are returned in the order <span class="emphasis"><em>p1</em></span>,
<span class="emphasis"><em>p2</em></span>, <span class="emphasis"><em>p3</em></span>, and
<span class="emphasis"><em>p4</em></span>.</p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>It is always the case that <math overflow="scroll">
<mi>GL_CLIP_PLANEi</mi>
<mo>=</mo>
<mi>GL_CLIP_PLANE0</mi>
<mo>+</mo>
<code class="constant">i</code>
.
</math></p><p>If an error is generated, no change is made to the contents of
<em class="parameter"><code>equation</code></em>.</p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_ENUM</code> is generated if
<em class="parameter"><code>plane</code></em> is not an accepted value.</p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glClipPlane"><span class="citerefentry"><span class="refentrytitle">glClipPlane</span></span></a></p></div><div class="refsect1" title="Copyright"><a id="copyright"></a><h2>Copyright</h2><p>Copyright © 2003-2004
Silicon Graphics, Inc. This document is licensed under the SGI Free
</p></div></div>