Blender Documentation Contents

Welcome, this document is an API reference for Blender 2.78.4 39577403d3, built 2017-01-23.

This site can be downloaded for offline use Download the full Documentation (zipped HTML files)

Blender/Python Documentation

• Blender/Python Quickstart: new to Blender/scripting and want to get your feet wet?
• Blender/Python API Overview: a more complete explanation of Python integration
• Blender/Python Add-on Tutorial: a step by step guide on how to write an add-on from scratch
• Blender/Python API Reference Usage: examples of how to use the API reference docs
• Best Practice: Conventions to follow for writing good scripts
• Tips and Tricks: Hints to help you while writing scripts for Blender
• Gotcha’s: some of the problems you may come up against when writing scripts

Application Modules

• Context Access (bpy.context)
• Data Access (bpy.data)
• Operators (bpy.ops)
• Types (bpy.types)
• Utilities (bpy.utils)
• bpy.utils submodule (bpy.utils.previews)
• Path Utilities (bpy.path)
• Application Data (bpy.app)
• Application Handlers (bpy.app.handlers)
• Application Translations (bpy.app.translations)
• Property Definitions (bpy.props)

Standalone Modules

• Math Types & Utilities (mathutils)
• Geometry Utilities (mathutils.geometry)
• BVHTree Utilities (mathutils.bvhtree)
• KDTree Utilities (mathutils.kdtree)
• Interpolation Utilities (mathutils.interpolate)
• Noise Utilities (mathutils.noise)
• Freestyle Module (freestyle)
• OpenGL Wrapper (bgl)
• Font Drawing (blf)
• GPU functions (gpu)
• GPU Off-Screen Buffer (gpu.offscreen)
• Audio System (aud)
• Extra Utilities (bpy_extras)
• ID Property Access (idprop.types)
• BMesh Module (bmesh)

Game Engine Modules

• Game Types (bge.types)
• Game Logic (bge.logic)
• Rasterizer (bge.render)
• Video Texture (bge.texture)
• Game Keys (bge.events)
• Physics Constraints (bge.constraints)
• Application Data (bge.app)

API Info

• Blender API Change Log

Note

The Blender Python API has areas which are still in development.

The following areas are subject to change.

• operator behavior, names and arguments
• mesh creation and editing functions

These parts of the API are relatively stable and are unlikely to change significantly

• data API, access to attributes of Blender data such as mesh verts, material color, timeline frames and scene objects
• user interface functions for defining buttons, creation of menus, headers, panels
• render engine integration
• modules: bgl, mathutils & game engine.