Welcome to moderngl-window’s documentation!

A cross platform helper library for ModernGL making window creation and resource loading simple.

Note

Please report documentation improvements/issues on github.

Writing documentation is difficult and we can’t do it without you. Pull requests with documentation improvements are also greatly appreciated.

Programming Guide

• Installation
  • Installing with pip
  • Optional Dependencies
  • Installing from source
  • Running examples
  • Running tests
• Basic usage (WindowConfig)
  • Basic example
  • Resource loading
  • Generic events and window types
  • Command line arguments
  • Window events
  • Keyboard input
  • Mouse input
• Window Guide
  • Using built in window types
• Old Guide
  • Register the moderngl.Context
  • Register resource directories
• Event Guide
• The Resource System
  • Resource types
  • Resource paths
  • Resource descriptions
  • Loading resources
    • Textures
    • Programs
    • Scenes
    • Data

API Reference

• moderngl_window
  • ContextRefs
  • activate_context()
  • create_parser()
  • create_window_config_instance()
  • create_window_from_settings()
  • ctx()
  • find_window_classes()
  • get_local_window_cls()
  • get_window_cls()
  • parse_args()
  • run_window_config()
  • run_window_config_instance()
  • setup_basic_logging()
  • valid_bool()
  • valid_window_size()
  • valid_window_size_multiplier()
  • window()
• moderngl_window.conf.Settings
  • Settings
  • Methods
  • Attributes
• moderngl_window.screenshot
  • create()
• moderngl_window.context
  • WindowConfig
  • BaseWindow
  • BaseKeys
  • Window Backends
• moderngl_window.geometry
  • AttributeNames
  • bbox()
  • cube()
  • quad_2d()
  • quad_fs()
  • sphere()
• moderngl_window.loaders
  • BaseLoader
  • Text
  • JSON
  • Binary
  • Program (Separate)
  • Program (Single)
  • GLTF2
  • Wavefront / OBJ
  • STL
  • TextureArray
  • TextureCube
  • Icon
  • Texture2D
  • Pillow
• moderngl_window.meta
  • ResourceDescription
  • DataDescription
  • ProgramDescription
  • SceneDescription
  • TextureDescription
• moderngl_window.finders
  • BaseFilesystemFinder
  • Data
  • Program
  • Scene
  • Texture
• moderngl_window.opengl
  • Projection3D
  • VAO
• moderngl_window.resources
  • BaseRegistry
  • DataFiles
  • Programs
  • Scenes
  • Textures
• moderngl_window.timers
  • BaseTimer
  • Timer
• moderngl_window.utils
  • Scheduler
  • Keymaps
  • Module Loading
• moderngl_window.scene
  • Camera
  • KeyboardCamera
  • OrbitCamera
  • Scene
  • Node
  • Mesh
  • Material
  • MaterialTexture
  • MeshProgram
  • Mesh Programs

Indices and tables

• Index

• Module Index

• Search Page