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

filepath

Image filepath to use when saving externally

Type

string, default “”, (never None)

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

  • ADJACENT_FACES Adjacent Faces – Use pixels from adjacent faces across UV seams.

  • EXTEND Extend – Extend border pixels outwards.

Type

enum in [‘ADJACENT_FACES’, ‘EXTEND’], 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 [‘POS_X’, ‘POS_Y’, ‘POS_Z’, ‘NEG_X’, ‘NEG_Y’, ‘NEG_Z’], default ‘POS_X’

normal_g

Axis to bake in green channel

Type

enum in [‘POS_X’, ‘POS_Y’, ‘POS_Z’, ‘NEG_X’, ‘NEG_Y’, ‘NEG_Z’], default ‘POS_X’

normal_r

Axis to bake in red channel

Type

enum in [‘POS_X’, ‘POS_Y’, ‘POS_Z’, ‘NEG_X’, ‘NEG_Y’, ‘NEG_Z’], default ‘POS_X’

normal_space

Choose normal space for baking

  • OBJECT Object – Bake the normals in object space.

  • TANGENT Tangent – Bake the normals in tangent space.

Type

enum in [‘OBJECT’, ‘TANGENT’], default ‘OBJECT’

pass_filter

Passes to include in the active baking pass

Type

enum set in {‘NONE’, ‘EMIT’, ‘DIRECT’, ‘INDIRECT’, ‘COLOR’, ‘DIFFUSE’, ‘GLOSSY’, ‘TRANSMISSION’}, default {}, (readonly)

save_mode

Where to save baked image textures

  • INTERNAL Internal – Save the baking map in an internal image data-block.

  • EXTERNAL External – Save the baking map in an external file.

Type

enum in [‘INTERNAL’, ‘EXTERNAL’], default ‘INTERNAL’

target

Where to output the baked map

  • IMAGE_TEXTURES Image Textures – Bake to image data-blocks associated with active image texture nodes in materials.

  • VERTEX_COLORS Vertex Colors – Bake to active vertex color layer on meshes.

Type

enum in [‘IMAGE_TEXTURES’, ‘VERTEX_COLORS’], default ‘IMAGE_TEXTURES’

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_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

width

Horizontal dimension of the baking map

Type

int in [4, 10000], default 512

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

Inherited Functions

References