async_utils module

The async_utils module provide primitives used in async computations.

class substance_painter.async_utils.StopSource(stop_source: _substance_painter.async_utils.StopSource) substance_painter.async_utils.StopSource

An object that can be used to cancel an asynchronous computation.

Parameters: stop_source (_substance_painter.async_utils.StopSource)

request_stop() -> bool substance_painter.async_utils.StopSource.request_stop

Makes a top request.

Returns: True if the stop request was possible.

Return type: bool

stop_requested() -> bool substance_painter.async_utils.StopSource.stop_requested

Check if a stop request as been made.

Returns: True if a stop request has been made.

Return type: bool