BakeSettings(bpy_struct)

base class — bpy_struct

class bpy.types.BakeSettings(bpy_struct)

Bake data for a Scene data-block

cage_extrusion

Inflate the active object by the specified distance for baking. This helps matching to points nearer to the outside of the selected object meshes. (in [0, inf], default 0.0)

Type:

float

cage_object

Object to use as cage instead of calculating the cage from the active object with cage extrusion

Type:

Object

displacement_space

Choose displacement space for baking (default 'OBJECT')

  • OBJECT Object – Bake the displacement in object space.

  • TANGENT Tangent – Bake the displacement in tangent space.

Type:

Literal[‘OBJECT’, ‘TANGENT’]

filepath

Image filepath to use when saving externally (default “”, never None, blend relative // prefix supported)

Type:

str

height

Vertical dimension of the baking map (in [4, 10000], default 512)

Type:

int

image_settings

(readonly, never None)

Type:

ImageFormatSettings

margin

Extends the baked result as a post process filter (in [0, 32767], default 16)

Type:

int

margin_type

Algorithm to extend the baked result (default 'ADJACENT_FACES')

Type:

Literal[Bake Margin Type Items]

max_ray_distance

The maximum ray distance for matching points between the active and selected objects. If zero, there is no limit. (in [0, inf], default 0.0)

Type:

float

normal_b

Axis to bake in blue channel (default 'POS_X')

Type:

Literal[Normal Swizzle Items]

normal_g

Axis to bake in green channel (default 'POS_X')

Type:

Literal[Normal Swizzle Items]

normal_r

Axis to bake in red channel (default 'POS_X')

Type:

Literal[Normal Swizzle Items]

normal_space

Choose normal space for baking (default 'TANGENT')

Type:

Literal[Normal Space Items]

pass_filter

Passes to include in the active baking pass (default {'COLOR', 'DIFFUSE', 'DIRECT', 'EMIT', 'GLOSSY', 'INDIRECT', 'TRANSMISSION'}, readonly)

Type:

set[Literal[Bake Pass Filter Type Items]]

save_mode

Where to save baked image textures (default 'INTERNAL')

Type:

Literal[Bake Save Mode Items]

target

Where to output the baked map (default 'IMAGE_TEXTURES')

Type:

Literal[Bake Target Items]

type

Choose shading information to bake into the image (default 'NORMALS')

  • NORMALS Normals – Bake normals.

  • DISPLACEMENT Displacement – Bake displacement.

  • VECTOR_DISPLACEMENT Vector Displacement – Bake vector displacement.

Type:

Literal[‘NORMALS’, ‘DISPLACEMENT’, ‘VECTOR_DISPLACEMENT’]

use_automatic_name

Automatically name the output file with the pass type (external only) (default False)

Type:

bool

use_cage

Cast rays to active object from a cage (default False)

Type:

bool

use_clear

Clear Images before baking (internal only) (default True)

Type:

bool

use_lores_mesh

Calculate heights against unsubdivided low resolution mesh (default False)

Type:

bool

use_multires

Bake directly from multires object (default False)

Type:

bool

use_pass_color

Color the pass (default True)

Type:

bool

use_pass_diffuse

Add diffuse contribution (default True)

Type:

bool

use_pass_direct

Add direct lighting contribution (default True)

Type:

bool

use_pass_emit

Add emission contribution (default True)

Type:

bool

use_pass_glossy

Add glossy contribution (default True)

Type:

bool

use_pass_indirect

Add indirect lighting contribution (default True)

Type:

bool

use_pass_transmission

Add transmission contribution (default True)

Type:

bool

use_selected_to_active

Bake shading on the surface of selected objects to the active object (default False)

Type:

bool

use_split_materials

Split external images per material (external only) (default False)

Type:

bool

view_from

Source of reflection ray directions (default 'ABOVE_SURFACE')

  • ABOVE_SURFACE Above Surface – Cast rays from above the surface.

  • ACTIVE_CAMERA Active Camera – Use the active camera’s position to cast rays.

Type:

Literal[‘ABOVE_SURFACE’, ‘ACTIVE_CAMERA’]

width

Horizontal dimension of the baking map (in [4, 10000], default 512)

Type:

int

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References