MirOS Manual: glClipPlane(3)


GLCLIPPLANE(3G)     UNIX Programmer's Manual      GLCLIPPLANE(3G)

NAME

     glClipPlane - specify a plane against which all geometry is
     clipped

C SPECIFICATION

     void glClipPlane( GLenum plane,
                       const GLdouble *equation )

PARAMETERS

     plane     Specifies which clipping plane is being posi-
               tioned. Symbolic names of the form GL_CLIP_PLANEi,
               where i is an integer between 0 and
               GL_MAX_CLIP_PLANES-1, are accepted.

     equation  Specifies the address of an array of four double-
               precision floating-point values. These values are
               interpreted as a plane equation.

DESCRIPTION

     Geometry is always clipped against the boundaries of a six-
     plane frustum in x, y, and z. glClipPlane allows the specif-
     ication of additional planes, not necessarily perpendicular
     to the x, y, or z axis, against which all geometry is
     clipped. To determine the maximum number of additional clip-
     ping planes, call glGetIntegerv with argument
     GL_MAX_CLIP_PLANES. All implementations support at least six
     such clipping planes. Because the resulting clipping region
     is the intersection of the defined half-spaces, it is always
     convex.

     glClipPlane specifies a half-space using a four-component
     plane equation. When glClipPlane is called, equation is
     transformed by the inverse of the modelview matrix and
     stored in the resulting eye coordinates. Subsequent changes
     to the modelview matrix have no effect on the stored plane-
     equation components. If the dot product of the eye coordi-
     nates of a vertex with the stored plane equation components
     is positive or zero, the vertex is in with respect to that
     clipping plane. Otherwise, it is out.

     To enable and disable clipping planes, call glEnable and
     glDisable with the argument GL_CLIP_PLANEi, where i is the
     plane number.

     All clipping planes are initially defined as (0, 0, 0, 0) in
     eye coordinates and are disabled.

NOTES

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

MirOS BSD #10-current  Printed 03.04.2017                       1

GLCLIPPLANE(3G)     UNIX Programmer's Manual      GLCLIPPLANE(3G)

ERRORS

     GL_INVALID_ENUM is generated if plane is not an accepted
     value.

     GL_INVALID_OPERATION is generated if glClipPlane is executed
     between the execution of glBegin and the corresponding exe-
     cution of glEnd.

ASSOCIATED GETS

     glGetClipPlane
     glIsEnabled with argument GL_CLIP_PLANEi

SEE ALSO

     glEnable(3G)

MirOS BSD #10-current  Printed 03.04.2017                       2

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.