User Guide Cancel

textureset | Substance 3D Painter Python API

Search
Substance 3D Painter Pyhton

Substance 3D Painter Pyhton

Open app

textureset

textureset module

Main classes:

The textureset module allows to manipulate the stacks and Texture Sets of the currently opened project.

A Texture Set has a resolution and one or more stacks, depending on whether the material is layered or not. If the material is layered, the Texture Set has several stacks. A stack contains one or more channels, corresponding to the different types that the material can have (BaseColor, Specular, Roughness, etc.). There can be only one channel of each type. A Texture Set may also have UV Tiles.

This module exposes the corresponding TextureSet, Stack, Channel and :class:`UVTile classes, allowing to retrieve and set information of the paintable stacks and the Texture Sets of the project, as well as their storage format.

For instance, it is possible to change the channels of the stacks, or set the resolution of the Texture Sets.

Example

import substance_painter.textureset 
 
# Show the resolution of the current Texture Set: 
active_stack = substance_painter.textureset.get_active_stack() 
material_resolution = active_stack.material().get_resolution() 
print("Resolution: {0}x{1}".format(material_resolution.width, material_resolution.height)) 
 
# Change the resolution of the current Texture Set: 
new_resolution = substance_painter.textureset.Resolution(512, 512) 
active_stack.material().set_resolution(new_resolution) 
 
# Change the resolution of all Texture Sets: 
all_texture_sets = substance_painter.textureset.all_texture_sets() 
substance_painter.textureset.set_resolutions(all_texture_sets, new_resolution) 
 
# List all the Texture Sets: 
for texture_set in substance_painter.textureset.all_texture_sets(): 
    print("Texture Set '{0}': {1}".format(texture_set.name(), 
        "layered" if texture_set.is_layered_material() else "not layered")) 
 
    # Get all uv tiles in the first row 
    row0 = [uvtile for uvtile in textureset.all_uv_tiles() if uvtile.v == 0] 
 
    # Set their resolution to 2k 
    new_resolution = substance_painter.textureset.Resolution(2048, 2048) 
    resolutions = {uvtile:new_resolution for uvtile in row0} 
    textureset.set_uvtiles_resolution(resolutions) 
 
    # Set 1001 in 4k if its width is not high enough 
    uvtile_1001 = next((uvtile for uvtile in row0 if uvtile.u == 0), None) 
    new_resolution = substance_painter.textureset.Resolution(4096, 4096) 
    if uvtile_1001.get_resolution().width < new_resolution.width: 
        uvtile_1001.set_resolution(new_resolution) 
 
    # Reset all uv tiles resolution: 
    all_uv_tiles = texture_set.all_uv_tiles() 
    texture_set.reset_uvtiles_resolution(all_uv_tiles) 
 
# List all the stacks of the current Texture Set: 
for stack in active_stack.material().all_stacks(): 
    if stack.name(): 
        print("Stack '{0}'".format(stack.name())) 
    else: 
        print("Stack has no name") 
 
# Find a stack called "Mask1" and set it as active: 
mask_stack = substance_painter.textureset.Stack.from_name("DefaultMaterial", "Mask1") 
if mask_stack != None: 
    substance_painter.textureset.set_active_stack(mask_stack) 
 
# Show the current active stack: 
print(substance_painter.textureset.get_active_stack())

See also

Stack, TextureSet, UVTile, Texture Set documentation. UV Tiles documentation.

class substance_painter.textureset.

ChannelType

ChannelType(value)

Members:

BaseColor, Height, Specular, SpecularEdgeColor, Opacity, Emissive, Displacement, Glossiness, Roughness, Anisotropylevel, Anisotropyangle, Transmissive, Reflection, Ior, Metallic, Normal, AO, Diffuse, Specularlevel, BlendingMask, Translucency, Scattering, ScatterColor, SheenOpacity, SheenRoughness, SheenColor, CoatOpacity, CoatColor, CoatRoughness, CoatSpecularLevel, CoatNormal, User0, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15

class substance_painter.textureset.

MeshMapUsage

MeshMapUsage(value)

Members:

AO, BentNormals, Curvature, Height, ID, Normal, Opacity, Position, Thickness, WorldSpaceNormal

class substance_painter.textureset.

Resolution

Resolution(width: int = 1024, height: int = 1024)

Two dimensional resolution.

For Texture Sets and UV Tiles, there are restrictions. The resolution must be a power of 2, for example 256, 512, 1024, 2048, etc. It must also be within the range of accepted resolutions.

For UV Tiles, resolution must be square (ie width = height).

width
width

The width in pixels.

Type

int

height
height

The height in pixels.

Type

int

See also

TextureSet.get_resolution(), TextureSet.set_resolution(), UVTile.get_resolution(), UVTile.set_resolution(), set_resolutions().

substance_painter.textureset.

all_texture_sets

all_texture_sets() → List[TextureSet]

List all the Texture Sets of the current project.

Returns

List of all the Texture Sets of this project.

Return type

list[TextureSet]

Raises

See also

TextureSet.

substance_painter.textureset.

get_active_stack

get_active_stack() → Stack

Get the currently paintable Texture Set stack.

Returns

The currently paintable stack.

Return type

Stack

Raises
  • ProjectError – If no project is opened.
  • RuntimeError – If there is no active stack.
  • ServiceNotFoundError – If Substance 3D Painter has not started all its services yet.

See also

Stack, set_active_stack().

substance_painter.textureset.

set_active_stack

set_active_stack(stack: Stack) → None

Set the Texture Set stack to be currently paintable.

Parameters

stack (Stack) – The stack to select.

Raises
  • ProjectError – If no project is opened.
  • ServiceNotFoundError – If Substance 3D Painter has not started all its services yet.
  • ValueError – If stack is not a valid Stack.

See also

Stack, get_active_stack().

substance_painter.textureset.

set_resolutions

set_resolutions(texturesets: List[TextureSet], new_resolution: Resolution)

Set the same resolution to multiple Texture Sets.

See resolution restrictions: Resolution.

Note

For any Texture Set, you can find its accepted resolutions in the “Texture Set Settings” window, in the “Size” menu.

Parameters
  • texturesets (list[TextureSet]) – The list of Texture Sets to change.
  • new_resolution (Resolution) – The new resolution for the Texture Sets.
Raises
  • ProjectError – If no project is opened.
  • ServiceNotFoundError – If Substance 3D Painter has not started all its services yet.
  • ValueError – If a Texture Set in texturesets is invalid.
  • ValueError – If there are duplicated Texture Sets in texturesets.
  • ValueError – If new_resolution is not a valid resolution.

See also

Resolution, TextureSet.get_resolution(), TextureSet.set_resolution().

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy