Blender 2.82 Python API
77d23b0bd76f
Documentation
Quickstart: new to Blender or scripting and want to get your feet wet?
API Overview: a more complete explanation of Python integration
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
List of changes since last Blender release
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)
Property Definitions (bpy.props)
Standalone Modules
Math Types & Utilities (mathutils)
Freestyle Module (freestyle)
OpenGL Wrapper (bgl)
Font Drawing (blf)
GPU Shader Module (gpu)
GPU Utilities (gpu_extras)
Audio System (aud)
Extra Utilities (bpy_extras)
ID Property Access (idprop.types)
BMesh Module (bmesh)
Blender 2.82 Python API
Docs
»
Index
Index – G
g (mathutils.Color attribute)
gain (bpy.types.CompositorNodeChromaMatte attribute)
(bpy.types.CompositorNodeColorBalance attribute)
(bpy.types.MusgraveTexture attribute)
(bpy.types.SequenceColorBalanceData attribute)
gamma (bpy.types.ColorManagedViewSettings attribute)
(bpy.types.CompositorNodeColorBalance attribute)
(bpy.types.CompositorNodeTonemap attribute)
(bpy.types.SequenceColorBalanceData attribute)
(bpy.types.SequencerTonemapModifierData attribute)
GammaCrossSequence (class in bpy.types)
GammaCrossSequence.input_count (in module bpy.types)
gap1 (bpy.types.FreestyleLineStyle attribute)
gap2 (bpy.types.FreestyleLineStyle attribute)
gap3 (bpy.types.FreestyleLineStyle attribute)
gap_insert() (in module bpy.ops.sequencer)
gap_remove() (in module bpy.ops.sequencer)
GaussianBlurSequence (class in bpy.types)
GaussianBlurSequence.input_count (in module bpy.types)
generate() (bpy.types.KeyingSetInfo method)
generate_gpencil_strokes() (bpy.types.Object method)
generate_weights() (in module bpy.ops.gpencil)
generated_color (bpy.types.Image attribute)
generated_height (bpy.types.Image attribute)
generated_type (bpy.types.Image attribute)
generated_width (bpy.types.Image attribute)
geometry_mode (bpy.types.OceanModifier attribute)
get() (bmesh.types.BMDeformVert method)
(bmesh.types.BMEdgeSeq method)
(bmesh.types.BMFaceSeq method)
(bmesh.types.BMLayerCollection method)
(bpy.types.UDIMTiles method)
(bpy.types.bpy_prop_collection method)
(bpy.types.bpy_struct method)
(idprop.types.IDPropertyGroup method)
get_attribute_real() (freestyle.types.StrokeAttribute method)
get_attribute_vec2() (freestyle.types.StrokeAttribute method)
get_attribute_vec3() (freestyle.types.StrokeAttribute method)
get_border() (in module freestyle.utils.ContextFunctions)
get_canvas_height() (in module freestyle.utils.ContextFunctions)
get_canvas_width() (in module freestyle.utils.ContextFunctions)
get_chain_from_index() (freestyle.types.Operators static method)
get_chain_length() (in module freestyle.utils)
get_chains_size() (freestyle.types.Operators static method)
get_closest_fedge() (freestyle.types.ViewMap method)
get_closest_viewedge() (freestyle.types.ViewMap method)
get_fedge() (freestyle.types.Interface0D method)
get_from_context() (bpy.types.NodeTree class method)
get_mate() (freestyle.types.TVertex method)
get_model_view_matrix() (in module gpu.matrix)
get_normal_matrix() (in module gpu.matrix)
get_object_name() (in module freestyle.utils)
get_output_node() (bpy.types.ShaderNodeTree method)
get_preview_pixel_size() (bpy.types.RenderEngine method)
get_projection_matrix() (in module gpu.matrix)
get_result() (bpy.types.RenderEngine method)
get_selected_fedge() (in module freestyle.utils.ContextFunctions)
get_stroke_from_index() (freestyle.types.Operators static method)
get_strokes() (in module freestyle.utils)
get_strokes_size() (freestyle.types.Operators static method)
get_svertex() (freestyle.types.TVertex method)
get_test_stroke() (in module freestyle.utils)
get_time_stamp() (in module freestyle.utils.ContextFunctions)
get_view_edges_size() (freestyle.types.Operators static method)
get_viewedge_from_index() (freestyle.types.Operators static method)
GetCompleteViewMapDensityF1D (class in freestyle.functions)
getCurrentScene() (in module freestyle.utils)
GetCurvilinearAbscissaF0D (class in freestyle.functions)
GetDirectionalViewMapDensityF1D (class in freestyle.functions)
GetOccludeeF0D (class in freestyle.functions)
GetOccludeeF1D (class in freestyle.functions)
GetOccludersF0D (class in freestyle.functions)
GetOccludersF1D (class in freestyle.functions)
GetParameterF0D (class in freestyle.functions)
GetProjectedXF0D (class in freestyle.functions)
GetProjectedXF1D (class in freestyle.functions)
GetProjectedYF0D (class in freestyle.functions)
GetProjectedYF1D (class in freestyle.functions)
GetProjectedZF0D (class in freestyle.functions)
GetProjectedZF1D (class in freestyle.functions)
GetShapeF0D (class in freestyle.functions)
GetShapeF1D (class in freestyle.functions)
GetSteerableViewMapDensityF1D (class in freestyle.functions)
GetViewMapGradientNormF0D (class in freestyle.functions)
GetViewMapGradientNormF1D (class in freestyle.functions)
GetXF0D (class in freestyle.functions)
GetXF1D (class in freestyle.functions)
GetYF0D (class in freestyle.functions)
GetYF1D (class in freestyle.functions)
GetZF0D (class in freestyle.functions)
GetZF1D (class in freestyle.functions)
ghost (bpy.types.MaterialGPencilStyle attribute)
ghost_after_range (bpy.types.GreasePencil attribute)
ghost_before_range (bpy.types.GreasePencil attribute)
ghost_curves_clear() (in module bpy.ops.graph)
ghost_curves_create() (in module bpy.ops.graph)
gi_auto_bake (bpy.types.SceneEEVEE attribute)
gi_cubemap_display_size (bpy.types.SceneEEVEE attribute)
gi_cubemap_resolution (bpy.types.SceneEEVEE attribute)
gi_diffuse_bounces (bpy.types.SceneEEVEE attribute)
gi_filter_quality (bpy.types.SceneEEVEE attribute)
gi_glossy_clamp (bpy.types.SceneEEVEE attribute)
gi_irradiance_display_size (bpy.types.SceneEEVEE attribute)
gi_irradiance_smoothing (bpy.types.SceneEEVEE attribute)
gi_show_cubemaps (bpy.types.SceneEEVEE attribute)
gi_show_irradiance (bpy.types.SceneEEVEE attribute)
gi_visibility_resolution (bpy.types.SceneEEVEE attribute)
Gizmo (class in bpy.types)
Gizmo.group (in module bpy.types)
Gizmo.is_highlight (in module bpy.types)
Gizmo.is_modal (in module bpy.types)
Gizmo.matrix_world (in module bpy.types)
Gizmo.properties (in module bpy.types)
gizmo_a (bpy.types.ThemeUserInterface attribute)
gizmo_b (bpy.types.ThemeUserInterface attribute)
gizmo_group (in module bpy.context)
gizmo_group_properties() (bpy.types.WorkSpaceTool method)
gizmo_group_type_ensure() (bpy.types.WindowManager class method)
gizmo_group_type_unlink_delayed() (bpy.types.WindowManager class method)
gizmo_hi (bpy.types.ThemeUserInterface attribute)
gizmo_primary (bpy.types.ThemeUserInterface attribute)
gizmo_secondary (bpy.types.ThemeUserInterface attribute)
gizmo_select() (in module bpy.ops.gizmogroup)
gizmo_size (bpy.types.PreferencesView attribute)
gizmo_tweak() (in module bpy.ops.gizmogroup)
GizmoGroup (class in bpy.types)
GizmoGroup.gizmos (in module bpy.types)
GizmoGroup.has_reports (in module bpy.types)
GizmoGroup.name (in module bpy.types)
GizmoGroupProperties (class in bpy.types)
GizmoProperties (class in bpy.types)
Gizmos (class in bpy.types)
gl_clip_alpha (bpy.types.PreferencesSystem attribute)
gl_free() (bpy.types.Image method)
gl_load() (bpy.types.Image method)
gl_texture_limit (bpy.types.PreferencesSystem attribute)
gl_touch() (bpy.types.Image method)
glare_type (bpy.types.CompositorNodeGlare attribute)
glow_color (bpy.types.ShaderFxGlow attribute)
GlowSequence (class in bpy.types)
GlowSequence.input_count (in module bpy.types)
gltf() (in module bpy.ops.export_scene)
(in module bpy.ops.import_scene)
goal_default (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
goal_friction (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
goal_max (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
goal_min (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
goal_spring (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
gopsize (bpy.types.FFmpegSettings attribute)
gp_icon (bpy.types.BrushGpencilSettings attribute)
gp_vertex (bpy.types.ThemeView3D attribute)
gp_vertex_select (bpy.types.ThemeView3D attribute)
gp_vertex_size (bpy.types.ThemeView3D attribute)
gpencil (in module bpy.context)
gpencil_add() (in module bpy.ops.object)
gpencil_brush_preset_add() (in module bpy.ops.scene)
gpencil_data (in module bpy.context)
gpencil_data_owner (in module bpy.context)
gpencil_fade_layer (bpy.types.View3DOverlay attribute)
gpencil_grid_opacity (bpy.types.View3DOverlay attribute)
gpencil_material_preset_add() (in module bpy.ops.scene)
gpencil_modifier_add() (in module bpy.ops.object)
gpencil_modifier_apply() (in module bpy.ops.object)
gpencil_modifier_copy() (in module bpy.ops.object)
gpencil_modifier_move_down() (in module bpy.ops.object)
gpencil_modifier_move_up() (in module bpy.ops.object)
gpencil_modifier_remove() (in module bpy.ops.object)
gpencil_multi_sample (bpy.types.PreferencesSystem attribute)
gpencil_paper_opacity (bpy.types.View3DOverlay attribute)
gpencil_selectmode_edit (bpy.types.ToolSettings attribute)
gpencil_stroke_placement_view3d (bpy.types.ToolSettings attribute)
gpencil_stroke_snap_mode (bpy.types.ToolSettings attribute)
gpencil_tool (bpy.types.Brush attribute)
GPENCIL_UL_annotation_layer (class in bpy.types)
GPENCIL_UL_layer (class in bpy.types)
GPENCIL_UL_matslots (class in bpy.types)
GPENCIL_UL_vgroups (class in bpy.types)
GPencilFrame (class in bpy.types)
GPencilFrame.strokes (in module bpy.types)
GPencilFrames (class in bpy.types)
GPencilInterpolateSettings (class in bpy.types)
GPencilInterpolateSettings.interpolation_curve (in module bpy.types)
GPencilLayer (class in bpy.types)
GPencilLayer.active_frame (in module bpy.types)
GPencilLayer.frames (in module bpy.types)
GPencilLayer.is_parented (in module bpy.types)
GPencilLayer.is_ruler (in module bpy.types)
GpencilModifier (class in bpy.types)
GpencilModifier.type (in module bpy.types)
GPencilSculptBrush (class in bpy.types)
GPencilSculptGuide (class in bpy.types)
GPencilSculptSettings (class in bpy.types)
GPencilSculptSettings.brush (in module bpy.types)
GPencilSculptSettings.guide (in module bpy.types)
GPencilSculptSettings.multiframe_falloff_curve (in module bpy.types)
GPencilSculptSettings.thickness_primitive_curve (in module bpy.types)
GPencilStroke (class in bpy.types)
GPencilStroke.groups (in module bpy.types)
GPencilStroke.is_nofill_stroke (in module bpy.types)
GPencilStroke.points (in module bpy.types)
GPencilStroke.triangles (in module bpy.types)
GPencilStrokePoint (class in bpy.types)
GPencilStrokePoints (class in bpy.types)
GPencilStrokes (class in bpy.types)
GPencilTriangle (class in bpy.types)
GPencilTriangle.uv1 (in module bpy.types)
GPencilTriangle.uv2 (in module bpy.types)
GPencilTriangle.uv3 (in module bpy.types)
GPencilTriangle.v1 (in module bpy.types)
GPencilTriangle.v2 (in module bpy.types)
GPencilTriangle.v3 (in module bpy.types)
GpencilVertexGroupElement (class in bpy.types)
GpencilVertexGroupElement.group (in module bpy.types)
GpPaint (class in bpy.types)
gpu (module)
gpu.matrix (module)
gpu.select (module)
gpu.shader (module)
gpu.types (module)
gpu_extras (module)
gpu_extras.batch (module)
gpu_extras.presets (module)
GPUBatch (class in gpu.types)
GPUIndexBuf (class in gpu.types)
GPUOffScreen (class in gpu.types)
GPUShader (class in gpu.types)
GPUVertBuf (class in gpu.types)
GPUVertFormat (class in gpu.types)
grab_clone() (in module bpy.ops.paint)
grad_spacing (bpy.types.Brush attribute)
gradient (bpy.types.ThemeGradientColors attribute)
gradient_factor (bpy.types.BrushGpencilSettings attribute)
(bpy.types.GPencilStroke attribute)
gradient_fill_mode (bpy.types.Brush attribute)
gradient_shape (bpy.types.BrushGpencilSettings attribute)
(bpy.types.GPencilStroke attribute)
gradient_stroke_mode (bpy.types.Brush attribute)
gradient_type (bpy.types.MaterialGPencilStyle attribute)
(bpy.types.ShaderNodeTexGradient attribute)
graph_center_current_frame() (in module bpy.ops.clip)
graph_delete_curve() (in module bpy.ops.clip)
graph_delete_knot() (in module bpy.ops.clip)
graph_disable_markers() (in module bpy.ops.clip)
graph_select() (in module bpy.ops.clip)
graph_select_all_markers() (in module bpy.ops.clip)
graph_select_box() (in module bpy.ops.clip)
graph_view_all() (in module bpy.ops.clip)
gravity (bpy.types.ClothSettings attribute)
(bpy.types.EffectorWeights attribute)
(bpy.types.FluidDomainSettings attribute)
(bpy.types.Scene attribute)
(bpy.types.Sculpt attribute)
(bpy.types.SoftBodySettings attribute)
gravity_factor (bpy.types.ParticleSettingsTextureSlot attribute)
gravity_object (bpy.types.Sculpt attribute)
grease_pencil (bpy.types.MovieClip attribute)
(bpy.types.MovieTrackingTrack attribute)
(bpy.types.NodeTree attribute)
(bpy.types.Scene attribute)
(bpy.types.SpaceImageEditor attribute)
(bpy.types.SpaceSequenceEditor attribute)
grease_pencil_default_color (bpy.types.PreferencesEdit attribute)
grease_pencil_eraser_radius (bpy.types.PreferencesEdit attribute)
grease_pencil_euclidean_distance (bpy.types.PreferencesEdit attribute)
grease_pencil_manhattan_distance (bpy.types.PreferencesEdit attribute)
grease_pencil_source (bpy.types.SpaceClipEditor attribute)
GreasePencil (class in bpy.types)
GreasePencil.animation_data (in module bpy.types)
GreasePencil.grid (in module bpy.types)
GreasePencil.is_annotation (in module bpy.types)
GreasePencil.is_stroke_paint_mode (in module bpy.types)
GreasePencil.is_stroke_sculpt_mode (in module bpy.types)
GreasePencil.is_stroke_weight_mode (in module bpy.types)
GreasePencil.layers (in module bpy.types)
GreasePencil.materials (in module bpy.types)
GreasePencilGrid (class in bpy.types)
GreasePencilLayers (class in bpy.types)
green (bpy.types.CompositorNodeColorCorrection attribute)
grid (bpy.types.ThemeDopeSheet attribute)
(bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeNLAEditor attribute)
(bpy.types.ThemeSequenceEditor attribute)
(bpy.types.ThemeView3D attribute)
grid_fill() (in module bmesh.ops)
grid_flow() (bpy.types.UILayout method)
grid_lines (bpy.types.View3DOverlay attribute)
grid_random (bpy.types.ParticleSettings attribute)
grid_resolution (bpy.types.ParticleSettings attribute)
grid_resolution_x (bpy.types.LightProbe attribute)
grid_resolution_y (bpy.types.LightProbe attribute)
grid_resolution_z (bpy.types.LightProbe attribute)
grid_scale (bpy.types.View3DOverlay attribute)
grid_subdivisions (bpy.types.View3DOverlay attribute)
ground_albedo (bpy.types.ShaderNodeTexSky attribute)
group (bpy.types.FCurve attribute)
(bpy.types.KeyingSetPath attribute)
group_add() (in module bpy.ops.pose)
group_assign() (in module bpy.ops.pose)
group_deselect() (in module bpy.ops.pose)
group_edit() (in module bpy.ops.node)
group_insert() (in module bpy.ops.node)
group_make() (in module bpy.ops.node)
group_method (bpy.types.KeyingSetPath attribute)
group_move() (in module bpy.ops.pose)
group_node (bpy.types.ThemeNodeEditor attribute)
group_remove() (in module bpy.ops.pose)
group_select() (in module bpy.ops.pose)
group_separate() (in module bpy.ops.node)
group_socket_node (bpy.types.ThemeNodeEditor attribute)
group_sort() (in module bpy.ops.pose)
group_unassign() (in module bpy.ops.pose)
group_ungroup() (in module bpy.ops.node)
gtao_distance (bpy.types.SceneEEVEE attribute)
gtao_factor (bpy.types.SceneEEVEE attribute)
gtao_quality (bpy.types.SceneEEVEE attribute)
guide_alpha (bpy.types.FluidDomainSettings attribute)
guide_beta (bpy.types.FluidDomainSettings attribute)
guide_clump_amount (bpy.types.FieldSettings attribute)
guide_clump_shape (bpy.types.FieldSettings attribute)
guide_free (bpy.types.FieldSettings attribute)
guide_kink_amplitude (bpy.types.FieldSettings attribute)
guide_kink_axis (bpy.types.FieldSettings attribute)
guide_kink_frequency (bpy.types.FieldSettings attribute)
guide_kink_shape (bpy.types.FieldSettings attribute)
guide_kink_type (bpy.types.FieldSettings attribute)
guide_minimum (bpy.types.FieldSettings attribute)
guide_mode (bpy.types.FluidEffectorSettings attribute)
guide_parent (bpy.types.FluidDomainSettings attribute)
guide_rotate() (in module bpy.ops.gpencil)
guide_source (bpy.types.FluidDomainSettings attribute)
guide_vel_factor (bpy.types.FluidDomainSettings attribute)
GuidingLinesShader (class in freestyle.shaders)