Product documentation · Current desktop UI

Substance Painter API

3 bundled Tech Connector wrapper functions in the current source catalog. This is not a count of the host application’s native API. A listed function may require its host application and bridge to be available.

← All hosts

Bundled Python wrappers

  1. apply_material
  2. create_project
  3. export_textures

apply_material

api.dcc.substance_painter.apply_material(...)
Signature
apply_material(material_name: str, texture_set: str = "") -> dict[str, Any]
Target
substance_painter_tools.material.apply_material
Source
substance_painter_tools/material.py:8
Name status
Friendly call available

Parameters

  • material_name · str · required
  • texture_set · str · default ''

create_project

api.dcc.substance_painter.create_project(...)
Signature
create_project(mesh_path: str, template_name: str = "PBR - Metallic Roughness", directory: str = "") -> dict[str, Any]
Target
substance_painter_tools.project.create_project
Source
substance_painter_tools/project.py:9
Name status
Friendly call available

Parameters

  • mesh_path · str · required
  • template_name · str · default 'PBR - Metallic Roughness'
  • directory · str · default ''

export_textures

api.dcc.substance_painter.export_textures(...)
Signature
export_textures(output_path: str, preset_name: str = "PBR Metallic Roughness", resolution: int = 2048) -> dict[str, Any]
Target
substance_painter_tools.textures.export_textures
Source
substance_painter_tools/textures.py:9
Name status
Friendly call available

Parameters

  • output_path · str · required
  • preset_name · str · default 'PBR Metallic Roughness'
  • resolution · int · default 2048

Registered host operations

These are planner and bridge operations, not individual Python wrapper methods. Availability depends on a connected host, its bridge, required inputs, and the operation’s execution mode.

Substance Painter Apply Material

material.apply · user_delegated · changes project

Apply a smart material or preset to a texture set.

Required inputs: material_name.

Substance Painter Create Project

project.create · host_native · changes project

Create a new Substance Painter project from a mesh.

Required inputs: mesh_path.

Substance Painter Export Textures

textures.export · host_native · read-only or UI action

Export textured maps to a directory.

Required inputs: output_path.