[Bf-docboard-svn] bf-manual: [8395] trunk/blender_docs/manual/render: Cycles: Add rna links for render settings

Aaron Carlisle noreply at blender.org
Wed Sep 15 23:56:24 CEST 2021 

Revision: 8395
          https://developer.blender.org/rBM8395
Author:   Blendify
Date:     2021-09-15 23:56:23 +0200 (Wed, 15 Sep 2021)
Log Message:
-----------
Cycles: Add rna links for render settings

Modified Paths:
--------------
    trunk/blender_docs/manual/render/cycles/light_settings.rst
    trunk/blender_docs/manual/render/cycles/object_settings/adaptive_subdiv.rst
    trunk/blender_docs/manual/render/cycles/object_settings/object_data.rst
    trunk/blender_docs/manual/render/cycles/optimizations/reducing_noise.rst
    trunk/blender_docs/manual/render/cycles/render_settings/debug.rst
    trunk/blender_docs/manual/render/cycles/render_settings/film.rst
    trunk/blender_docs/manual/render/cycles/render_settings/hair.rst
    trunk/blender_docs/manual/render/cycles/render_settings/light_paths.rst
    trunk/blender_docs/manual/render/cycles/render_settings/motion_blur.rst
    trunk/blender_docs/manual/render/cycles/render_settings/performance.rst
    trunk/blender_docs/manual/render/cycles/render_settings/sampling.rst
    trunk/blender_docs/manual/render/cycles/render_settings/simplify.rst
    trunk/blender_docs/manual/render/cycles/render_settings/subdivision.rst
    trunk/blender_docs/manual/render/cycles/render_settings/volumes.rst
    trunk/blender_docs/manual/render/layers/introduction.rst

Modified: trunk/blender_docs/manual/render/cycles/light_settings.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/light_settings.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/light_settings.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -27,7 +27,7 @@
    Point lights might need only one sample, while area lights typically need more.
 Max Bounces
    Maximum number of times light from the light is allowed to :term:`Bounce <Light Bounces>`.
-   Limited by :ref:`scene-wide bounce settings <cycles-bounces>`.
+   Limited by :ref:`scene-wide bounce settings <bpy.types.CyclesRenderSettings.max_bounces>`.
 Cast Shadow
    By disabling this option, light from lights will not be blocked by objects in between.
    This can speed up rendering by not having to trace rays to the light source.

Modified: trunk/blender_docs/manual/render/cycles/object_settings/adaptive_subdiv.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/object_settings/adaptive_subdiv.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/object_settings/adaptive_subdiv.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -27,7 +27,8 @@
    .. _bpy.types.CyclesObjectSettings.dicing_rate:
 
    Dicing Scale
-      Multiplier of the :ref:`scene dicing rate <cycles-subdivision-rate>` to determine the final size of micropolygons in pixels.
+      Multiplier of the :ref:`scene dicing rate <bpy.types.CyclesRenderSettings.dicing_rate>`
+      to determine the final size of :term:`Micropolygons` in pixels.
 
       .. figure:: /images/render_cycles_object-settings_adaptive-subdiv_displacement-dicing.png
 

Modified: trunk/blender_docs/manual/render/cycles/object_settings/object_data.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/object_settings/object_data.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/object_settings/object_data.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -79,7 +79,7 @@
 -------
 
 In order to activate these options the respectively camera cull options have to be enabled
-in the scene :ref:`simplify panel <render-cycles-settings-scene-simplify>`.
+in the scene :ref:`simplify panel <render-cycles-settings-scene-simplify-culling>`.
 
 .. _bpy.types.CyclesObjectSettings.use_camera_cull:
 

Modified: trunk/blender_docs/manual/render/cycles/optimizations/reducing_noise.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/optimizations/reducing_noise.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/optimizations/reducing_noise.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -80,7 +80,7 @@
 they become bigger and less intense, making them easier to find and less noisy.
 This will not give the same exact result,
 but often it's close enough when viewed through a diffuse or soft glossy reflection.
-Below is an example of using :ref:`Glossy Filter <render-cycles-integrator-filter-glossy>`
+Below is an example of using :ref:`Glossy Filter <bpy.types.CyclesRenderSettings.blur_glossy>`
 and :doc:`Light Falloff </render/shader_nodes/color/light_falloff>`.
 
 .. list-table::
@@ -144,7 +144,7 @@
 Caustics are a well-known source of noise, causing :term:`Fireflies`.
 They happen because the renderer has difficulty finding specular highlights
 viewed through a soft glossy or diffuse reflection.
-There is a :ref:`No Caustics <render-cycles-integrator-no-caustics>`
+There is a :ref:`No Caustics <bpy.types.CyclesRenderSettings.caustics>`
 option to disable glossy behind a diffuse reflection entirely.
 Many renderers will typically disable caustics by default.
 
@@ -167,7 +167,7 @@
 
 However, using No Caustics will result in missing light,
 and it still does not cover the case where a sharp glossy reflection is viewed through a soft glossy reflection.
-There is a :ref:`Filter Glossy <render-cycles-integrator-filter-glossy>`
+There is a :ref:`Filter Glossy <bpy.types.CyclesRenderSettings.blur_glossy>`
 option to reduce the noise from such cases at the cost of accuracy.
 This will blur the sharp glossy reflection to make it easier to find, by increasing the shader Roughness.
 

Modified: trunk/blender_docs/manual/render/cycles/render_settings/debug.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/render_settings/debug.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/render_settings/debug.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -10,12 +10,16 @@
 These settings are mainly useful to developers and can be accessed
 by enabling the :doc:`Cycles Debug </editors/preferences/experimental>`.
 
