# Documentation

VisPy is a high-performance interactive 2D/3D data visualization library leveraging the computational power of modern Graphics Processing Units (GPUs) through the OpenGL library to display very large datasets.

## Getting started

VisPy is under heavy development at this time, and we are still working on a complete user guide for Vispy. VisPy targets two primary categories of users:

1. Users knowing OpenGL, or willing to learn OpenGL, who want to create beautiful and fast interactive 2D/3D visualizations in Python as easily as possible. Users in this category can write their own visualizations with `vispy.gloo` (requires knowing OpenGL/GLSL)
2. Scientists without any knowledge of OpenGL, who are seeking a high-level, high-performance plotting toolkit. Use the `vispy.plot` and `vispy.scene` interfaces for high-level work (WARNING: experimental / developing code).

Please check out the Gallery for inspiration.

## Installation instructions

- Installation
  - Package requirements
  - Backend requirements
  - Hardware requirements
  - Installation options
  - Usage in an interactive console
  - Switchable graphics
- 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
- vispy.app - Application, event loops, canvas, backends
- vispy.color - Handling colors
- vispy.geometry - Visualization-related geometry routines
- vispy.gloo - User-friendly, Pythonic, object-oriented interface to OpenGL
  - Base class
  - Program class
  - Buffer classes
  - Texture classes
  - Classes related to FBO’s
  - State methods
  - The OpenGL context
  - vispy.gloo.gl - low level GL API
- vispy.io - Data IO
- vispy.plot - Vispy native plotting module [experimental]
  - Usage
- vispy.scene - The system underlying the upcoming high-level visualization interfaces [experimental]
  - Overview
  - vispy.scene.cameras
  - vispy.scene.canvas
  - vispy.scene.node
  - vispy.scene.events
  - vispy.scene.visuals
  - vispy.scene.widgets
- vispy.visuals - The visuals that are used for high-level plotting
  - vispy.visuals
  - vispy.visuals.filters
  - vispy.visuals.transforms
- vispy.util - Miscellaneous utilities
  - vispy.util.event
  - vispy.util.fonts
  - vispy.util.keys
  - vispy.util.transforms
- GLIR Specification
  - GL Intermediate Representation Desktop Implementation
- Release Notes

# Indices and tables

- Index
- Module Index
- Search Page