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 documenation is diffucult 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
• moderngl_window.conf.Settings
  • Methods
  • Attributes
• moderngl_window.screenshot
• moderngl_window.context
  • base.window.WindowConfig
  • base.BaseWindow
  • glfw.Window
  • headless.Window
  • pyglet.Window
  • pyqt5.Window
  • pyside2.Window
  • sdl2.Window
• moderngl_window.geometry
• moderngl_window.loaders
  • base.BaseLoader
  • texture.t2d.Loader
  • program.single.Loader
  • program.separate.Loader
  • texture.array.Loader
  • scene.wavefront.Loader
  • scene.gltf2.Loader
  • scene.stl.Loader
  • data.json.Loader
  • data.text.Loader
  • data.binary.Loader
• moderngl_window.meta
  • base.ResourceDescription
  • texture.TextureDescription
  • program.ProgramDescription
  • scene.SceneDescription
  • data.DataDescription
• moderngl_window.finders
  • base.BaseFilesystemFinder
  • texture.FilesystemFinder
  • program.FilesystemFinder
  • scene.FilesystemFinder
  • data.FilesystemFinder
• moderngl_window.opengl
  • opengl.projection.Projection3D
  • opengl.vao.VAO
• moderngl_window.resources
  • base.BaseRegistry
  • textures.Textures
  • programs.Programs
  • scenes.Scenes
  • base.DataFiles
• moderngl_window.timers
  • base.BaseTimer
  • clock.Timer
• moderngl_window.utils
  • Scheduler
• moderngl_window.scene
  • Camera
  • KeyboardCamera
  • Scene
  • Node
  • Mesh
  • Material
  • MaterialTexture
  • MeshProgram

Indices and tables

• Index

• Module Index

• Search Page