Welcome to the pygfx docs!

A render engine, inspired by ThreeJS, but for Python and targeting Vulkan/Metal/DX12 (via wgpu).

Contents

• Guide
  • Installation
  • What is pygfx?
  • Defining a scene
  • Opening a window to render to
  • Setting up a renderer
  • Putting it together
  • World objects
  • Geometry
  • Materials
  • Colors
  • Using Pygfx in Jupyter
• Reference
  • Resources
  • World objects
  • Camera objects
  • Specific world objects
  • Helper objects
  • Geometries
  • Materials
  • Controllers
• Writing shaders
  • The shader class
  • Render passes and render_mask
  • WGSL code and templating
  • Varyings
  • FragmentOutput
  • Picking
  • Clipping planes
  • Colormapping
  • Lights and shadows
  • Other functions
  • Reference docs

Indices and tables

• Index

• Module Index

• Search Page