GLGETCLIPPLANE(3G)

📦 version 1.1, in centos-stream 9, fedora 43, fedora 44

✨ GLGETCLIPPLANE 💅

okay bestie, welcome to GLGETCLIPPLANE(3G), the little OpenGL page that spills the tea on your clipping planes 🎀

🌸 NAME 🌸

glGetClipPlane — returns the coefficients of the specified clipping plane. no cap, that's literally its whole job 💖

🦋 C SPECIFICATION 🦋

void glGetClipPlane( GLenum plane,
                     GLdouble *equation )

that's it, that's the signature, copy it exactly pls 🙈

🎀 PARAMETERS 🎀

  • plane — specifies a clipping plane 👑 the number of clipping planes depends on the implementation, but bestie, at least six clipping planes are supported. they're identified by symbolic names of the form GL_CLIP_PLANEi where 0 ≤ i < GL_MAX_CLIP_PLANES. iykyk 💫
  • 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). yes, all zeros at first, it's giving blank slate energy 🌈

💜 DESCRIPTION 💜

glGetClipPlane returns in equation the four coefficients of the plane equation for plane. that's the whole vibe. four numbers, one plane, slay ✨

🍓 NOTES 🍓

  • it is always the case that GL_CLIP_PLANEi = GL_CLIP_PLANE0 + i. periodt 💅
  • if an error is generated, no change is made to the contents of equation. so like, if it flops, it flops quietly and doesn't touch your buffer 🫶

💀 ERRORS 💀

  • GL_INVALID_ENUM is generated if plane is not an accepted value. not me passing a bad enum 😭
  • GL_INVALID_OPERATION is generated if glGetClipPlane is executed between the execution of glBegin and the corresponding execution of glEnd. so do not call this mid-glBegin/glEnd, bestie, the GL gods will simply say no 🙈

🔥 SEE ALSO 🔥

  • glClipPlane(3G)

and that's the whole page, mwah 💋 this was GLGETCLIPPLANE(3G), straight from the GLGETCLIPPLANE(3G) manual — go forth and clip those planes, main character 🧚💖

📦 where this page comes from