[Bf-docboard-svn] bf-manual: [7720] branches/blender-2.92-release/blender_docs/manual: Cycles: Cleanup performance settings

[Aaron Carlisle]

Revision: 7720
          https://developer.blender.org/rBM7720
Author:   Blendify
Date:     2021-02-04 06:13:55 +0100 (Thu, 04 Feb 2021)
Log Message:
-----------
Cycles: Cleanup performance settings

Modified Paths:
--------------
    branches/blender-2.92-release/blender_docs/manual/editors/image/editing.rst
    branches/blender-2.92-release/blender_docs/manual/interface/controls/nodes/editing.rst
    branches/blender-2.92-release/blender_docs/manual/render/cycles/render_settings/performance.rst

Modified: branches/blender-2.92-release/blender_docs/manual/editors/image/editing.rst
===================================================================
--- branches/blender-2.92-release/blender_docs/manual/editors/image/editing.rst	2021-02-04 04:51:33 UTC (rev 7719)
+++ branches/blender-2.92-release/blender_docs/manual/editors/image/editing.rst	2021-02-04 05:13:55 UTC (rev 7720)
@@ -17,7 +17,7 @@
    Load the current scene's render layers from disk cache, if available.
    This can be used to save RAM while rendering because the render layers do not have to be saved in RAM.
    This can also be used to recover some information from a fail render.
-   For this to work, :ref:`Save Buffers <render_properties_save-buffers>` must be enabled.
+   For this to work, :ref:`Save Buffers <bpy.types.RenderSettings.use_save_buffers>` must be enabled.
 
 Replace
    Replaces the current image throughout the blend-file with another image.

Modified: branches/blender-2.92-release/blender_docs/manual/interface/controls/nodes/editing.rst
===================================================================
--- branches/blender-2.92-release/blender_docs/manual/interface/controls/nodes/editing.rst	2021-02-04 04:51:33 UTC (rev 7719)
+++ branches/blender-2.92-release/blender_docs/manual/interface/controls/nodes/editing.rst	2021-02-04 05:13:55 UTC (rev 7720)
@@ -169,4 +169,4 @@
    Reads all the current scene's render layers from cache, as needed.
    This can be used to save RAM while rendering because the render layers do not have to be saved in RAM.
    This can also be used to recover some information from a failed render.
-   For this to work, :ref:`Save Buffers <render_properties_save-buffers>` must be enabled.
+   For this to work, :ref:`Save Buffers <bpy.types.RenderSettings.use_save_buffers>` must be enabled.

Modified: branches/blender-2.92-release/blender_docs/manual/render/cycles/render_settings/performance.rst
===================================================================
--- branches/blender-2.92-release/blender_docs/manual/render/cycles/render_settings/performance.rst	2021-02-04 04:51:33 UTC (rev 7719)
+++ branches/blender-2.92-release/blender_docs/manual/render/cycles/render_settings/performance.rst	2021-02-04 05:13:55 UTC (rev 7720)
@@ -12,23 +12,31 @@
 Threads
 =======
 
+.. _bpy.types.RenderSettings.threads_mode:
+
 Mode
-   Auto-detect
+   Method to determine the maximum number of CPU cores to use while rendering.
+
+   :Auto-Detect:
       Automatically chooses the amount of threads to match the number of logical processors on your computer.
-
-   Fixed
+   :Fixed:
       Manually choose the maximum number threads to use for rendering.
       This can be useful for example, if you want to use your computer while rendering,
       you can set the property to a thread count lower the amount of logical processors on your computer.
 
+.. _bpy.types.RenderSettings.threads:
 
+Threads
+   The maximum number of CPU cores to use simultaneously while rendering.
+
+
 Tiles
 =====
 
-Tile Order
-   Order of rendering tiles. This does not significantly affect the performance.
+.. _bpy.types.RenderSettings.tile_x:
+.. _bpy.types.RenderSettings.tile_y:
 
-Tile Size X/Y
+Tiles X,Y
    The size of the tiles for rendering.
 
    Depending on what device you are using for rendering, different tile sizes can give faster renders.
@@ -35,6 +43,9 @@
    For CPU rendering smaller tiles sizes (like 32 × 32) tend to be faster, while for
    :doc:`GPU rendering </render/cycles/gpu_rendering>` larger tile sizes give a better performance (like 256 × 256).
 
+Order
+   Order of rendering tiles. This does not significantly affect the performance.
+
 Progressive Refine
    Instead of rendering each tile until it has finished every sample, refine the whole image progressively.
    Note that progressive rendering is slightly slower than tiled rendering,
@@ -42,15 +53,7 @@
 
    For rendering animations it is best to disable this feature, as stopping a frame early is not possible.
 
-.. _render_properties_save-buffers:
 
-Save Buffers
-   Saves all render layers and passes to the temp directory on a drive,
-   and reads them back after rendering has finished. This saves memory (RAM) usage during rendering,
-   particularly when using many render layers and passes. This can be read back in the Compositor
-   and Image editor by using :ref:`bpy.ops.node.read_viewlayers`.
-
-
 Acceleration Structure
 ======================
 
@@ -57,10 +60,12 @@
 Use Spatial Splits
    Spatial splits improve the rendering performance in scenes with a mix of large and small polygons.
    The downsides are longer BVH build times and slightly increased memory usage.
+
 Use Hair BVH
    Use a special type of :term:`BVH` for rendering hair.
    The bounding boxes are not axis aligned allowing a spatially closer fit to the hair geometry.
    Disabling this option will reduce memory, at the cost of increasing hair render time.
+
 BVH Time Steps
    Split BVH primitives by this number of time steps to speed up render time at the expense of memory.
 
@@ -68,6 +73,16 @@
 Final Render
 ============
 
+.. _bpy.types.RenderSettings.use_save_buffers:
+
+Save Buffers
+   Saves all render layers and passes to the temp directory on a drive,
+   and reads them back after rendering has finished. This saves memory (RAM) usage during rendering,
+   particularly when using many render layers and passes. This can be read back in the Compositor
+   and Image editor by using :ref:`bpy.ops.node.read_viewlayers`.
+
+.. _bpy.types.RenderSettings.use_persistent_data:
+
 Persistent Images
    Keep image data in memory after rendering, for faster re-renders at the cost of extra memory usage when
    performing other tasks in Blender.
@@ -78,6 +93,8 @@
 Viewport
 ========
 
+.. _bpy.types.RenderSettings.preview_pixel_size:
+
 Pixel Size
    Option to control the resolution for viewport rendering.
    Allows you to speed up viewport rendering, which is especially useful for displays with high DPI.