1GLCLIPPLANE(3G)                  OpenGL Manual                 GLCLIPPLANE(3G)
2
3
4

NAME

6       glClipPlane - specify a plane against which all geometry is clipped
7

C SPECIFICATION

9       void glClipPlane(GLenum plane, const GLdouble * equation);
10

PARAMETERS

12       plane
13           Specifies which clipping plane is being positioned. Symbolic names
14           of the form GL_CLIP_PLANEi, where i is an integer between 0 and
15           GL_MAX_CLIP_PLANES -1, are accepted.
16
17       equation
18           Specifies the address of an array of four double-precision
19           floating-point values. These values are interpreted as a plane
20           equation.
21

DESCRIPTION

23       Geometry is always clipped against the boundaries of a six-plane
24       frustum in x, y, and z.  glClipPlane allows the specification of
25       additional planes, not necessarily perpendicular to the x, y, or z
26       axis, against which all geometry is clipped. To determine the maximum
27       number of additional clipping planes, call glGetIntegerv() with
28       argument GL_MAX_CLIP_PLANES. All implementations support at least six
29       such clipping planes. Because the resulting clipping region is the
30       intersection of the defined half-spaces, it is always convex.
31
32       glClipPlane specifies a half-space using a four-component plane
33       equation. When glClipPlane is called, equation is transformed by the
34       inverse of the modelview matrix and stored in the resulting eye
35       coordinates. Subsequent changes to the modelview matrix have no effect
36       on the stored plane-equation components. If the dot product of the eye
37       coordinates of a vertex with the stored plane equation components is
38       positive or zero, the vertex is in with respect to that clipping plane.
39       Otherwise, it is out.
40
41       To enable and disable clipping planes, call glEnable() and glDisable()
42       with the argument GL_CLIP_PLANEi, where i is the plane number.
43
44       All clipping planes are initially defined as (0, 0, 0, 0) in eye
45       coordinates and are disabled.
46

NOTES

48       It is always the case that GL_CLIP_PLANE i = GL_CLIP_PLANE0 + i.
49

ERRORS

51       GL_INVALID_ENUM is generated if plane is not an accepted value.
52
53       GL_INVALID_OPERATION is generated if glClipPlane is executed between
54       the execution of glBegin() and the corresponding execution of glEnd().
55

ASSOCIATED GETS

57       glGetClipPlane()
58
59       glIsEnabled() with argument GL_CLIP_PLANEi
60

SEE ALSO

62       glEnable()
63

65       Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed
66       under the SGI Free Software B License. For details, see
67       http://oss.sgi.com/projects/FreeB/.
68

AUTHORS

70       opengl.org
71
72
73
74opengl.org                        07/13/2018                   GLCLIPPLANE(3G)
Impressum