API reference

This is the core documentation of the various modules, classes and functions PySDL2 offers. If you want to have a quick overview about the modules, use the Module Index. If you just want to look up a specific class, method or function, use the Index or Search Page.

• sdl2 - SDL2 library wrapper
  • Usage
  • Missing interfaces
  • Additional interfaces
• sdl2.sdlgfx - SDL2_gfx library wrapper
• sdl2.sdlimage - SDL2_image library wrapper
• sd2.sdlmixer - SDL2_mixer library wrapper
• sd2.sdlttf - SDL2_ttf library wrapper
• sdl2.ext - Python extensions for SDL2
  • Common algorithms
  • Converting sequences
    • Providing read-write access for sequential data
    • Accessing data over multiple dimensions
    • Array API
  • Color handling
  • sdl2.ext.colorpalettes - predefined sets of colors
  • Initialization routines
    • API
  • sdl2.ext.compat - Python compatibility helpers
  • 2D drawing routines for software surfaces
  • Working with component-based entities
    • Component-based patterns
    • Component-based design with sdl2.ext
    • API
  • General purpose event handling routines
  • Text rendering routines
  • User interface elements
    • UI element types
    • API
  • Image loaders
  • sdl2.ext.manager - Basic scene manager.
  • sdl2.ext.particles - A simple particle system
  • 2D and 3D direct pixel access
  • sdl2.ext.rect - rectangular object.
  • Resource management
    • API
  • sdl2.ext.sprite - Sprite, texture and pixel surface routines.
  • Software Surface manipulation
  • sdl2.ext.time - track and control game time and framerate.
  • sdl2.ext.window - Window routines to manage on-screen windows
• sdl2.util - PySDL2 utilities.