baking module

The baking module allows to set baking parameters and launch baking
of mesh maps.

Example

import substance_painter.baking as baking
import substance_painter.textureset as textureset
from substance_painter.baking import BakingParameters, MeshMapUsage, CurvatureMethod
from PySide2 import QtCore

# set baking parameters
baking_params = BakingParameters.from_texture_set_name("Name for ts")
texture_set = baking_params.texture_set()
common_params = baking_params.common()
# use QUrl to correctly format the file path with file:/// prefix
highpoly_mesh_path = QtCore.QUrl.fromLocalFile("C:/Documents/highpoly.fbx").toString()
ao_params = baking_params.baker(MeshMapUsage.AO)
BakingParameters.set({
    common_params['OutputSize'] : (10,10),
    common_params['HipolyMesh'] : highpoly_mesh_path,
    ao_params['Distribution'] : ao_params['Distribution'].enum_value('Cosine')})

# check if common parameters are shared between Texture Sets (True at project creation)
common_params_are_shared = bool(baking.get_link_group_common_parameters())

# unlink common parameters. The common parameters for all Texture Sets become independent
baking.unlink_all_common_parameters()

# recheck whether common parameters are shared between Texture Sets (now False)
common_params_are_linked = bool(baking.get_link_group_common_parameters())

ts1 = textureset.TextureSet.from_name("Name for ts1")
ts2 = textureset.TextureSet.from_name("Name for ts2")

# get the list of Texture Sets which are linked for AO with ts1
# it's not yet linked, so returns only [ts1]
linked_with_ts1 = baking.get_linked_texture_sets(ts1, MeshMapUsage.AO)

# link AO baking parameters for ts1 and ts2 together into a group,
# keeping ts1 parameters for both
baking.set_linked_group([ts1,ts2], ts1, MeshMapUsage.AO)

# get the new list of Texture Sets which are linked with ts1
# now they are linked, so it returns [ts1, ts2]
linked_with_ts1 = baking.get_linked_texture_sets(ts1, MeshMapUsage.AO)

# finally unlink AO baking parameters
baking.unlink_all(MeshMapUsage.AO)

# get curvature method
curvature_method = baking_params.get_curvature_method()

# set curvature method
baking_params.set_curvature_method(CurvatureMethod.FromMesh)

# check whether the baking is enabled on the Texture Set level and enable it
baking_params.is_textureset_enabled()
baking_params.set_textureset_enabled(True)

# check if AO usage is enabled for baking and enable it
baking_params.is_baker_enabled(MeshMapUsage.AO)
baking_params.set_baker_enabled(MeshMapUsage.AO, True)

# get all usages enabled for baking
baking_params.get_enabled_bakers()

# set usages enabled for baking
baking_params.set_enabled_bakers([MeshMapUsage.AO, MeshMapUsage.Normal])

# check if one UV Tile is enabled for baking, disable it
baking_params.is_uv_tile_enabled(texture_set.uv_tile(0,0))
baking_params.set_uv_tile_enabled(texture_set.uv_tile(0,0), False)

# get all UV Tiles enabled for baking
baking_params.get_enabled_uv_tiles()
# set UV Tiles enabled for baking
baking_params.set_enabled_uv_tiles([texture_set.uv_tile(0,0), texture_set.uv_tile(0,1)])

class substance_painter.baking.BakingStatus(value) substance_painter.baking.BakingStatus

Status code of the baking process.

Members:

class substance_painter.baking.CurvatureMethod(value) substance_painter.baking.CurvatureMethod

Members:

FromMesh, FromNormalMap

class substance_painter.baking.BakingParameters(material_id: int) substance_painter.baking.BakingParameters

Baking parameters for a given texture set.

Example

# This example shows how to discover the names of the baking parameters
import substance_painter as sp

# Get the first texture set of the current project
textureset = sp.textureset.all_texture_sets()[0]
# Retrieve baking parameters
baking_params = sp.baking.BakingParameters.from_texture_set(textureset)

# Print the keys of the common baking parameters
print(f'Common: {baking_params.common().keys()}')
# Print the keys of the baking parameters of the AO mesh map
print(f'AO: {baking_params.baker(sp.baking.MeshMapUsage.AO).keys()}')

Parameters: material_id (int)

static from_texture_set(texture_set: TextureSet) -> BakingParameters substance_painter.baking.BakingParameters.from_texture_set

