Python API リファレンス (bpy) [Blender]

お知らせ

次の項目は別ページに分割しました。

Blender Python API

公式サイト：

Blender Python API Documentation [Official]

アプリケーションモジュール

Context Access (bpy.context)：現在の UI のコンテキストに応じたアクセスを提供する
Data Access (bpy.data)：Blender 上のデータへのアクセスを提供する
Operators (bpy.ops)：Blender 上での操作を実装したオペレーターを提供する
Types (bpy.types)：Blender API で使用される型を提供する
Utilities (bpy.utils)：ユーティリティを提供する
Path Utilities (bpy.path)：パスを取り扱うユーティリティを提供する
Application Data (bpy.app)：ランタイムに固有のデータを保持する

オペレーター (Operators)

参考：

Operators (bpy.ops) | Blender Python API [Official]

型 (Types)

Menu：メニュー
Object：オブジェクト
Operator：オペレーター
Panel：パネル
Property：プロパティ
Scene：シーン
SpaceView3D

こちらのページを参照

型リファレンス (bpy.types)

参考：

Types (bpy.types) | Blender Python API [Official]

bpy_struct

bpy.types で定義される全クラスの大元となる基底クラス

こちらのページを参照

データブロック／データ形式 (bpy_struct)

参考：

bpy_struct | Blender Python API [Official]

What is bpy_struct for? – Blender Stack Exchange

ユーティリティ (bpy.utils)

アドオンフォルダ

アドオンインストール先フォルダのパスを取得する。

bpy.utils.user_resource('SCRIPTS', path="addons")Code language: Python (python)

参考：

Utilities (bpy.utils) | Blender Python API [Official]

How to automatically get a Add-on folder’s path regardless of OS? – Blender Stack Exchange

positional argument error in 3.0 – Blender Stack Exchange

アプリケーションデータ (Application Data)

Application Timers (bpy.app.timers)

参考：

Application Data (bpy.app) | Blender Python API [Official]

エクストラユーティリティ (Extra Utilities / bpy_extras)

参考：

Extra Utilities (bpy_extras) | Blender Python API [Official]

数学ユーティリティ (Math Types & Utilities / mathutils)

こちらのページを参照

数学ユーティリティ (mathutils)

参考：

Math Types & Utilities (mathutils) | Blender Python API [Official]

mathutils – GitHub

コンテキストアクセス (bpy.context)

コンテキストに応じたデータや UI、操作を提供するインスタンス。

グローバルコンテキスト (Global Context)

area
blend_data
collection
engine
gizmo_group
layer_collection
mode
preferences
region
region_data
scene
screen
space_data
tool_settings
view_layer
window
window_manager
workspace

スクリーンコンテキスト (Screen Context)

scene
view_layer
visible_objects
selectable_objects
selected_objects
editable_objects
selected_editable_objects
objects_in_mode
objects_in_mode_unique_data
visible_bones
editable_bones
selected_bones
selected_editable_bones
visible_pose_bones
selected_pose_bones
selected_pose_bones_from_active_object
active_bone
active_pose_bone
active_object
object
edit_object
sculpt_object
vertex_paint_object
weight_paint_object
image_paint_object
particle_edit_object
pose_object
sequences
selected_sequences
selected_editable_sequences
gpencil_data
gpencil_data_owner
annotation_data
annotation_data_owner
visible_gpencil_layers
editable_gpencil_layers
editable_gpencil_strokes
active_gpencil_layer
active_gpencil_frame
active_annotation_layer
active_operator
visible_fcurves
editable_fcurves
selected_visible_fcurves
selected_editable_fcurves
active_editable_fcurves

3D ビューコンテキスト (View3D Context)

active_base
active_object

ボタンコンテキスト (Buttons Context)

texture_slot
scene
world
object
mesh
armature
lattice
curve
meta_ball
light
speaker
lightprobe
camera
material
material_slot
texture
texture_user
texture_user_property
bone
edit_bone
pose_bone
particle_system
particle_system_editable
particle_settings
cloth
soft_body
fluid
collision
brush
dynamic_paint
line_style
collection
gpencil

イメージコンテキスト (Image Context)

edit_image
edit_mask

ノードコンテキスト (Node Context)

selected_nodes
active_node
light
material
world

テキストコンテキスト (Text Context)

edit_text

クリップコンテキスト (Clip Context)

edit_movieclip
edit_mask

シーケンサーコンテキスト (Sequencer Context)

edit_mask

こちらのページを参照

コンテキストアクセス索引 (bpy.context)

参考：

Context Access (bpy.context) | Blender Python API [Official]

プロパティ (Property)

こちらのページを参照

プロパティの使い方 (Property / bpy.props)

参考：

bpy.types.Property | Blender Python API [Official]

スタートアップ

Scripts which are automatically imported on startup.
./scripts/startup/*.py
── Blender Manual

起動時に読み込まれるモジュール／ファイル

bl_app_templates_system：テンプレート
bl_operators：オペレーター
bl_ui：ユーザーインターフェイス
keyingsets_builtins.py：標準キーイングセット
nodeitems_builtins.py：組み込みノード

参考：

Blender’s Directory Layout | Blender Manual [Official]

blender/blender/release/scripts/startup – GitHub

How could a single Python script run when Blender is started? – Blender Stack Exchange

How to execute custom Python code on startup? – Blender Stack Exchange

BGL モジュール

※廃止 (Blender 4.0 で取り除かれる)

BGL Deprecation

BGL is a direct wrapper around OpenGL calls. The BGL module is deprecated for and since Blender 3.4 has been replaced with the gpu module. From this release it will not work when using the Metal backend. Add-ons and scripts that uses the bgl module are warned about the deprecation and should use the gpu module in stead.