Gambas Documentation - /comp/gb.opengl/gl/getclipplane

# Gl.GetClipPlane (gb.opengl)

Static Function GetClipPlane ( Plane As Integer ) As Float[]

Return the coefficients of the specified clipping plane.

### 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_PLANE i where i ranges from 0 to the value of Gl.MAX_CLIP_PLANES - 1.

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

Gl.GetClipPlane returns in equation the four coefficients of the plane equation for plane.

### Notes

It is always the case that Gl.CLIP_PLANE i = 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 Gl.GetClipPlane is executed between the execution of Gl.Begin and the corresponding execution of Gl.End.

### See also

- Gl.ClipPlane

See original documentation on OpenGL website