vispy.gloo package

Subpackages

• vispy.gloo.gl package
  • Subpackages
    • vispy.gloo.gl.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.gloo.gl.dummy module
      • DummyProxy
    • vispy.gloo.gl.es2 module
    • vispy.gloo.gl.gl2 module
    • vispy.gloo.gl.glplus module
    • vispy.gloo.gl.pyopengl2 module
  • Module contents
    • MainProxy
    • check_error()
    • glActiveTexture()
    • glAttachShader()
    • glBindAttribLocation()
    • glBindBuffer()
    • glBindFramebuffer()
    • glBindRenderbuffer()
    • glBindTexture()
    • glBlendColor()
    • glBlendEquation()
    • glBlendEquationSeparate()
    • glBlendFunc()
    • glBlendFuncSeparate()
    • glBufferData()
    • glBufferSubData()
    • glCheckFramebufferStatus()
    • glClear()
    • glClearColor()
    • glClearDepth()
    • glClearStencil()
    • glColorMask()
    • glCompileShader()
    • glCompressedTexImage2D()
    • glCompressedTexSubImage2D()
    • glCopyTexImage2D()
    • glCopyTexSubImage2D()
    • glCreateBuffer()
    • glCreateFramebuffer()
    • glCreateProgram()
    • glCreateRenderbuffer()
    • glCreateShader()
    • glCreateTexture()
    • glCullFace()
    • glDeleteBuffer()
    • glDeleteFramebuffer()
    • glDeleteProgram()
    • glDeleteRenderbuffer()
    • glDeleteShader()
    • glDeleteTexture()
    • glDepthFunc()
    • glDepthMask()
    • glDepthRange()
    • glDetachShader()
    • glDisable()
    • glDisableVertexAttribArray()
    • glDrawArrays()
    • glDrawElements()
    • glEnable()
    • glEnableVertexAttribArray()
    • glFinish()
    • glFlush()
    • glFramebufferRenderbuffer()
    • glFramebufferTexture2D()
    • glFrontFace()
    • glGenerateMipmap()
    • glGetActiveAttrib()
    • glGetActiveUniform()
    • glGetAttachedShaders()
    • glGetAttribLocation()
    • glGetBufferParameter()
    • glGetFramebufferAttachmentParameter()
    • glGetParameter()
    • glGetProgramInfoLog()
    • glGetProgramParameter()
    • glGetRenderbufferParameter()
    • glGetShaderInfoLog()
    • glGetShaderParameter()
    • glGetShaderPrecisionFormat()
    • glGetShaderSource()
    • glGetTexParameter()
    • glGetUniform()
    • glGetUniformLocation()
    • glGetVertexAttrib()
    • glGetVertexAttribOffset()
    • glHint()
    • glIsBuffer()
    • glIsEnabled()
    • glIsFramebuffer()
    • glIsProgram()
    • glIsRenderbuffer()
    • glIsShader()
    • glIsTexture()
    • glLineWidth()
    • glLinkProgram()
    • glPixelStorei()
    • glPolygonOffset()
    • glReadPixels()
    • glRenderbufferStorage()
    • glSampleCoverage()
    • glScissor()
    • glShaderSource()
    • glStencilFunc()
    • glStencilFuncSeparate()
    • glStencilMask()
    • glStencilMaskSeparate()
    • glStencilOp()
    • glStencilOpSeparate()
    • glTexImage2D()
    • glTexParameterf()
    • glTexParameteri()
    • glTexSubImage2D()
    • glUniform1f()
    • glUniform1fv()
    • glUniform1i()
    • glUniform1iv()
    • glUniform2f()
    • glUniform2fv()
    • glUniform2i()
    • glUniform2iv()
    • glUniform3f()
    • glUniform3fv()
    • glUniform3i()
    • glUniform3iv()
    • glUniform4f()
    • glUniform4fv()
    • glUniform4i()
    • glUniform4iv()
    • glUniformMatrix2fv()
    • glUniformMatrix3fv()
    • glUniformMatrix4fv()
    • glUseProgram()
    • glValidateProgram()
    • glVertexAttrib1f()
    • glVertexAttrib2f()
    • glVertexAttrib3f()
    • glVertexAttrib4f()
    • glVertexAttribPointer()
    • glViewport()
    • make_debug_wrapper()
    • use_gl()
