Skip to content

Commit 803ddcb

Browse files
Add setMultiFrameRenderConfig method to app
1 parent ecba134 commit 803ddcb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/general/application.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -925,6 +925,31 @@ Nothing.
925925

926926
----
927927

928+
.. _app.setMultiFrameRenderingConfig:
929+
930+
app.setMultiFrameRenderingConfig()
931+
*********************************************
932+
933+
``app.setMultiFrameRenderingConfig(mfr_on, max_cpu_perc)``
934+
935+
**Description**
936+
937+
Calling this function from a script will set the Multi-Frame Rendering configuration for the next render.
938+
After execution of the script is complete, these settings will be reset to what was previously set in the UI.
939+
940+
**Parameters**
941+
942+
================ ================================================================================================
943+
``mfr_on`` Boolean value. Set to ``true`` to enable Multi-Frame Rendering.
944+
``max_cpu_perc`` Value from 1-100 representing the maximum CPU percentage Multi-Frame Rendering should utilize. If ``mfr_on`` is set to ``false``, pass in 100.
945+
================ ================================================================================================
946+
947+
**Returns**
948+
949+
Nothing.
950+
951+
----
952+
928953
.. _app.setSavePreferencesOnQuit:
929954

930955
app.setSavePreferencesOnQuit()

0 commit comments

Comments
 (0)