Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Blender Python API

Toggle table of contents sidebar

Blender Python API

Documentation

Quickstart
API Overview
API Reference Usage
Best Practice
Tips and Tricks
Gotchas
Toggle navigation of Gotchas
Advanced
Toggle navigation of Advanced
- Blender as a Python Module
Change Log

Application Modules

Context Access (bpy.context)
Data Access (bpy.data)
Message Bus (bpy.msgbus)
Operators (bpy.ops)
Toggle navigation of Operators (bpy.ops)
Types (bpy.types)
Toggle navigation of Types (bpy.types)
Utilities (bpy.utils)
Toggle navigation of Utilities (bpy.utils)
- bpy.utils submodule (bpy.utils.previews)
- bpy.utils submodule (bpy.utils.units)
Path Utilities (bpy.path)
Application Data (bpy.app)
Toggle navigation of Application Data (bpy.app)
Property Definitions (bpy.props)

Game Engine Modules

Game Types (bge.types)
Toggle navigation of Game Types (bge.types)
Game Logic (bge.logic)
Rasterizer (bge.render)
Video Texture (bge.texture)
FFmpeg Video and Image Status
Image Blending Modes
Game Keys (bge.events)
Physics Constraints (bge.constraints)
Application Data (bge.app)
Game GUI (bgui)
Toggle navigation of Game GUI (bgui)
- bgui_utils
- frame
- frame_button
- image
- image_button
- key_defs
- label
- list_box
- progress_bar
- system
- text_block
- text_input
- theme
- widget

Standalone Modules

OpenGL Wrapper (bgl)
Additional Math Functions (bl_math)
Font Drawing (blf)
BMesh Module (bmesh)
Toggle navigation of BMesh Module (bmesh)
Extra Utilities (bpy_extras)
Toggle navigation of Extra Utilities (bpy_extras)
Freestyle Module (freestyle)
Toggle navigation of Freestyle Module (freestyle)
- Freestyle Types (freestyle.types)
- Freestyle Predicates (freestyle.predicates)
- Freestyle Functions (freestyle.functions)
- Freestyle Chaining Iterators (freestyle.chainingiterators)
- Freestyle Shaders (freestyle.shaders)
- Freestyle Utilities (freestyle.utils)
  Toggle navigation of Freestyle Utilities (freestyle.utils)
  - freestyle.utils submodule (freestyle.utils.ContextFunctions)
GPU Module (gpu)
Toggle navigation of GPU Module (gpu)
GPU Utilities (gpu_extras)
Toggle navigation of GPU Utilities (gpu_extras)
- gpu_extras submodule (gpu_extras.batch)
- gpu_extras submodule (gpu_extras.presets)
ID Property Access (idprop.types)
Image Buffer (imbuf)
Toggle navigation of Image Buffer (imbuf)
- Image Buffer Types (imbuf.types)
Math Types & Utilities (mathutils)
Toggle navigation of Math Types & Utilities (mathutils)

4.4
Versions
- Loading...

Toggle table of contents sidebar

Advanced¶

This chapter covers advanced use (topics which may not be required for typical usage).

Blender as a Python Module

Blender as a Python Module

File Paths & String Encoding

Copyright © Blender Authors

Made with Furo

Report issue on this page