Material(ID)

base classes — bpy_struct, ID

class bpy.types.Material(ID)

Material data-block to define the appearance of geometric objects for rendering

alpha_threshold

A pixel is rendered only if its alpha value is above this threshold

Type:

float in [0, 1], default 0.5

animation_data

Animation data for this data-block

Type:

AnimData, (readonly)

blend_method

Blend Mode for Transparent Faces

• OPAQUE Opaque – Render surface without transparency.

• CLIP Alpha Clip – Use the alpha threshold to clip the visibility (binary visibility).

• HASHED Alpha Hashed – Use noise to dither the binary visibility (works well with multi-samples).

• BLEND Alpha Blend – Render polygon transparent, depending on alpha channel of the texture.

Type:

enum in [‘OPAQUE’, ‘CLIP’, ‘HASHED’, ‘BLEND’], default ‘OPAQUE’

cycles

Cycles material settings

Type:

CyclesMaterialSettings, (readonly)

diffuse_color

Diffuse color of the material

Type:

float array of 4 items in [0, inf], default (0.8, 0.8, 0.8, 0.8)

displacement_method

Method to use for the displacement

• BUMP Bump Only – Bump mapping to simulate the appearance of displacement.

• DISPLACEMENT Displacement Only – Use true displacement of surface only, requires fine subdivision.

• BOTH Displacement and Bump – Combination of true displacement and bump mapping for finer detail.

Type:

enum in [‘BUMP’, ‘DISPLACEMENT’, ‘BOTH’], default ‘BUMP’

grease_pencil

Grease pencil color settings for material

Type:

MaterialGPencilStyle, (readonly)

is_grease_pencil

True if this material has grease pencil data

Type:

boolean, default False, (readonly)

lightprobe_volume_single_sided

Consider material single sided for light probe volume capture. Additionally helps rejecting probes inside the object to avoid light leaks

Type:

boolean, default False

line_color

Line color used for Freestyle line rendering

Type:

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

line_priority

The line color of a higher priority is used at material boundaries

Type:

int in [0, 32767], default 0

lineart

Line art settings for material

Type:

MaterialLineArt, (readonly)

max_vertex_displacement

The max distance a vertex can be displaced. Displacements over this threshold may cause visibility issues

Type:

float in [0, inf], default 0.0

metallic

Amount of mirror reflection for raytrace

Type:

float in [0, 1], default 0.0

node_tree

Node tree for node based materials

Type:

NodeTree, (readonly)

paint_active_slot

Index of active texture paint slot

Type:

int in [0, 32767], default 0

paint_clone_slot

Index of clone texture paint slot

Type:

int in [0, 32767], default 0

pass_index

Index number for the “Material Index” render pass

Type:

int in [0, 32767], default 0

preview_render_type

Type of preview render

• FLAT Flat – Flat XY plane.

• SPHERE Sphere – Sphere.

• CUBE Cube – Cube.

• HAIR Hair – Hair strands.

• SHADERBALL Shader Ball – Shader ball.

• CLOTH Cloth – Cloth.

• FLUID Fluid – Fluid.

Type:

enum in [‘FLAT’, ‘SPHERE’, ‘CUBE’, ‘HAIR’, ‘SHADERBALL’, ‘CLOTH’, ‘FLUID’], default ‘SPHERE’

refraction_depth

Approximate the thickness of the object to compute two refraction events (0 is disabled)

Type:

float in [0, inf], default 0.0

roughness

Roughness of the material

Type:

float in [0, 1], default 0.4

shadow_method

Shadow mapping method

• NONE None – Material will cast no shadow.

• OPAQUE Opaque – Material will cast shadows without transparency.

• CLIP Alpha Clip – Use the alpha threshold to clip the visibility (binary visibility).

• HASHED Alpha Hashed – Use noise to dither the binary visibility and use filtering to reduce the noise.

Type:

enum in [‘NONE’, ‘OPAQUE’, ‘CLIP’, ‘HASHED’], default ‘OPAQUE’

show_transparent_back

Render multiple transparent layers (may introduce transparency sorting problems)

Type:

boolean, default False

specular_color

Specular color of the material

Type:

mathutils.Color of 3 items in [0, inf], default (1.0, 1.0, 1.0)

specular_intensity

How intense (bright) the specular reflection is

Type:

float in [0, 1], default 0.5

surface_render_method

Controls the blending and the compatibility with certain features

• DITHERED Dithered – Allows for grayscale hashed transparency, and compatible with render passes and raytracing. Also known as deferred rendering.