• vispy.gloo.tests package
  • Submodules
    • vispy.gloo.tests.test_buffer module
      • BufferTest
      • DataBufferTest
      • DataBufferViewTest
      • IndexBufferTest
      • VertexBufferTest
    • vispy.gloo.tests.test_context module
      • DummyCanvas
      • DummyCanvasBackend
      • test_context_config()
      • test_context_taking()
      • test_gloo_without_app()
    • vispy.gloo.tests.test_framebuffer module
      • test_framebuffer()
      • test_renderbuffer()
    • vispy.gloo.tests.test_glir module
      • test_capabilities()
      • test_log_parser()
      • test_queue()
      • test_texture1d_alignment()
      • test_texture2d_alignment()
      • test_texture3d_alignment()
      • test_texture_cube_alignment()
    • vispy.gloo.tests.test_globject module
      • test_globject()
    • vispy.gloo.tests.test_program module
      • DummyCanvas
      • DummyParser
      • ProgramTest
    • vispy.gloo.tests.test_texture module
      • Texture2DTest
      • TextureAtlasTest
      • TextureTest
      • test_texture_1D()
      • test_texture_1D_formats()
      • test_texture_1D_opengl_formats()
      • test_texture_2D_formats()
      • test_texture_2D_internalformats()
      • test_texture_2D_opengl_formats()
      • test_texture_3D()
      • test_texture_3D_formats()
      • test_texture_3D_internalformats()
      • test_texture_3D_opengl_formats()
      • test_texture_set_data_different_dtype()
    • vispy.gloo.tests.test_use_gloo module
      • test_use_framebuffer()
      • test_use_texture3D()
      • test_use_textures()
      • test_use_uniforms()
    • vispy.gloo.tests.test_util module
      • test_check_enum()
      • test_check_identifier()
    • vispy.gloo.tests.test_wrappers module
      • assert_cmd_raises()
      • install_dummy_glir()
      • reset_glir()
      • teardown_module()
      • test_read_pixels()
      • test_wrappers()
      • test_wrappers_basic_glir()
      • test_wrappers_glir()
  • Module contents

Submodules

• vispy.gloo.buffer module
  • Buffer
    • Buffer.nbytes
    • Buffer.resize_bytes()
    • Buffer.set_data()
    • Buffer.set_subdata()
  • DataBuffer
    • DataBuffer.dtype
    • DataBuffer.glsl_type
    • DataBuffer.itemsize
    • DataBuffer.offset
    • DataBuffer.resize_bytes()
    • DataBuffer.set_data()
    • DataBuffer.set_subdata()
    • DataBuffer.size
    • DataBuffer.stride
  • DataBufferView
    • DataBufferView.base
    • DataBufferView.glir
    • DataBufferView.id
    • DataBufferView.offset
    • DataBufferView.resize_bytes()
    • DataBufferView.set_data()
    • DataBufferView.set_subdata()
  • IndexBuffer
  • VertexBuffer
    • VertexBuffer.divisor
• vispy.gloo.context module
  • FakeCanvas
    • FakeCanvas.flush()
  • GLContext
    • GLContext.capabilities
    • GLContext.config
    • GLContext.create_shared()
    • GLContext.flush_commands()
    • GLContext.get_viewport()
    • GLContext.glir
    • GLContext.set_viewport()
    • GLContext.shared
  • GLShared
    • GLShared.add_ref()
    • GLShared.name
    • GLShared.parser
    • GLShared.ref
  • forget_canvas()
  • get_current_canvas()
  • get_default_config()
  • set_current_canvas()