+.. _bpy.types.CyclesRenderSettings.debug_optix_curves_api:
+
 OptiX Flags
    Native OptiX Curve Primitive
       Use OptiX curves API for hair instead of custom implementation.
 
+.. _bpy.types.CyclesRenderSettings.debug_bvh_type:
+
 Viewport BVH Type
-   Dynamic BVH
+   :Dynamic BVH:
       Objects can be transformed, added and deleted interactively, at the cost of slower renders.
-   Static BVH
+   :Static BVH:
       Object modifications require a complete :term:`BVH` rebuild which reduces interactivity but renders faster.

Modified: trunk/blender_docs/manual/render/cycles/render_settings/film.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/render_settings/film.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/render_settings/film.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -7,10 +7,12 @@
 
    :Panel:     :menuselection:`Render --> Film`
 
+.. _bpy.types.CyclesRenderSettings.film_exposure:
+
 Exposure
    This can be used to change the brightness of an image.
    Different than the *Exposure* option found in the :ref:`Color management <render-post-color-management>` panel,
-   this exposure option works *on the data* while the Color management exposure is *on the view*.
+   this exposure option works *on the data* while the Color management exposure is on the *view transform*.
 
 
 Pixel Filter
@@ -19,26 +21,34 @@
 Due to limited resolution of images and computer screens, pixel filters are needed to avoid :term:`Aliasing`.
 This is achieved by slightly blurring the image to soften edges.
 
+.. _bpy.types.CyclesRenderSettings.pixel_filter_type:
+
 Type
    Pixel Filtering algorithm to use.
 
-   Box
-      No filter.
-   Gaussian
-      Smooth filter.
-   Blackman-Harris
-      Default filter with a better balance between smoothness and detail preservation.
+   :Box: No filter.
+   :Gaussian: Smooth filter.
+   :Blackman-Harris: Default filter with a better balance between smoothness and detail preservation.
 
+.. _bpy.types.CyclesRenderSettings.filter_width:
+
 Width
    Lower values give more crisp renders, higher values are softer and reduce aliasing.
 
 
+.. _bpy.types.RenderSettings.film_transparent:
+
 Transparent
 ===========
 
 Render the background transparent, for compositing the image over another background after rendering.
 
+.. _bpy.types.CyclesRenderSettings.film_transparent_glass:
+
 Transparent Glass
    Render transmissive surfaces as transparent, for compositing glass over another background.
+
+.. _bpy.types.CyclesRenderSettings.film_transparent_roughness:
+
 Transparent Roughness
    For transparent glass, keep surfaces with roughness above the threshold opaque.

Modified: trunk/blender_docs/manual/render/cycles/render_settings/hair.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/render_settings/hair.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/render_settings/hair.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -11,14 +11,18 @@
 The resolution of the strands is controlled by the step values in particle settings.
 Each hair system uses the material identified in the particle settings.
 
+.. _bpy.types.CyclesCurveRenderSettings.shape:
+
 Shape
-   Rounded Ribbons
+   :Rounded Ribbons:
       Render hair as flat ribbon with rounded normals, for fast rendering.
       Hair curves are subdivided with a fixed number of specified subdivisions.
 
+      .. _bpy.types.CyclesCurveRenderSettings.subdivisions:
+
       Curve Subdivisions
          Number of subdivisions used in cardinal curve intersection (power of 2).
 
-   3D Curves
+   :3D Curves:
       Render hair as 3D curve, for accurate results when viewing hair close up.
       Hair curves are automatically subdivided until the curve is smooth.

Modified: trunk/blender_docs/manual/render/cycles/render_settings/light_paths.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/render_settings/light_paths.rst	2021-09-15 21:06:47 UTC (rev 8394)
+++ trunk/blender_docs/manual/render/cycles/render_settings/light_paths.rst	2021-09-15 21:56:23 UTC (rev 8395)
@@ -76,21 +76,35 @@
 Max Bounces
 -----------
 
-.. _cycles-bounces:
+.. _bpy.types.CyclesRenderSettings.max_bounces:
 
 Total
    Maximum number of light bounces. For best quality, this should be set to the maximum.
    However, in practice, it may be good to set it to lower values for faster rendering.
    A value of 0 bounces results in direct lighting only.
+
+.. _bpy.types.CyclesRenderSettings.diffuse_bounces:
+
 Diffuse
    Maximum number of diffuse bounces.
+
+.. _bpy.types.CyclesRenderSettings.glossy_bounces:
+
 Glossy
    Maximum number of glossy bounces.
+
+.. _bpy.types.CyclesRenderSettings.transmission_bounces:
+
 Transmission
    Maximum number of transmission bounces.
+
+.. _bpy.types.CyclesRenderSettings.volume_bounces:
+
 Volume
    Maximum number of volume scattering bounces.
 
+.. _bpy.types.CyclesRenderSettings.max_transparent_bounces:
+
 Transparent
    Maximum number of transparency bounces.
 
@@ -104,6 +118,8 @@
 Clamping
 --------
 
+.. _bpy.types.CyclesRenderSettings.sample_clamp_direct:
+
 Direct Light
    This option limits the maximum intensity a sample from rays which have not yet bounced can contribute to a pixel.
    It reduces noise at the cost of accuracy. Setting this option to 0.0 disables clamping altogether.
@@ -118,6 +134,8 @@

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-docboard-svn mailing list