application module

This module contains application wide functionnalities.

substance_painter.application.version_info() -> Tuple[int, int, int] substance_painter.application.version_info

Get the version_info of Substance 3D Painter. Ie a tuple containing major, minor, patch.

Returns: The major, minor and patch version of Substance 3D Painter.

Return type: Tuple[int, int, int]

substance_painter.application.version() -> str substance_painter.application.version

Get the version of Substance 3D Painter. Do not extract version information out of it,
rather use version_info().

Returns: Version of Substance 3D Painter.

Return type: str

substance_painter.application.engine_computations_status() -> bool substance_painter.application.engine_computations_status

Check whether engine computations are enabled.

Returns: Whether engine computations are enabled.

Return type: bool

substance_painter.application.enable_engine_computations(enable: bool) substance_painter.application.enable_engine_computations

Enable or disable engine computations.

Parameters: enable (bool)

substance_painter.application.disable_engine_computations() substance_painter.application.disable_engine_computations

Context manager to disable engine computations.
Allows to regroup computation intensive tasks without triggerring the engine so that textures
are not computed or updated in the layer stack or the viewport.
This is equivalent to disabling and then reenabling the engine by calling
enable_engine_computations().

Example:

import substance_painter.application as mapplication

with mapplication.disable_engine_computations():
    # Do some computation intensive tasks
    pass

substance_painter.application.close() substance_painter.application.close

Close Susbtance 3D Painter.

WARNING
Any unsaved data will be lost.
recommendation-more-help
substance-3d-dev-help-painter-python-guide