Crate gl

This crate exposes OpenGL bindings in a more idiomatic Rust format.

OpenGL has an idiosynchratic way of testing for errors, often making use of utilities like glGetError to get if the last call has failed. To account for this, this library contains 3 different conventions for function naming.

• *_unchecked: unsafe functions that should test for an error in most cases, but are left untested to avoid the overhead for when the caller already knows an error-condition has been met.
• * (unprefixed): safe functions that either test for errors implicitly, or don’t bother need to test at all since the functionality is reasonably safe.
• *_checked: safe functions that don’t need to test for errors, but are still technically fallible and could be checked. Often this is useful for detecting failures after cases like a glGet* – which is normally reasonably safe to assume will succeed, but may fail from a bad context profile.

Modules

• c
  This module provides all that raw definitions of the C OpenGL library.
• error
  The error module provides definitions of OpenGL errors, and other utilities around operating with them.
• info
  This module provide information about the current GL context.
• shader
  A module for handling shaders and programs.
• vertex
  The vertex crate provides an abstraction over buffer objects so that they follow a more conventional “OO” approach.

Structs

• ClearBits
  Specify the clear value for the color, depth, and stencil buffers used in clear.

Enums

• Capability
  An enumeration of capabilities that can be tested against.
• CullFace
  An enumeration of the face to cull

Functions

• clear
  Clear buffers to preset values
• clear_color
  Specify clear values for the color buffers
• clear_depth
  Specify the clear value for the depth buffer
• clear_stencil
  Specify the clear value for the stencil buffer
• cull_face
  Returns the current face to cull.
• cull_face_unchecked^⚠
  Returns the current face to cull without checking if cull face is enabled.
• disable_cull_face
  Disables polygon culling.
• enable_cull_face
  Enables polygon culling.
• is_cull_face_enabled
  Queries whether whether polygon culling is enabled.
• set_cull_face
  Specifies which face to cull (front, back, or both)
• set_cull_face_checked
  Specifies which face to cull (front, back, or both), and checks for errors.
• toggle_cull_face
  Toggles polygon culling.