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.

Type:

float in [0, inf], default 0.0

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

  • OBJECT Object – Bake the displacement in object space.

  • TANGENT Tangent – Bake the displacement in tangent space.

Type:

enum in ['OBJECT', 'TANGENT'], default 'OBJECT'

filepath

Image filepath to use when saving externally

Type:

string, default “”, (never None, blend relative // prefix supported)

height

Vertical dimension of the baking map

Type:

int in [4, 10000], default 512

image_settings
Type:

ImageFormatSettings, (readonly, never None)

margin

Extends the baked result as a post process filter

Type:

int in [0, 32767], default 16

margin_type

Algorithm to extend the baked result

Type:

enum in Bake Margin Type Items, default 'ADJACENT_FACES'

max_ray_distance

The maximum ray distance for matching points between the active and selected objects. If zero, there is no limit.

Type:

float in [0, inf], default 0.0

normal_b

Axis to bake in blue channel

Type:

enum in Normal Swizzle Items, default 'POS_X'

normal_g

Axis to bake in green channel

Type:

enum in Normal Swizzle Items, default 'POS_X'

normal_r

Axis to bake in red channel

Type:

enum in Normal Swizzle Items, default 'POS_X'

normal_space

Choose normal space for baking

Type:

enum in Normal Space Items, default 'TANGENT'

pass_filter

Passes to include in the active baking pass

Type:

enum set in Bake Pass Filter Type Items, default {'COLOR', 'DIFFUSE', 'DIRECT', 'EMIT', 'GLOSSY', 'INDIRECT', 'TRANSMISSION'}, (readonly)

save_mode

Where to save baked image textures

Type:

enum in Bake Save Mode Items, default 'INTERNAL'

target

Where to output the baked map

Type:

enum in Bake Target Items, default 'IMAGE_TEXTURES'

type

Choose shading information to bake into the image

  • NORMALS Normals – Bake normals.

  • DISPLACEMENT Displacement – Bake displacement.

  • VECTOR_DISPLACEMENT Vector Displacement – Bake vector displacement.

Type:

enum in ['NORMALS', 'DISPLACEMENT', 'VECTOR_DISPLACEMENT'], default 'NORMALS'

use_automatic_name

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

Type:

boolean, default False

use_cage

Cast rays to active object from a cage

Type:

boolean, default False

use_clear

Clear Images before baking (internal only)

Type:

boolean, default True

use_lores_mesh

Calculate heights against unsubdivided low resolution mesh

Type:

boolean, default False

use_multires

Bake directly from multires object

Type:

boolean, default False

use_pass_color

Color the pass

Type:

boolean, default True

use_pass_diffuse

Add diffuse contribution

Type:

boolean, default True

use_pass_direct

Add direct lighting contribution

Type:

boolean, default True

use_pass_emit

Add emission contribution

Type:

boolean, default True

use_pass_glossy

Add glossy contribution

Type:

boolean, default True

use_pass_indirect

Add indirect lighting contribution

Type:

boolean, default True

use_pass_transmission

Add transmission contribution

Type:

boolean, default True

use_selected_to_active

Bake shading on the surface of selected objects to the active object

Type:

boolean, default False

use_split_materials

Split external images per material (external only)

Type:

boolean, default False

view_from

Source of reflection ray directions

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

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

Type:

enum in ['ABOVE_SURFACE', 'ACTIVE_CAMERA'], default 'ABOVE_SURFACE'

width

Horizontal dimension of the baking map

Type:

int in [4, 10000], default 512

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

id (str) – 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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References