Get the baking parameters for the given texture set object.

Parameters: texture_set (TextureSet) – The texture set.

Returns: The baking parameters for the given texure set.

Return type: BakingParameters

static from_texture_set_name(texture_set_name: str) -> BakingParameters substance_painter.baking.BakingParameters.from_texture_set_name

Get the baking parameters for the given texture set name.

Parameters: texture_set_name (str) – The texture set name.

Returns: The baking parameters for the given texure set.

Return type: BakingParameters

texture_set() -> TextureSet substance_painter.baking.BakingParameters.texture_set

Get the associated texture set.

Returns: The texture set associated with this BakingParameters instance.

Return type: TextureSet

common() -> Dict[str, Property] substance_painter.baking.BakingParameters.common

Get the parameters common to all bakers, like baking resolution.

Returns: The common parameters.

Return type: Dict[str, Property]

baker(baked_map: MeshMapUsage) -> Dict[str, Property] substance_painter.baking.BakingParameters.baker

Get the parameters specific to a given baked map.

Parameters: baked_map (MeshMapUsage) – The baked map usage.

Returns: The corresponding baked map parameters.

Return type: Dict[str, Property]

static set(property_values: Dict[Property, bool | int | Tuple[int, int] | Tuple[int, int, int] | Tuple[int, int, int, int] | float | Tuple[float, float] | Tuple[float, float, float] | Color | Tuple[Color, float] | Tuple[float, float, float, float] | str]) -> None substance_painter.baking.BakingParameters.set

Set property values in batch.

Parameters:

property_values (Dict*[Property,* PropertyValue*]*) – A dict of properties
to be set with their corresponding new values.

Return type: None

get_curvature_method() -> CurvatureMethod substance_painter.baking.BakingParameters.get_curvature_method

Get the curvature method used for baking

Returns: The curvature method used for baking

Return type: CurvatureMethod

set_curvature_method(method: CurvatureMethod) substance_painter.baking.BakingParameters.set_curvature_method

Set the curvature method to use for baking

Parameters: method (CurvatureMethod) – The new method to use for baking

is_baker_enabled(usage: MeshMapUsage) -> bool substance_painter.baking.BakingParameters.is_baker_enabled

Whether some usage is enabled for baking.

Parameters: usage (MeshMapUsage) – The baked map usage.

Returns: True if the corresponding usage is enabled for baking.

Return type: bool

set_baker_enabled(usage: MeshMapUsage, enable: bool) -> None substance_painter.baking.BakingParameters.set_baker_enabled

Enable or disable a usage for baking.

Parameters:

Return type: None

get_enabled_bakers() -> List[MeshMapUsage] substance_painter.baking.BakingParameters.get_enabled_bakers

Get all usages enabled for baking.

Returns: Enabled usages.

Return type: List[MeshMapUsage]

set_enabled_bakers(enabled_usages: List[MeshMapUsage]) -> None substance_painter.baking.BakingParameters.set_enabled_bakers

Set usages enabled for baking. Usages not in this list will be disabled.

Parameters: enabled_usages (List*[MeshMapUsage]*) – Enabled usages.

Return type: None

is_textureset_enabled() -> bool substance_painter.baking.BakingParameters.is_textureset_enabled

Whether this Texture Set is enabled for baking.

Returns: True if this Texture Set is enabled for baking.

Return type: bool

set_textureset_enabled(enable: bool) -> None substance_painter.baking.BakingParameters.set_textureset_enabled

Enable or disable this Texture Set for baking.

Parameters: enable (bool) – Enable or disable.

Return type: None

is_uv_tile_enabled(uv_tile: UVTile) -> bool substance_painter.baking.BakingParameters.is_uv_tile_enabled

Whether a UV Tile is enabled for baking.

Parameters:

Returns: True if the UV Tile is enabled for baking.

Return type: bool

set_uv_tile_enabled(uv_tile: UVTile, enable: bool) -> None substance_painter.baking.BakingParameters.set_uv_tile_enabled

Enable or disable an UV Tile for baking.

Parameters:

Return type: None

get_enabled_uv_tiles() -> List[UVTile] substance_painter.baking.BakingParameters.get_enabled_uv_tiles

Get all UV Tiles enabled for baking.

Returns: Enabled UV Tiles.