• BLENDED Blended – Allows for colored transparency, but incompatible with render passes and raytracing. Also known as forward rendering.

Type:

enum in [‘DITHERED’, ‘BLENDED’], default ‘DITHERED’

texture_paint_images

Texture images used for texture painting

Type:

bpy_prop_collection of Image, (readonly)

texture_paint_slots

Texture slots defining the mapping and influence of textures

Type:

bpy_prop_collection of TexPaintSlot, (readonly)

use_backface_culling

Use back face culling to hide the back side of faces

Type:

boolean, default False

use_backface_culling_shadow

Use back face culling when casting shadows

Type:

boolean, default False

use_nodes

Use shader nodes to render the material

Type:

boolean, default False

use_preview_world

Use the current world background to light the preview render

Type:

boolean, default False

use_screen_refraction

Use raytracing to determine refracted color instead of using only light probes. This prevents the surface from contributing to the lighting of surfaces not using this setting

Type:

boolean, default False

use_sss_translucency

Add translucency effect to subsurface

Type:

boolean, default False

use_transparent_shadow

Use transparent shadows for this material if it contains a Transparent BSDF, disabling will render faster but not give accurate shadows

Type:

boolean, default True

volume_intersection_method

Determines which inner part of the mesh will produce volumetric effect

• FAST Fast – Each face is considered as a medium interface. Gives correct results for manifold geometry that contains no inner parts.

• ACCURATE Accurate – Faces are considered as medium interface only when they have different consecutive facing. Gives correct results as long as the max ray depth is not exceeded. Have significant memory overhead compared to the fast method.

Type:

enum in [‘FAST’, ‘ACCURATE’], default ‘FAST’

classmethod bl_rna_get_subclass(id, default=None)

Parameters:

id (string) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters:

id (string) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

bpy_struct.id_data ID.name ID.name_full ID.id_type ID.session_uid ID.is_evaluated ID.original ID.users ID.use_fake_user ID.use_extra_user

ID.is_embedded_data ID.is_missing ID.is_runtime_data ID.tag ID.is_library_indirect ID.library ID.library_weak_reference ID.asset_data ID.override_library ID.preview

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset

bpy_struct.type_recast bpy_struct.values ID.evaluated_get ID.copy ID.asset_mark ID.asset_clear ID.asset_generate_preview ID.override_create ID.override_hierarchy_create ID.user_clear ID.user_remap ID.make_local ID.user_of_id ID.animation_data_create ID.animation_data_clear ID.update_tag ID.preview_ensure ID.bl_rna_get_subclass ID.bl_rna_get_subclass_py

References

bpy.context.material ArrayGpencilModifier.material BlendData.materials BlendDataMaterials.create_gpencil_data BlendDataMaterials.new BlendDataMaterials.remove BlendDataMaterials.remove_gpencil_data BrushGpencilSettings.material BrushGpencilSettings.material_alt ColorGpencilModifier.material Curve.materials Curves.materials DashGpencilModifierData.material EnvelopeGpencilModifier.material GeometryNodeInputMaterial.material GreasePencil.materials GreasePencilColorModifier.material_filter GreasePencilMirrorModifier.material_filter GreasePencilNoiseModifier.material_filter GreasePencilOffsetModifier.material_filter GreasePencilOpacityModifier.material_filter GreasePencilSmoothModifier.material_filter GreasePencilSubdivModifier.material_filter GreasePencilThickModifierData.material_filter GreasePencilTintModifier.material_filter HookGpencilModifier.material IDMaterials.append IDMaterials.pop

LatticeGpencilModifier.material LengthGpencilModifier.material LineartGpencilModifier.target_material MaterialSlot.material Mesh.materials MetaBall.materials MirrorGpencilModifier.material MultiplyGpencilModifier.material NodeSocketMaterial.default_value NodeTreeInterfaceSocketMaterial.default_value NoiseGpencilModifier.material Object.active_material OffsetGpencilModifier.material OpacityGpencilModifier.material OutlineGpencilModifier.material OutlineGpencilModifier.outline_material PointCloud.materials ShrinkwrapGpencilModifier.material SimplifyGpencilModifier.material SmoothGpencilModifier.material SubdivGpencilModifier.material TextureGpencilModifier.material ThickGpencilModifier.material TintGpencilModifier.material ViewLayer.material_override Volume.materials WeightAngleGpencilModifier.material WeightProxGpencilModifier.material