glGetClipPlane

  • Article

The glGetClipPlane function returns the coefficients of the specified clipping plane.

void glGetClipPlane(
  GLenum plane,  GLdouble *equation);

Parameters

  • plane
    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 &le; i < GL_MAX_CLIP_PLANES.
  • equation
    Returns four double-precision values that are the coefficients of the plane equation of plane in eye coordinates.

Remarks

The glGetClipPlane function returns in equation the four coefficients of the plane equation for plane.

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.

Error Codes

The following are the error codes generated and their conditions.

Error code Condition
GL_INVALID_ENUM plane was not an accepted value.
GL_INVALID_OPERATION glGetClipPlane was called between a call to glBegin and the corresponding call to glEnd.

Requirements

**  Windows NT/2000:** Requires Windows NT 3.5 or later.
**  Windows 95/98:** Requires Windows 95 or later. Available as a redistributable for Windows 95.
**  Header:** Declared in Gl.h.
**  Library:** Use Opengl32.lib.

See Also

glBegin, glClipPlane, glEnd