Application Program Interface (API)

.. toctree::
   :maxdepth: 2
   :hidden:

   api-gloo
   api-app
   api-graphics
   api-other

Glumpy is organized around three blocks:

The app package is responsible for opening a window and handling user events.
The gloo package is responsible for handling shader programs and syncing CPU/GPU data.
The graphics package provides higher-level common objects such as text, collections and widgets.

App

clock : Clock
console : Debug console
options : Command line options
configuration : Default configuration
window
- backends : Backend specific code
- event : Event dispatcher
- mouse : Mouse events
- keyboard : Keyboard events
- window : Abstract window

Gloo

globject : Abstract object that lives on both CPU & GPU
gpudata : GPU aware numpy array
program : GPU Program
parser : GLSL parser
shader : Programmable shader
snippet : Reusable GLSL snippet
variable : Shader variable (attribute or uniform)
buffer : GPU buffer (VertexBuffer/IndexBuffer)
texture : GPU texture (1D/2D/3D)
atlas : 2D Texture atlas

Graphics

text : Text related objects
widgets : Interactive widgets
collections
- points : Points collection
- lines : Lines collection
- triangles : Triangles collection
- quads : Quads collection

Others

geometry : Geometry related functions
transforms : Interactive transformations
shaders : Actual shader code
gl : OpenGL access
glm : Simple 3D matrix transforms
ext : External packages