Return type: List[UVTile]

set_enabled_uv_tiles(enabled_uv_tiles: List[UVTile]) -> None substance_painter.baking.BakingParameters.set_enabled_uv_tiles

Set UV Tiles enabled for baking. All other tiles will be disabled.

Parameters: enabled_uv_tiles (List*[UVTile]*) – Enabled UV Tiles.

Return type: None

substance_painter.baking.set_linked_group(group: List[TextureSet], reference: TextureSet, usage: MeshMapUsage) -> None substance_painter.baking.set_linked_group

Make a group of Texture Sets share the same baking parameters for the given ‘usage’. After that,
editing the ‘usage’ parameters of one of the group’s Texture Set will impact the whole group.

Parameters:

Return type: None

substance_painter.baking.set_linked_group_common_parameters(group: List[TextureSet], reference: TextureSet) -> None substance_painter.baking.set_linked_group_common_parameters

Make a group of Texture Sets share the same baking common parameters. After that, editing a
common parameter of one of the group’s Texture Set will impact the whole group.

Parameters:

Return type: None

substance_painter.baking.unlink_all(usage: MeshMapUsage) -> None substance_painter.baking.unlink_all

Unlink all Texture Sets for a given usage. That is, remove the group if it exists, so that all
Texture Sets have their own copy of the parameters.

Parameters: usage (MeshMapUsage) – Usage to unlink.

Return type: None

substance_painter.baking.unlink_all_common_parameters() -> None substance_painter.baking.unlink_all_common_parameters

Unlink all Texture Sets for common parameters. That is, remove the group if exists, so that all
Texture Sets have their own copy of the parameters.

Return type: None

substance_painter.baking.get_link_group(usage: MeshMapUsage) -> List[TextureSet] substance_painter.baking.get_link_group

Get the list of Texture Sets that share baking parameters for a given usage.

Parameters: usage (MeshMapUsage) – Usage to query.

Returns:

All linked Texture Sets for the usage. Empty list if no Texture Set are
linked.

Return type: List[TextureSet]

substance_painter.baking.get_link_group_common_parameters() -> List[TextureSet] substance_painter.baking.get_link_group_common_parameters

Get the list of Texture Sets that share common baking parameters.

Returns:

All linked Texture Sets for common parameters. Empty list if no Texture
Set are linked.

Return type: List[TextureSet]

substance_painter.baking.get_linked_texture_sets(texture_set: TextureSet, usage: MeshMapUsage) -> List[TextureSet] substance_painter.baking.get_linked_texture_sets

Get the list of Texture Sets that share the same parameters as some Texture Set, for a given
usage.

Parameters:

Returns:

The list of Texture Sets sharing parameters with the input Texture Set.
Contains at least the input Texture Set if no group exists for the usage.

Return type: List[TextureSet]

substance_painter.baking.get_linked_texture_sets_common_parameters(texture_set: TextureSet) -> List[TextureSet] substance_painter.baking.get_linked_texture_sets_common_parameters

Get the list of Texture Sets that share the same parameters as some Texture Set, for common
parameters.

Parameters: texture_set (TextureSet) – The Texture Set to query

Returns:

The list of Texture Sets sharing common parameters with the input Texture
Set. Contains at least the input Texture Set if no group exists for common parameters.

Return type: List[TextureSet]

substance_painter.baking.bake_async(texture_set: TextureSet) -> StopSource substance_painter.baking.bake_async

Launch the baking process for a Texture Set, using the current baking configuration.
The configuration is set by setting baking parameters, enabling Texture Set, selecting UV Tiles
for baking, setting curvature method etc.
This function is asynchronous. When the baking process is finished, the
substance_painter.event.BakingProcessEnded event is sent.

Parameters: texture_set (TextureSet) – The Texture Set to bake.

Returns: Can be used to cancel the asynchronous computation.

Return type: StopSource

substance_painter.baking.bake_selected_textures_async() -> StopSource substance_painter.baking.bake_selected_textures_async

Launch the baking process, using the current baking configuration.
The configuration is set by setting baking parameters, enabling Texture Set, selecting UV Tiles
for baking, setting curvature method etc.
This function is asynchronous. When the baking process is finished, the
substance_painter.event.BakingProcessEnded event is sent.

Returns: Can be used to cancel the asynchronous computation.

Return type: StopSource