glGetClipPlane(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


GLGETCLIPPLANE(3G)                                                                        GLGETCLIPPLANE(3G)



NAME
       glGetClipPlane - return the coefficients of the specified clipping plane


C SPECIFICATION
       void glGetClipPlane( GLenum plane,
                            GLdouble *equation )


PARAMETERS
       plane     Specifies  a  clipping plane.  The number of clipping planes depends on the implementation,
                 but at least six clipping planes are supported.  They are identified by symbolic  names  of
                 the form GL_CLIP_PLANEi where 0 <=  i  < GL_MAX_CLIP_PLANES.

       equation  Returns  four  double-precision  values  that are the coefficients of the plane equation of
                 plane in eye coordinates.  The initial value is (0, 0, 0, 0).

DESCRIPTION
       glGetClipPlane returns in equation the four coefficients of the plane equation for plane.

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

       If an error is generated, no change is made to the contents of equation.

ERRORS
       GL_INVALID_ENUM is generated if plane is not an accepted value.

       GL_INVALID_OPERATION is generated if glGetClipPlane is executed between the execution of glBegin  and
       the corresponding execution of glEnd.

SEE ALSO
       glClipPlane(3G)




                                                                                          GLGETCLIPPLANE(3G)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation to the OpenGL project.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?