[Bf-docboard-svn] bf-manual: [7185] trunk/blender_docs/manual/advanced/command_line/render.rst: Add documentation for Cycles command line options

Lukas Stockner noreply at blender.org
Mon Oct 5 21:01:30 CEST 2020


Revision: 7185
          https://developer.blender.org/rBM7185
Author:   lukasstockner97
Date:     2020-10-05 21:01:29 +0200 (Mon, 05 Oct 2020)
Log Message:
-----------
Add documentation for Cycles command line options

Cycles' command line arguments are currently completely undocumented.
That was fine since they were mostly for debugging, but with D9086 we have an actual user-facing option now, so it's time to document this.

I left out the resumable render options for now since they require more explanation than the other two.

Reviewed By: #documentation, brecht

Differential Revision: https://developer.blender.org/D9098

Modified Paths:
--------------
    trunk/blender_docs/manual/advanced/command_line/render.rst

Modified: trunk/blender_docs/manual/advanced/command_line/render.rst
===================================================================
--- trunk/blender_docs/manual/advanced/command_line/render.rst	2020-10-05 17:58:30 UTC (rev 7184)
+++ trunk/blender_docs/manual/advanced/command_line/render.rst	2020-10-05 19:01:29 UTC (rev 7185)
@@ -91,3 +91,24 @@
    Set the start frame to ``10`` and the end frame to ``500``.
 ``-t 2``
    Use only two threads.
+
+Cycles
+------
+
+In addition to the options above, which apply to all render engines, Cycles
+has some additional options to further control its behaviour.
+
+.. code-block:: sh
+
+   blender -b file.blend -f 20 -- --cycles-device CPU
+
+.. note::
+   Unlike the generic options, the Cycles-specific ones must be passed on the
+   end of the command line, following a double dash.
+
+``--cycles-device CPU``
+   Override the device that is used to render frames. Currently supported options are ``CPU``, ``CUDA``, ``OPTIX`` and ``OPENCL``.
+   Additionally, you can use ``CUDA+CPU`` or ``OPENCL+CPU`` in order to use both CPU and GPU rendering.
+
+``--cycles-print-stats``
+   Show detailed statistics about memory and time usage for Cycles renders on the console.



More information about the Bf-docboard-svn mailing list