glClipPlane(3gl)

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

NAME

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

C SPECIFICATION

10       void glClipPlane( GLenum plane,
11                         const GLdouble *equation )
12
13

PARAMETERS

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

DESCRIPTION

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

NOTES

49       It is always the case that GL_CLIP_PLANEi = GL_CLIP_PLANE0+i.
50

ERRORS

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

ASSOCIATED GETS

58       glGetClipPlane
59       glIsEnabled with argument GL_CLIP_PLANEi
60