• vispy.gloo.framebuffer module
  • FrameBuffer
    • FrameBuffer.activate()
    • FrameBuffer.color_buffer
    • FrameBuffer.deactivate()
    • FrameBuffer.depth_buffer
    • FrameBuffer.read()
    • FrameBuffer.resize()
    • FrameBuffer.shape
    • FrameBuffer.stencil_buffer
  • RenderBuffer
    • RenderBuffer.format
    • RenderBuffer.resize()
    • RenderBuffer.shape
• vispy.gloo.glir module
  • GL Intermediate Representation Desktop Implementation
    • The shape of a command
    • CURRENT
    • CREATE
    • DELETE
    • UNIFORM
    • TEXTURE
    • ATTRIBUTE
    • DRAW
    • SIZE
    • DATA
    • WRAPPING
    • INTERPOLATION
    • ATTACH
    • FRAMEBUFFER
    • FUNC
    • SWAP
    • LINK
  • BaseGlirParser
    • BaseGlirParser.is_remote()
    • BaseGlirParser.parse()
    • BaseGlirParser.shader_compatibility
  • GlirBuffer
    • GlirBuffer.activate()
    • GlirBuffer.create()
    • GlirBuffer.deactivate()
    • GlirBuffer.delete()
    • GlirBuffer.set_data()
    • GlirBuffer.set_size()
  • GlirFragmentShader
  • GlirFrameBuffer
    • GlirFrameBuffer.activate()
    • GlirFrameBuffer.attach()
    • GlirFrameBuffer.create()
    • GlirFrameBuffer.deactivate()
    • GlirFrameBuffer.delete()
    • GlirFrameBuffer.set_framebuffer()
  • GlirGeometryShader
  • GlirIndexBuffer
  • GlirObject
    • GlirObject.handle
    • GlirObject.id
  • GlirParser
    • GlirParser.get_object()
    • GlirParser.is_remote()
    • GlirParser.parse()
    • GlirParser.shader_compatibility
  • GlirProgram
    • GlirProgram.ATYPEINFO
    • GlirProgram.ATYPEMAP
    • GlirProgram.UTYPEMAP
    • GlirProgram.activate()
    • GlirProgram.attach()
    • GlirProgram.create()
    • GlirProgram.deactivate()
    • GlirProgram.delete()
    • GlirProgram.draw()
    • GlirProgram.link_program()
    • GlirProgram.set_attribute()
    • GlirProgram.set_shaders()
    • GlirProgram.set_texture()
    • GlirProgram.set_uniform()
  • GlirQueue
    • GlirQueue.associate()
    • GlirQueue.clear()
    • GlirQueue.command()
    • GlirQueue.flush()
    • GlirQueue.set_verbose()
  • GlirRenderBuffer
    • GlirRenderBuffer.activate()
    • GlirRenderBuffer.create()
    • GlirRenderBuffer.deactivate()
    • GlirRenderBuffer.delete()
    • GlirRenderBuffer.set_size()
  • GlirShader
    • GlirShader.create()
    • GlirShader.delete()
    • GlirShader.set_data()
  • GlirTexture
    • GlirTexture.activate()
    • GlirTexture.create()
    • GlirTexture.deactivate()
    • GlirTexture.delete()
    • GlirTexture.set_interpolation()
    • GlirTexture.set_wrapping()
  • GlirTexture1D
    • GlirTexture1D.set_data()
    • GlirTexture1D.set_size()
  • GlirTexture2D
    • GlirTexture2D.set_data()
    • GlirTexture2D.set_size()
  • GlirTexture3D
    • GlirTexture3D.set_data()
    • GlirTexture3D.set_size()
  • GlirTextureCube
    • GlirTextureCube.set_data()
    • GlirTextureCube.set_size()
  • GlirVertexBuffer
  • GlirVertexShader
  • as_enum()
  • as_es2_command()
  • convert_shader()
  • glTexImage1D()
  • glTexImage3D()
  • glTexSubImage1D()
  • glTexSubImage3D()
  • glir_logger()
• vispy.gloo.globject module
  • On queues
  • GLObject
    • GLObject.delete()
    • GLObject.glir
    • GLObject.id
