Blender 2.81 Python API
26bd5ebd42e3
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.81 Python API
Docs
»
Index
Index – V
v (mathutils.Color attribute)
validate() (bmesh.types.BMEditSelSeq method)
(bpy.types.Mesh method)
validate_material_indices() (bpy.types.Curve method)
(bpy.types.Mesh method)
value (bpy.types.ColorGpencilModifier attribute)
(bpy.types.KeyMapItem attribute)
(bpy.types.MeshFaceMap attribute)
(bpy.types.MeshPaintMaskProperty attribute)
(bpy.types.MeshPolygonFloatProperty attribute)
(bpy.types.MeshPolygonIntProperty attribute)
(bpy.types.MeshPolygonStringProperty attribute)
(bpy.types.MeshVertexFloatProperty attribute)
(bpy.types.MeshVertexIntProperty attribute)
(bpy.types.MeshVertexStringProperty attribute)
(bpy.types.ShapeKey attribute)
value_layer_name (bpy.types.ParticleInstanceModifier attribute)
value_max (bpy.types.LineStyleThicknessModifier_AlongStroke attribute)
(bpy.types.LineStyleThicknessModifier_DistanceFromCamera attribute)
(bpy.types.LineStyleThicknessModifier_DistanceFromObject attribute)
(bpy.types.LineStyleThicknessModifier_Material attribute)
value_min (bpy.types.LineStyleThicknessModifier_AlongStroke attribute)
(bpy.types.LineStyleThicknessModifier_DistanceFromCamera attribute)
(bpy.types.LineStyleThicknessModifier_DistanceFromObject attribute)
(bpy.types.LineStyleThicknessModifier_Material attribute)
value_offset (bpy.types.FModifierFunctionGenerator attribute)
value_sliders (bpy.types.ThemeDopeSheet attribute)
values() (bmesh.types.BMDeformVert method)
(bmesh.types.BMLayerCollection method)
(bpy.types.bpy_prop_collection method)
(bpy.types.bpy_struct method)
(idprop.types.IDPropertyGroup method)
variable_lacunarity() (in module mathutils.noise)
vbo_collection_rate (bpy.types.PreferencesSystem attribute)
vbo_time_out (bpy.types.PreferencesSystem attribute)
Vector (class in mathutils)
Vector.angle() (in module mathutils)
Vector.angle_signed() (in module mathutils)
Vector.copy() (in module mathutils)
Vector.freeze() (in module mathutils)
Vector.lerp() (in module mathutils)
Vector.project() (in module mathutils)
Vector.rotate() (in module mathutils)
Vector.rotation_difference() (in module mathutils)
Vector.slerp() (in module mathutils)
vector_display_type (bpy.types.SmokeDomainSettings attribute)
vector_node (bpy.types.ThemeNodeEditor attribute)
vector_scale (bpy.types.SmokeDomainSettings attribute)
vector_type (bpy.types.ShaderNodeMapping attribute)
(bpy.types.ShaderNodeVectorTransform attribute)
(bpy.types.TexMapping attribute)
VectorFont (class in bpy.types)
VectorFont.packed_file (in module bpy.types)
vectorscope_alpha (bpy.types.Scopes attribute)
velocity (aud.Handle attribute)
(bpy.types.Particle attribute)
(bpy.types.ParticleKey attribute)
velocity_factor (bpy.types.ParticleSettingsTextureSlot attribute)
(bpy.types.SmokeFlowSettings attribute)
velocity_max (bpy.types.DynamicPaintBrushSettings attribute)
(bpy.types.Itasc attribute)
velocity_normal (bpy.types.SmokeFlowSettings attribute)
velocity_radius (bpy.types.ControlFluidSettings attribute)
velocity_random (bpy.types.SmokeFlowSettings attribute)
velocity_strength (bpy.types.ControlFluidSettings attribute)
verify() (bmesh.types.BMLayerCollection method)
version (in module bpy.app)
version_char (in module bpy.app)
version_cycle (in module bpy.app)
version_string (in module bpy.app)
version_update (in module bpy.app.handlers)
vert (bmesh.types.BMLoop attribute)
vert_collapse_edge() (in module bmesh.utils)
vert_collapse_faces() (in module bmesh.utils)
vert_connect() (in module bpy.ops.mesh)
vert_connect_concave() (in module bpy.ops.mesh)
vert_connect_nonplanar() (in module bpy.ops.mesh)
vert_connect_path() (in module bpy.ops.mesh)
vert_dissolve() (in module bmesh.utils)
vert_mapping (bpy.types.DataTransferModifier attribute)
vert_select_all() (in module bpy.ops.paint)
vert_select_ungrouped() (in module bpy.ops.paint)
vert_separate() (in module bmesh.utils)
vert_slide() (in module bpy.ops.transform)
vert_splice() (in module bmesh.utils)
vertbuf_add() (gpu.types.GPUBatch method)
vertex (bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeImageEditor attribute)
(bpy.types.ThemeView3D attribute)
vertex_add() (in module bpy.ops.curve)
vertex_attribute_name (bpy.types.ShaderNodeTexPointDensity attribute)
vertex_bevel (bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeImageEditor attribute)
(bpy.types.ThemeView3D attribute)
vertex_color_add() (in module bpy.ops.mesh)
vertex_color_brightness_contrast() (in module bpy.ops.paint)
vertex_color_dirt() (in module bpy.ops.paint)
vertex_color_from_weight() (in module bpy.ops.paint)
vertex_color_hsv() (in module bpy.ops.paint)
vertex_color_invert() (in module bpy.ops.paint)
vertex_color_levels() (in module bpy.ops.paint)
vertex_color_remove() (in module bpy.ops.mesh)
vertex_color_set() (in module bpy.ops.paint)
vertex_color_smooth() (in module bpy.ops.paint)
vertex_color_source (bpy.types.ShaderNodeTexPointDensity attribute)
vertex_group (bpy.types.ArmatureGpencilModifier attribute)
(bpy.types.ArmatureModifier attribute)
(bpy.types.BevelModifier attribute)
(bpy.types.CastModifier attribute)
(bpy.types.CorrectiveSmoothModifier attribute)
(bpy.types.CurveModifier attribute)
(bpy.types.DataTransferModifier attribute)
(bpy.types.DecimateModifier attribute)
(bpy.types.DisplaceModifier attribute)
(bpy.types.ExplodeModifier attribute)
(bpy.types.HookGpencilModifier attribute)
(bpy.types.HookModifier attribute)
(bpy.types.LaplacianDeformModifier attribute)
(bpy.types.LaplacianSmoothModifier attribute)
(bpy.types.Lattice attribute)
(bpy.types.LatticeGpencilModifier attribute)
(bpy.types.LatticeModifier attribute)
(bpy.types.MaskModifier attribute)
(bpy.types.MeshDeformModifier attribute)
(bpy.types.NoiseGpencilModifier attribute)
(bpy.types.NormalEditModifier attribute)
(bpy.types.OffsetGpencilModifier attribute)
(bpy.types.OpacityGpencilModifier attribute)
(bpy.types.ShapeKey attribute)
(bpy.types.ShrinkwrapModifier attribute)
(bpy.types.SimpleDeformModifier attribute)
(bpy.types.SmoothGpencilModifier attribute)
(bpy.types.SmoothModifier attribute)
(bpy.types.SolidifyModifier attribute)
(bpy.types.ThickGpencilModifier attribute)
(bpy.types.UVWarpModifier attribute)
(bpy.types.VertexWeightEditModifier attribute)
(bpy.types.VertexWeightProximityModifier attribute)
(bpy.types.WarpModifier attribute)
(bpy.types.WaveModifier attribute)
(bpy.types.WeightedNormalModifier attribute)
(bpy.types.WireframeModifier attribute)
vertex_group_a (bpy.types.VertexWeightMixModifier attribute)
vertex_group_add() (in module bpy.ops.object)
vertex_group_assign() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_assign_new() (in module bpy.ops.object)
vertex_group_b (bpy.types.VertexWeightMixModifier attribute)
vertex_group_bending (bpy.types.ClothSettings attribute)
vertex_group_clean() (in module bpy.ops.object)
vertex_group_clump (bpy.types.ParticleSystem attribute)
vertex_group_copy() (in module bpy.ops.object)
vertex_group_copy_to_linked() (in module bpy.ops.object)
vertex_group_copy_to_selected() (in module bpy.ops.object)
vertex_group_density (bpy.types.ParticleSystem attribute)
vertex_group_deselect() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_factor (bpy.types.DecimateModifier attribute)
vertex_group_field (bpy.types.ParticleSystem attribute)
vertex_group_fix() (in module bpy.ops.object)
vertex_group_goal (bpy.types.SoftBodySettings attribute)
vertex_group_invert() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_kink (bpy.types.ParticleSystem attribute)
vertex_group_length (bpy.types.ParticleSystem attribute)
vertex_group_levels() (in module bpy.ops.object)
vertex_group_limit_total() (in module bpy.ops.object)
vertex_group_lock() (in module bpy.ops.object)
vertex_group_mass (bpy.types.ClothSettings attribute)
(bpy.types.SoftBodySettings attribute)
vertex_group_mirror() (in module bpy.ops.object)
vertex_group_move() (in module bpy.ops.object)
vertex_group_normalize() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_normalize_all() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_quantize() (in module bpy.ops.object)
vertex_group_remove() (in module bpy.ops.object)
vertex_group_remove_from() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_rotation (bpy.types.ParticleSystem attribute)
vertex_group_roughness_1 (bpy.types.ParticleSystem attribute)
vertex_group_roughness_2 (bpy.types.ParticleSystem attribute)
vertex_group_roughness_end (bpy.types.ParticleSystem attribute)
vertex_group_select() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_self_collisions (bpy.types.ClothCollisionSettings attribute)
vertex_group_set_active() (in module bpy.ops.object)
vertex_group_shear_stiffness (bpy.types.ClothSettings attribute)
vertex_group_shrink (bpy.types.ClothSettings attribute)
vertex_group_size (bpy.types.ParticleSystem attribute)
vertex_group_smooth() (in module bpy.ops.gpencil)
(in module bpy.ops.object)
vertex_group_sort() (in module bpy.ops.object)
vertex_group_spring (bpy.types.SoftBodySettings attribute)
vertex_group_structural_stiffness (bpy.types.ClothSettings attribute)
vertex_group_subset (bpy.types.ToolSettings attribute)
vertex_group_tangent (bpy.types.ParticleSystem attribute)
vertex_group_twist (bpy.types.ParticleSystem attribute)
vertex_group_user (bpy.types.ToolSettings attribute)
vertex_group_velocity (bpy.types.ParticleSystem attribute)
vertex_group_weight (bpy.types.ToolSettings attribute)
vertex_index (bpy.types.MeshLoop attribute)
vertex_indices_set() (bpy.types.HookModifier method)
vertex_normal (bpy.types.ThemeView3D attribute)
vertex_opacity (bpy.types.View3DOverlay attribute)
vertex_paint() (in module bpy.ops.paint)
vertex_paint_mode_opacity (bpy.types.View3DOverlay attribute)
vertex_paint_object (in module bpy.context)
vertex_paint_toggle() (in module bpy.ops.paint)
vertex_parent_set() (in module bpy.ops.object)
vertex_random() (in module bpy.ops.transform)
vertex_select (bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeImageEditor attribute)
(bpy.types.ThemeView3D attribute)
vertex_size (bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeImageEditor attribute)
(bpy.types.ThemeView3D attribute)
vertex_tool (bpy.types.Brush attribute)
vertex_unreferenced (bpy.types.ThemeGraphEditor attribute)
(bpy.types.ThemeImageEditor attribute)
(bpy.types.ThemeView3D attribute)
vertex_warp() (in module bpy.ops.transform)
vertex_weight_copy() (in module bpy.ops.object)
vertex_weight_delete() (in module bpy.ops.object)
vertex_weight_normalize_active_vertex() (in module bpy.ops.object)
vertex_weight_paste() (in module bpy.ops.object)
vertex_weight_set_active() (in module bpy.ops.object)
VertexFloatProperties (class in bpy.types)
VertexGroup (class in bpy.types)
VertexGroup.index (in module bpy.types)
VertexGroupElement (class in bpy.types)
VertexGroupElement.group (in module bpy.types)
VertexGroups (class in bpy.types)
VertexGroups.active (in module bpy.types)
VertexIntProperties (class in bpy.types)
VertexOrientation2DF0D (class in freestyle.functions)
VertexOrientation3DF0D (class in freestyle.functions)
VertexPaint (class in bpy.types)
VertexStringProperties (class in bpy.types)
VertexWeightEditModifier (class in bpy.types)
VertexWeightEditModifier.map_curve (in module bpy.types)
VertexWeightMixModifier (class in bpy.types)
VertexWeightProximityModifier (class in bpy.types)
vertices (bpy.types.MeshEdge attribute)
(bpy.types.MeshPolygon attribute)
(freestyle.types.SShape attribute)
(freestyle.types.ViewShape attribute)
vertices_begin() (freestyle.types.Interface1D method)
vertices_end() (freestyle.types.Interface1D method)
vertices_smooth() (in module bpy.ops.mesh)
vertices_smooth_laplacian() (in module bpy.ops.mesh)
verts (bmesh.types.BMEdge attribute)
(bmesh.types.BMFace attribute)
(bmesh.types.BMesh attribute)
video_bitrate (bpy.types.FFmpegSettings attribute)
view (bpy.types.CompositorNodeImage attribute)
(bpy.types.SpaceClipEditor attribute)
View2D (class in bpy.types)
view2d_grid_spacing_min (bpy.types.PreferencesView attribute)
View3DCursor (class in bpy.types)
View3DOverlay (class in bpy.types)
View3DOverlay.grid_scale_unit (in module bpy.types)
View3DShading (class in bpy.types)
View3DShading.cycles (in module bpy.types)
View3DShading.selected_studio_light (in module bpy.types)
view_all() (in module bpy.ops.action)
(in module bpy.ops.clip)
(in module bpy.ops.graph)
(in module bpy.ops.image)
(in module bpy.ops.nla)
(in module bpy.ops.node)
(in module bpy.ops.sequencer)
(in module bpy.ops.view3d)
view_all_preview() (in module bpy.ops.sequencer)
view_axis() (in module bpy.ops.view3d)
view_camera() (in module bpy.ops.view3d)
view_camera_offset (bpy.types.RegionView3D attribute)
view_camera_zoom (bpy.types.RegionView3D attribute)
view_cancel() (in module bpy.ops.render)
view_center_camera() (in module bpy.ops.view3d)
view_center_cursor() (in module bpy.ops.clip)
(in module bpy.ops.image)
(in module bpy.ops.view3d)
view_center_lock() (in module bpy.ops.view3d)
view_center_pick() (in module bpy.ops.view3d)
view_distance (bpy.types.RegionView3D attribute)
view_draw() (bpy.types.RenderEngine method)
view_frame() (bpy.types.Camera method)
(in module bpy.ops.action)
(in module bpy.ops.graph)
(in module bpy.ops.nla)
(in module bpy.ops.sequencer)
view_frame_keyframes (bpy.types.PreferencesView attribute)
view_frame_seconds (bpy.types.PreferencesView attribute)
view_frame_type (bpy.types.PreferencesView attribute)
view_ghost_border() (in module bpy.ops.sequencer)
view_height (bpy.types.WalkNavigation attribute)
view_layer (bpy.types.Window attribute)
(in module bpy.context)
,
[1]
view_layer_add() (in module bpy.ops.scene)
view_layer_remove() (in module bpy.ops.scene)
view_location (bpy.types.RegionView3D attribute)
view_lock_clear() (in module bpy.ops.view3d)
view_lock_to_active() (in module bpy.ops.view3d)
view_matrix (bpy.types.RegionView3D attribute)
view_ndof() (in module bpy.ops.clip)
(in module bpy.ops.image)
view_orbit() (in module bpy.ops.view3d)
view_overlay (bpy.types.ThemeView3D attribute)
view_pan() (in module bpy.ops.clip)
(in module bpy.ops.image)
(in module bpy.ops.view3d)
view_perspective (bpy.types.RegionView3D attribute)
view_persportho() (in module bpy.ops.view3d)
view_roll() (in module bpy.ops.view3d)
view_rotate_method (bpy.types.PreferencesInput attribute)
view_rotate_sensitivity_trackball (bpy.types.PreferencesInput attribute)
view_rotate_sensitivity_turntable (bpy.types.PreferencesInput attribute)
view_rotation (bpy.types.RegionView3D attribute)
view_selected() (in module bpy.ops.action)
(in module bpy.ops.clip)
(in module bpy.ops.graph)
(in module bpy.ops.image)
(in module bpy.ops.nla)
(in module bpy.ops.node)
(in module bpy.ops.sequencer)
(in module bpy.ops.view3d)
view_show() (in module bpy.ops.render)
view_sliders (bpy.types.ThemeDopeSheet attribute)
(bpy.types.ThemeNLAEditor attribute)
view_to_region() (bpy.types.View2D method)
view_toggle() (in module bpy.ops.sequencer)
view_transform (bpy.types.ColorManagedViewSettings attribute)
view_type (bpy.types.SpaceSequenceEditor attribute)
view_update() (bpy.types.RenderEngine method)
view_zoom() (in module bpy.ops.clip)
(in module bpy.ops.image)
view_zoom_axis (bpy.types.PreferencesInput attribute)
view_zoom_border() (in module bpy.ops.image)
view_zoom_in() (in module bpy.ops.clip)
(in module bpy.ops.image)
view_zoom_method (bpy.types.PreferencesInput attribute)
view_zoom_out() (in module bpy.ops.clip)
(in module bpy.ops.image)
view_zoom_ratio() (in module bpy.ops.clip)
(in module bpy.ops.image)
(in module bpy.ops.sequencer)
ViewEdge (class in freestyle.types)
viewedge (freestyle.types.FEdge attribute)
ViewEdgeIterator (class in freestyle.types)
viewer_border() (in module bpy.ops.node)
ViewLayer (class in bpy.types)
ViewLayer.cycles (in module bpy.types)
ViewLayer.depsgraph (in module bpy.types)
ViewLayer.freestyle_settings (in module bpy.types)
ViewLayer.layer_collection (in module bpy.types)
ViewLayer.objects (in module bpy.types)
viewlayer_render (bpy.types.GPencilLayer attribute)
VIEWLAYER_UL_linesets (class in bpy.types)
ViewLayers (class in bpy.types)
ViewMap (class in freestyle.types)
ViewMapGradientNormBP1D (class in freestyle.predicates)
viewport_aa (bpy.types.PreferencesSystem attribute)
(bpy.types.SceneDisplay attribute)
viewport_display_mode (bpy.types.DomainFluidSettings attribute)
views_format (bpy.types.Image attribute)
(bpy.types.ImageFormatSettings attribute)
(bpy.types.ImageSequence attribute)
(bpy.types.MovieSequence attribute)
(bpy.types.RenderSettings attribute)
ViewShape (class in freestyle.types)
viewshape (freestyle.types.ViewEdge attribute)
ViewVertex (class in freestyle.types)
viewvertex (freestyle.types.SVertex attribute)
virtual_parents (bpy.types.ParticleSettings attribute)
viscosity_base (bpy.types.DomainFluidSettings attribute)
viscosity_exponent (bpy.types.DomainFluidSettings attribute)
visibility (bpy.types.FreestyleLineSet attribute)
visibility_bleed_bias (bpy.types.LightProbe attribute)
visibility_blur (bpy.types.LightProbe attribute)
visibility_buffer_bias (bpy.types.LightProbe attribute)
visibility_collection (bpy.types.LightProbe attribute)
visible (freestyle.types.StrokeAttribute attribute)
visible_bones (in module bpy.context)
visible_fcurves (in module bpy.context)
visible_get() (bpy.types.LayerCollection method)
(bpy.types.Object method)
visible_gpencil_layers (in module bpy.context)
visible_in_viewport_get() (bpy.types.Object method)
visible_objects (in module bpy.context)
visible_pose_bones (in module bpy.context)
visual_transform_apply() (in module bpy.ops.object)
(in module bpy.ops.pose)
volume (aud.Device attribute)
(aud.DynamicMusic attribute)
(aud.Handle attribute)
(bpy.types.BoidState attribute)
(bpy.types.MaintainVolumeConstraint attribute)
(bpy.types.SoundSequence attribute)
(bpy.types.Speaker attribute)
(bpy.types.StretchToConstraint attribute)
volume_density (bpy.types.SmokeFlowSettings attribute)
volume_initialization (bpy.types.FluidFluidSettings attribute)
(bpy.types.InflowFluidSettings attribute)
(bpy.types.ObstacleFluidSettings attribute)
(bpy.types.OutflowFluidSettings attribute)
volume_max (bpy.types.Speaker attribute)
volume_maximum (aud.Handle attribute)
(aud.SequenceEntry attribute)
volume_min (bpy.types.Speaker attribute)
volume_minimum (aud.Handle attribute)
(aud.SequenceEntry attribute)
volume_tetrahedron() (in module mathutils.geometry)
volumetric_end (bpy.types.SceneEEVEE attribute)
volumetric_light_clamp (bpy.types.SceneEEVEE attribute)
volumetric_sample_distribution (bpy.types.SceneEEVEE attribute)
volumetric_samples (bpy.types.SceneEEVEE attribute)
volumetric_shadow_samples (bpy.types.SceneEEVEE attribute)
volumetric_start (bpy.types.SceneEEVEE attribute)
volumetric_tile_size (bpy.types.SceneEEVEE attribute)
voronoi() (in module mathutils.noise)
voronoi_dimensions (bpy.types.ShaderNodeTexVoronoi attribute)
VoronoiTexture (class in bpy.types)
VoronoiTexture.users_material (in module bpy.types)
VoronoiTexture.users_object_modifier (in module bpy.types)
vortex (bpy.types.EffectorWeights attribute)
vorticity (bpy.types.SmokeDomainSettings attribute)
voxel_cell_size (bpy.types.ClothSettings attribute)
voxel_remesh() (in module bpy.ops.object)