Name

glGetClipPlane — return the coefficients of the specified clipping plane

C Specification

void glGetClipPlanef(GLenum plane,
 GLfloat *equation);
 
void glGetClipPlanex(GLenum plane,
 GLfixed *equation);
 

Parameters

plane

Specifies a clipping plane. The number of clipping planes depends on the implementation, but at least six clipping planes are supported. Symbolic names of the form GL_CLIP_PLANE i, where i is an integer between 0 and GL_MAX_CLIP_PLANES -1 , are accepted.

equation

Returns four fixed-point or floating-point values that are the coefficients of the plane equation of plane in eye coordinates in the order p1, p2, p3, and p4. The initial value is (0, 0, 0, 0).

Description

glGetClipPlane returns in equation the four coefficients of the plane equation for plane. The coefficients are in eye coordinates and are returned in the order p1, p2, p3, and p4.

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.

See Also

glClipPlane

Copyright

Copyright © 2003-2004 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.