0.6
  • Documentation
  • Gallery
  • Resources
  • Community
  • News
  • Site
      • Community
      • Documentation
        • Getting started
        • Installation instructions
          • Installation
            • Package requirements
            • Backend requirements
            • Hardware requirements
            • Installation options
              • Via conda
              • Via PyPI
              • Via GitHub
              • Jupyter Notebook Extension
              • JupyterLab
              • Testing installation
            • Usage in an interactive console
            • Switchable graphics
              • Windows
              • Linux
              • Modifyin default jupyter kernel
          • Installation on Raspberry Pi 3 Model B
            • Distribution
            • Raspbian/Raspberry setup
            • Checking OpenGL capabilities
            • Backend requirements
            • Package requirements
            • Installation options
            • Testing installation
        • API Reference
          • vispy - Top-level tools
            • set_log_level()
            • sys_info()
            • test()
            • use()
          • vispy.app - Application, event loops, canvas, backends
            • use_app()
            • create()
            • run()
            • quit()
            • process_events()
            • Application
              • Application.backend_module
              • Application.backend_name
              • Application.create()
              • Application.is_interactive()
              • Application.is_notebook()
              • Application.native
              • Application.process_events()
              • Application.quit()
              • Application.reuse()
              • Application.run()
              • Application.sleep()
            • Canvas
              • Canvas.app
              • Canvas.close()
              • Canvas.connect()
              • Canvas.context
              • Canvas.create_native()
              • Canvas.dpi
              • Canvas.fps
              • Canvas.measure_fps()
              • Canvas.native
              • Canvas.physical_size
              • Canvas.pixel_scale
              • Canvas.position
              • Canvas.render()
              • Canvas.set_current()
              • Canvas.show()
              • Canvas.size
              • Canvas.swap_buffers()
              • Canvas.title
              • Canvas.update()
            • Timer
              • Timer.app
              • Timer.connect()
              • Timer.disconnect()
              • Timer.native
              • Timer.start()
              • Timer.stop()
          • vispy.color - Handling colors
            • BaseColormap
              • BaseColormap.map()
            • Color
              • Color.RGB
              • Color.RGBA
              • Color.alpha
              • Color.hex
              • Color.hsv
              • Color.is_blank
              • Color.rgb
              • Color.rgba
              • Color.value
            • ColorArray
              • ColorArray.RGB
              • ColorArray.RGBA
              • ColorArray.alpha
              • ColorArray.copy()
              • ColorArray.darker()
              • ColorArray.extend()
              • ColorArray.hex
              • ColorArray.hsv
              • ColorArray.lighter()
              • ColorArray.rgb
              • ColorArray.rgba
              • ColorArray.value
            • Colormap
              • Colormap.interpolation
              • Colormap.map()
              • Colormap.texture_lut()
            • get_color_dict()
            • get_color_names()
            • get_colormap()
            • get_colormaps()
          • vispy.geometry - Visualization-related geometry routines
            • MeshData
              • MeshData.get_bounds()
              • MeshData.get_edges()
              • MeshData.get_face_colors()
              • MeshData.get_face_normals()
              • MeshData.get_faces()
              • MeshData.get_vertex_colors()
              • MeshData.get_vertex_faces()
              • MeshData.get_vertex_normals()
              • MeshData.get_vertex_values()
              • MeshData.get_vertices()
              • MeshData.has_face_color()
              • MeshData.has_face_indexed_data()
              • MeshData.has_vertex_color()
              • MeshData.has_vertex_value()
              • MeshData.n_faces
              • MeshData.n_vertices
              • MeshData.restore()
              • MeshData.save()
              • MeshData.set_face_colors()
              • MeshData.set_faces()
              • MeshData.set_vertex_colors()
              • MeshData.set_vertex_values()
              • MeshData.set_vertices()
            • PolygonData
              • PolygonData.add_vertex()
              • PolygonData.convex_hull
              • PolygonData.edges
              • PolygonData.faces
              • PolygonData.triangulate()
              • PolygonData.vertices
            • Rect
              • Rect.contains()
              • Rect.flipped()
              • Rect.normalized()
              • Rect.padded()
            • Triangulation
              • Triangulation.triangulate()
            • create_arrow()
            • create_box()
            • create_cone()
            • create_cube()
            • create_cylinder()
            • create_grid_mesh()
            • create_plane()
            • create_sphere()
            • resize()
            • triangulate()
          • vispy.gloo - User-friendly, Pythonic, object-oriented interface to OpenGL
            • Base class
              • GLObject
                • GLObject.delete()
                • GLObject.glir
                • GLObject.id
            • Program class
              • Program
                • Program.bind()
                • Program.draw()
                • Program.set_shaders()
                • Program.shaders
                • Program.variables
            • Buffer classes
              • 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
              • VertexBuffer
              • IndexBuffer
            • Texture classes
              • BaseTexture
                • BaseTexture.format
                • BaseTexture.interpolation
                • BaseTexture.resize()
                • BaseTexture.set_data()
                • BaseTexture.shape
                • BaseTexture.wrapping
              • 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()
            • Classes related to FBO’s
              • RenderBuffer
                • RenderBuffer.format
                • RenderBuffer.resize()
                • RenderBuffer.shape
              • FrameBuffer
                • FrameBuffer.activate()
                • FrameBuffer.color_buffer
                • FrameBuffer.deactivate()
                • FrameBuffer.depth_buffer
                • FrameBuffer.read()
                • FrameBuffer.resize()
                • FrameBuffer.shape
                • FrameBuffer.stencil_buffer
            • State methods
              • 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()
            • The OpenGL context
              • FakeCanvas
                • FakeCanvas.flush()
              • GLContext
                • GLContext.capabilities
                • GLContext.config
                • GLContext.create_shared()
                • GLContext.flush_commands()
                • 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.gl - low level GL API
          • vispy.io - Data IO
            • imread()
            • imsave()
            • load_crate()
            • load_data_file()
            • load_iris()
            • load_spatial_filters()
            • read_mesh()
            • read_png()
            • write_mesh()
            • write_png()
          • vispy.plot - Vispy native plotting module [experimental]
            • Usage
          • vispy.scene - The system underlying the upcoming high-level visualization interfaces [experimental]
            • Overview
            • vispy.scene.cameras
              • ArcballCamera
              • BaseCamera
                • BaseCamera.center
                • BaseCamera.depth_value
                • BaseCamera.fov
                • BaseCamera.get_state()
                • BaseCamera.interactive
                • BaseCamera.link()
                • BaseCamera.on_canvas_change()
                • BaseCamera.pre_transform
                • BaseCamera.reset()
                • BaseCamera.set_default_state()
                • BaseCamera.set_range()
                • BaseCamera.set_state()
                • BaseCamera.up
                • BaseCamera.view_changed()
                • BaseCamera.viewbox
                • BaseCamera.viewbox_key_event()
                • BaseCamera.viewbox_mouse_event()
                • BaseCamera.viewbox_resize_event()
              • FlyCamera
                • FlyCamera.auto_roll
                • FlyCamera.keymap
                • FlyCamera.on_timer()
                • FlyCamera.rotation
                • FlyCamera.rotation1
                • FlyCamera.rotation2
                • FlyCamera.viewbox_key_event()
                • FlyCamera.viewbox_mouse_event()
              • Magnify1DCamera
                • Magnify1DCamera.transform_class
              • MagnifyCamera
                • MagnifyCamera.on_timer()
                • MagnifyCamera.transform_class
                • MagnifyCamera.view_changed()
                • MagnifyCamera.viewbox_mouse_event()
                • MagnifyCamera.viewbox_resize_event()
              • PanZoomCamera
                • PanZoomCamera.aspect
                • PanZoomCamera.center
                • PanZoomCamera.pan()
                • PanZoomCamera.rect
                • PanZoomCamera.viewbox_mouse_event()
                • PanZoomCamera.viewbox_resize_event()
                • PanZoomCamera.zoom()
              • TurntableCamera
                • TurntableCamera.azimuth
                • TurntableCamera.elevation
                • TurntableCamera.orbit()
                • TurntableCamera.roll
            • vispy.scene.canvas
              • SceneCanvas
                • SceneCanvas.central_widget
                • SceneCanvas.draw_visual()
                • SceneCanvas.on_close()
                • SceneCanvas.on_draw()
                • SceneCanvas.on_resize()
                • SceneCanvas.pop_fbo()
                • SceneCanvas.pop_viewport()
                • SceneCanvas.push_fbo()
                • SceneCanvas.push_viewport()
                • SceneCanvas.render()
                • SceneCanvas.scene
                • SceneCanvas.update()
                • SceneCanvas.visual_at()
                • SceneCanvas.visuals_at()
            • vispy.scene.node
              • Node
                • Node.canvas
                • Node.children
                • Node.clip_children
                • Node.clipper
                • Node.common_parent()
                • Node.describe_tree()
                • Node.document
                • Node.document_node
                • Node.is_child()
                • Node.node_path()
                • Node.node_path_to_child()
                • Node.node_path_transforms()
                • Node.node_transform()
                • Node.on_parent_change()
                • Node.order
                • Node.parent
                • Node.parent_chain()
                • Node.picking
                • Node.scene_node
                • Node.set_transform()
                • Node.transform
                • Node.update()
                • Node.visible
            • vispy.scene.events
              • SceneMouseEvent
                • SceneMouseEvent.button
                • SceneMouseEvent.buttons
                • SceneMouseEvent.delta
                • SceneMouseEvent.last_event
                • SceneMouseEvent.pos
                • SceneMouseEvent.press_event
            • vispy.scene.visuals
              • Arrow
              • Axis
              • Box
              • ColorBar
              • Compound
              • Cube
              • Ellipse
              • Graph
              • GridLines
              • GridMesh
              • Histogram
              • Image
              • InfiniteLine
              • Isocurve
              • Isoline
              • Isosurface
              • Line
              • LinePlot
              • LinearRegion
              • Markers
              • Mesh
              • Plane
              • Polygon
              • Rectangle
              • RegularPolygon
              • ScrollingLines
              • Spectrogram
              • Sphere
              • SurfacePlot
              • Text
              • Tube
              • VisualNode
                • VisualNode.interactive
                • VisualNode.picking
              • Volume
              • Windbarb
              • XYZAxis
            • vispy.scene.widgets
              • AxisWidget
                • AxisWidget.link_view()
                • AxisWidget.on_resize()
              • ColorBarWidget
                • ColorBarWidget.border_color
                • ColorBarWidget.border_width
                • ColorBarWidget.on_resize()
              • Console
                • Console.clear()
                • Console.font_size
                • Console.on_resize()
                • Console.text_color
                • Console.write()
              • Grid
                • Grid.add_grid()
                • Grid.add_view()
                • Grid.add_widget()
                • Grid.remove_widget()
                • Grid.resize_widget()
              • Label
                • Label.on_resize()
              • ViewBox
                • ViewBox.add()
                • ViewBox.camera
                • ViewBox.get_scene_bounds()
                • ViewBox.is_in_scene()
                • ViewBox.on_resize()
                • ViewBox.scene
              • Widget
                • Widget.add_grid()
                • Widget.add_view()
                • Widget.add_widget()
                • Widget.bgcolor
                • Widget.border_color
                • Widget.height
                • Widget.height_max
                • Widget.height_min
                • Widget.inner_rect
                • Widget.picking
                • Widget.remove_widget()
                • Widget.size
                • Widget.stretch
                • Widget.width
                • Widget.width_max
                • Widget.width_min
          • vispy.visuals - The visuals that are used for high-level plotting
            • vispy.visuals
              • ArrowVisual
                • ArrowVisual.set_data()
              • AxisVisual
              • BaseVisual
                • BaseVisual.attach()
                • BaseVisual.bounds()
                • BaseVisual.detach()
                • BaseVisual.get_transform()
                • BaseVisual.update()
                • BaseVisual.view()
              • BoxVisual
                • BoxVisual.border
                • BoxVisual.mesh
              • ColorBarVisual
                • ColorBarVisual.border_color
                • ColorBarVisual.border_width
                • ColorBarVisual.clim
                • ColorBarVisual.cmap
                • ColorBarVisual.label
                • ColorBarVisual.orientation
                • ColorBarVisual.pos
                • ColorBarVisual.size
                • ColorBarVisual.ticks
              • CompoundVisual
                • CompoundVisual.add_subvisual()
                • CompoundVisual.attach()
                • CompoundVisual.detach()
                • CompoundVisual.draw()
                • CompoundVisual.remove_subvisual()
                • CompoundVisual.set_gl_state()
                • CompoundVisual.update_gl_state()
              • CubeVisual
              • EllipseVisual
                • EllipseVisual.center
                • EllipseVisual.num_segments
                • EllipseVisual.radius
                • EllipseVisual.span_angle
                • EllipseVisual.start_angle
              • GraphVisual
                • GraphVisual.set_data()
              • GridLinesVisual
              • GridMeshVisual
                • GridMeshVisual.set_data()
              • HistogramVisual
              • ImageVisual
                • ImageVisual.set_data()
                • ImageVisual.view()
              • InfiniteLineVisual
                • InfiniteLineVisual.set_data()
              • IsocurveVisual
                • IsocurveVisual.levels
                • IsocurveVisual.set_data()
              • IsolineVisual
                • IsolineVisual.data
                • IsolineVisual.levels
                • IsolineVisual.set_color()
                • IsolineVisual.set_data()
              • IsosurfaceVisual
                • IsosurfaceVisual.level
                • IsosurfaceVisual.set_data()
              • LinePlotVisual
                • LinePlotVisual.set_data()
              • LineVisual
                • LineVisual.method
                • LineVisual.set_data()
              • LinearRegionVisual
                • LinearRegionVisual.set_data()
              • MarkersVisual
                • MarkersVisual.set_data()
              • MeshVisual
                • MeshVisual.ambient_light_color
                • MeshVisual.color
                • MeshVisual.light_dir
                • MeshVisual.mesh_data
                • MeshVisual.mode
                • MeshVisual.set_data()
                • MeshVisual.shading
                • MeshVisual.shininess
              • PlaneVisual
              • PolygonVisual
                • PolygonVisual.border
                • PolygonVisual.border_color
                • PolygonVisual.color
                • PolygonVisual.mesh
                • PolygonVisual.pos
              • RectangleVisual
                • RectangleVisual.center
                • RectangleVisual.height
                • RectangleVisual.radius
                • RectangleVisual.width
              • RegularPolygonVisual
                • RegularPolygonVisual.sides
              • ScrollingLinesVisual
                • ScrollingLinesVisual.roll_data()
                • ScrollingLinesVisual.set_color()
                • ScrollingLinesVisual.set_data()
                • ScrollingLinesVisual.set_pos_offset()
              • SpectrogramVisual
                • SpectrogramVisual.freqs
              • SphereVisual
                • SphereVisual.border
                • SphereVisual.mesh
              • SurfacePlotVisual
                • SurfacePlotVisual.set_data()
              • TextVisual
                • TextVisual.color
                • TextVisual.font_size
                • TextVisual.pos
                • TextVisual.rotation
                • TextVisual.text
              • TubeVisual
              • Visual
                • Visual.attach()
                • Visual.detach()
                • Visual.set_gl_state()
                • Visual.update_gl_state()
              • VolumeVisual
                • VolumeVisual.clim
                • VolumeVisual.method
                • VolumeVisual.relative_step_size
                • VolumeVisual.set_data()
                • VolumeVisual.threshold
              • WindbarbVisual
                • WindbarbVisual.set_data()
              • XYZAxisVisual
            • vispy.visuals.filters
              • Alpha
              • Clipper
                • Clipper.bounds
                • Clipper.transform
              • ColorFilter
              • IsolineFilter
              • PickingFilter
                • PickingFilter.color
              • ZColormapFilter
            • vispy.visuals.transforms
              • ChainTransform
                • ChainTransform.append()
                • ChainTransform.imap()
                • ChainTransform.map()
                • ChainTransform.prepend()
                • ChainTransform.shader_imap()
                • ChainTransform.shader_map()
                • ChainTransform.simplified
                • ChainTransform.transforms
              • LogTransform
                • LogTransform.base
                • LogTransform.imap()
                • LogTransform.map()
                • LogTransform.shader_imap()
                • LogTransform.shader_map()
              • MatrixTransform
                • MatrixTransform.imap()
                • MatrixTransform.map()
                • MatrixTransform.rotate()
                • MatrixTransform.scale()
                • MatrixTransform.set_frustum()
                • MatrixTransform.set_mapping()
                • MatrixTransform.set_ortho()
                • MatrixTransform.set_perspective()
                • MatrixTransform.shader_imap()
                • MatrixTransform.shader_map()
                • MatrixTransform.translate()
              • NullTransform
                • NullTransform.imap()
                • NullTransform.map()
              • PanZoomTransform
                • PanZoomTransform.attach()
                • PanZoomTransform.on_mouse_move()
                • PanZoomTransform.on_mouse_wheel()
                • PanZoomTransform.on_resize()
              • PolarTransform
                • PolarTransform.imap()
                • PolarTransform.map()
              • STTransform
                • STTransform.from_mapping()
                • STTransform.imap()
                • STTransform.map()
                • STTransform.move()
                • STTransform.set_mapping()
                • STTransform.shader_imap()
                • STTransform.shader_map()
                • STTransform.zoom()
              • TransformSystem
                • TransformSystem.canvas
                • TransformSystem.canvas_transform
                • TransformSystem.configure()
                • TransformSystem.document_transform
                • TransformSystem.dpi
                • TransformSystem.framebuffer_transform
                • TransformSystem.get_transform()
                • TransformSystem.scene_transform
                • TransformSystem.visual_transform
          • vispy.util - Miscellaneous utilities
            • vispy.util.event
              • Event
                • Event.blocked
                • Event.handled
                • Event.source
                • Event.sources
              • MouseEvent
                • MouseEvent.drag_events()
                • MouseEvent.is_dragging
                • MouseEvent.trail()
              • KeyEvent
              • ResizeEvent
              • DrawEvent
              • EventEmitter
                • EventEmitter.__call__()
                • EventEmitter.block()
                • EventEmitter.blocked()
                • EventEmitter.blocker()
                • EventEmitter.callback_refs
                • EventEmitter.callbacks
                • EventEmitter.connect()
                • EventEmitter.disconnect()
                • EventEmitter.ignore_callback_errors
                • EventEmitter.print_callback_errors
                • EventEmitter.source
                • EventEmitter.unblock()
            • vispy.util.fonts
              • list_fonts()
            • vispy.util.keys
              • Key
                • Key.name
            • vispy.util.transforms
              • affine_map()
              • frustum()
              • ortho()
              • perspective()
              • rotate()
              • scale()
              • translate()
          • GLIR Specification
            • 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
          • Release Notes
      • Indices and tables
      • Gallery
      • Low Level OpenGL API
      • Modern OpenGL
        • Shaders
        • Buffers
        • Uniform, attribute, varying
        • Transformations
          • Projection matrix
          • Model and view matrices
        • Learning modern OpenGL
          • An intro to modern OpenGL
          • Learning Modern 3D Graphics Programming
          • OpenGL ES 2.0 documentation
      • News
        • 2019
        • 2018
        • 2017
        • 2015
        • 2014
        • 2013
      • Resources
        • Learning
        • References
        • Blogs
        • Visualisation
        • Scientific Articles

    Python Module Index

    v
     
    v
    - vispy
        vispy.app
        vispy.color
        vispy.geometry
        vispy.gloo
        vispy.gloo.context
        vispy.gloo.gl
        vispy.gloo.glir
        vispy.gloo.wrappers
        vispy.io
        vispy.plot
        vispy.scene
        vispy.scene.cameras
        vispy.scene.canvas
        vispy.scene.events
        vispy.scene.node
        vispy.scene.visuals
        vispy.scene.widgets
        vispy.util
        vispy.util.event
        vispy.util.fonts
        vispy.util.keys
        vispy.util.transforms
        vispy.visuals
        vispy.visuals.filters
        vispy.visuals.transforms
    • GitHub
    • ·
    • Examples
    • ·
    • Issues
    • ·
    • Releases
    • Back to top
    • 2013-2025, VisPy developers
    • Code licensed under BSD license, documentation under CC BY 3.0
    • Made with sphinx using the excellent bootstrap theme