• vispy.gloo.preprocessor module
  • merge_includes()
  • preprocess()
  • remove_comments()
• vispy.gloo.program module
  • Gloo vs GLIR
  • FragmentShader
  • GeometryShader
  • Program
    • Program.bind()
    • Program.draw()
    • Program.set_shaders()
    • Program.shaders
    • Program.variables
  • Shader
    • Shader.code
  • VertexShader
• vispy.gloo.texture module
  • BaseTexture
    • BaseTexture.format
    • BaseTexture.internalformat
    • BaseTexture.interpolation
    • BaseTexture.resize()
    • BaseTexture.set_data()
    • BaseTexture.shape
    • BaseTexture.wrapping
  • Texture1D
    • Texture1D.glsl_sample
    • Texture1D.glsl_sampler_type
    • Texture1D.glsl_type
    • Texture1D.width
  • Texture2D
    • Texture2D.glsl_sample
    • Texture2D.glsl_sampler_type
    • Texture2D.glsl_type
    • Texture2D.height
    • Texture2D.width
  • Texture3D
    • Texture3D.depth
    • Texture3D.glsl_sample
    • Texture3D.glsl_sampler_type
    • Texture3D.glsl_type
    • Texture3D.height
    • Texture3D.width
  • TextureAtlas
    • TextureAtlas.get_free_region()
  • TextureCube
    • TextureCube.depth
    • TextureCube.glsl_sample
    • TextureCube.glsl_sampler_type
    • TextureCube.glsl_type
    • TextureCube.height
    • TextureCube.width
  • TextureEmulated3D
    • TextureEmulated3D.depth
    • TextureEmulated3D.glsl_sample
    • TextureEmulated3D.height
    • TextureEmulated3D.resize()
    • TextureEmulated3D.set_data()
    • TextureEmulated3D.shape
    • TextureEmulated3D.width
  • convert_dtype_and_clip()
  • downcast_to_32bit_if_needed()
  • get_dtype_limits()
• vispy.gloo.util module
  • check_enum()
  • check_identifier()
  • check_variable()
  • draw_texture()
• vispy.gloo.wrappers module
  • GL_PRESETS
  • GlooFunctions
    • GlooFunctions.glir
  • clear()
  • finish()
  • flush()
  • get_gl_configuration()
  • get_state_presets()
  • read_pixels()
  • set_blend_color()
  • set_blend_equation()
  • set_blend_func()
  • set_clear_color()
  • set_clear_depth()
  • set_clear_stencil()
  • set_color_mask()
  • set_cull_face()
  • set_depth_func()
  • set_depth_mask()
  • set_depth_range()
  • set_front_face()
  • set_hint()
  • set_line_width()
  • set_polygon_offset()
  • set_sample_coverage()
  • set_scissor()
  • set_state()
  • set_stencil_func()
  • set_stencil_mask()
  • set_stencil_op()
  • set_viewport()

Module contents

Object oriented interface to OpenGL.

This module implements classes for the things that are “objects” in OpenGL, such as textures, FBO’s, VBO’s and shaders. Further, some convenience classes are implemented (like the collection class).

This set of classes provides a friendly (Pythonic) interface to OpenGL, and is designed to provide OpenGL’s full functionality.

All classes inherit from GLObject, which provide a basic interface, enabling, activating and deleting the object. Central to each visualization is the Program. Other objects, such as Texture2D and VertexBuffer should be set as uniforms and attributes of the Program object.

Example:

# Init
program = gloo.Program(vertex_source, fragment_source)
program['a_position'] = gloo.VertexBuffer(my_positions_array)
program['s_texture'] = gloo.Texture2D(my_image)
...

# Draw event handler
program['u_color'] = 0.0, 1.0, 0.0
program.draw(gl.GL_TRIANGLES)

Note

With vispy.gloo we strive to offer a Python interface that provides the full functionality of OpenGL. However, this layer is a work in progress and there are still a few known limitations. Most notably:

• TextureCubeMap is not yet implemented

• FBOs can only do 2D textures (not 3D textures or cube maps)

• No support for compressed textures.