[Bf-docboard-svn] bf-manual: [8745] branches/blender-3.0-release/blender_docs/manual/interface/controls/templates/color_ramp.rst: Cleanup: Color Ramp

Aaron Carlisle noreply at blender.org
Fri Dec 3 04:33:21 CET 2021


Revision: 8745
          https://developer.blender.org/rBM8745
Author:   Blendify
Date:     2021-12-03 04:33:20 +0100 (Fri, 03 Dec 2021)
Log Message:
-----------
Cleanup: Color Ramp

- Use enum styling for enums
- Add specific RNA links

Modified Paths:
--------------
    branches/blender-3.0-release/blender_docs/manual/interface/controls/templates/color_ramp.rst

Modified: branches/blender-3.0-release/blender_docs/manual/interface/controls/templates/color_ramp.rst
===================================================================
--- branches/blender-3.0-release/blender_docs/manual/interface/controls/templates/color_ramp.rst	2021-12-03 00:30:32 UTC (rev 8744)
+++ branches/blender-3.0-release/blender_docs/manual/interface/controls/templates/color_ramp.rst	2021-12-03 03:33:20 UTC (rev 8745)
@@ -22,8 +22,10 @@
    Clicking on this button will add a stop to your color ramp.
    The stops are added from the last selected stop to the next one, from left to right and
    they will be placed in the middle of both stops.
+
 Delete ``-``
    Deletes the selected color stop from the list.
+
 Specials ``v``
    Contains more operators for the color ramp.
 
@@ -38,49 +40,54 @@
       An :ref:`ui-eyedropper` to sample a color or gradient from the interface to be used in the color ramp.
    Reset Color Ramp
       Resets the color ramp to its default state.
+
+.. _bpy.types.ColorRamp.color_mode:
+
 Color Mode
    Selection of the :term:`Color Space` used for interpolation.
 
-   RGB
+   :RGB:
       Blends color by mixing each color channel and combining.
-   HSV/HSL
+   :HSV/HSL:
       Blends colors by first converting to HSV or HSL, mixing, then combining again.
       This has the advantage of maintaining saturation between different hues,
       where RGB would de-saturate, this allows for a richer gradient.
-Interpolation Options
+
+.. _bpy.types.ColorRamp.hue_interpolation:
+.. _bpy.types.ColorRamp.interpolation:
+
+Color Interpolation
    Enables the user to choose the types of calculations for the color interpolation for each color stop.
 
    RGB
-      B-Spline
-         Uses a *B-Spline* Interpolation for the color stops.
-      Cardinal
-         Uses a *Cardinal* Interpolation for the color stops.
-      Linear
-         Uses a *Linear* Interpolation for the color stops.
-      Ease
-         Uses an *Ease* Interpolation for the color stops.
-      Constant
-         Uses a *Constant* Interpolation for the color stops.
-   HSV and HSL
-      Clockwise
-         Clockwise interpolation around the HSV/HSL wheel.
-      Counter-Clockwise
-         Counterclockwise around the HSV/HSL wheel.
-      Near
-         Nearest route around the wheel.
-      Far
-         Furthest route around the wheel.
+      :B-Spline: Uses a *B-Spline* Interpolation for the color stops.
+      :Cardinal: Uses a *Cardinal* Interpolation for the color stops.
+      :Linear: Uses a *Linear* Interpolation for the color stops.
+      :Ease: Uses an *Ease* Interpolation for the color stops.
+      :Constant: Uses a *Constant* Interpolation for the color stops.
+   
+   HSV/HSL
+      :Clockwise: Clockwise interpolation around the HSV/HSL wheel.
+      :Counter-Clockwise: Counterclockwise around the HSV/HSL wheel.
+      :Near: Nearest route around the wheel.
+      :Far: Furthest route around the wheel.
 
-   .. figure:: /images/interface_controls_templates_color-ramp_interpolation.png
-      :width: 600px
+      .. figure:: /images/interface_controls_templates_color-ramp_interpolation.png
+         :width: 600px
 
-      HSV and HSL interpolation options.
+         HSV and HSL interpolation options.
 
 Active Color Stop
    Index of the active color stop (shown as a dashed line).
    Allows you to change the active color when colors may be too close to easily select with the cursor.
+
+.. _bpy.types.ColorRampElement.position:
+
 Position
    This slider controls the positioning of the selected color stop in the range.
+
+.. _bpy.types.ColorRampElement.color:
+
 Color
    Opens a color picker for the user to specify color and Alpha for the selected color stop.
    When a color is using Alpha, the color field is then divided in two, with the left side



More information about the Bf-docboard-svn mailing list