.. _net.sf.openfx.Ramp:

Ramp node
=========

.. raw:: html

   <!-- Do not edit this file! It is generated automatically by Natron itself. -->

|pluginIcon| 

*This documentation is for version 2.0 of Ramp (net.sf.openfx.Ramp).*

Description
-----------

Draw a ramp between 2 edges.

The ramp is composited with the source image using the ‘over’ operator.

See also: https://web.archive.org/web/20220807184828/http://www.opticalenquiry.com/nuke/index.php?title=Ramp

Inputs
------

+--------+-------------+----------+
| Input  | Description | Optional |
+========+=============+==========+
| Source |             | Yes      |
+--------+-------------+----------+
| Mask   |             | Yes      |
+--------+-------------+----------+

Controls
--------

.. tabularcolumns:: |>{\raggedright}p{0.2\columnwidth}|>{\raggedright}p{0.06\columnwidth}|>{\raggedright}p{0.07\columnwidth}|p{0.63\columnwidth}|

.. cssclass:: longtable

+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Parameter / script name              | Type    | Default             | Function                                                                                                                       |
+======================================+=========+=====================+================================================================================================================================+
| Ramp Type / ``type``                 | Choice  | Linear              | | The type of interpolation used to generate the ramp                                                                          |
|                                      |         |                     | | **Linear (linear)**: Linear ramp.                                                                                            |
|                                      |         |                     | | **PLinear (plinear)**: Perceptually linear ramp in Rec.709.                                                                  |
|                                      |         |                     | | **Ease-in (easein)**: Catmull-Rom spline, smooth start, linear end (a.k.a. smooth0).                                         |
|                                      |         |                     | | **Ease-out (easeout)**: Catmull-Rom spline, linear start, smooth end (a.k.a. smooth1).                                       |
|                                      |         |                     | | **Smooth (smooth)**: Traditional smoothstep ramp.                                                                            |
|                                      |         |                     | | **None (none)**: No color gradient.                                                                                          |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Point 0 / ``point0``                 | Double  | x: 100 y: 100       |                                                                                                                                |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Color 0 / ``color0``                 | Color   | r: 0 g: 0 b: 0 a: 0 |                                                                                                                                |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Point 1 / ``point1``                 | Double  | x: 100 y: 200       |                                                                                                                                |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Color 1 / ``color1``                 | Color   | r: 1 g: 1 b: 1 a: 1 |                                                                                                                                |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Interactive Update / ``interactive`` | Boolean | Off                 | If checked, update the parameter values during interaction with the image viewer, else update the values when pen is released. |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| HiDPI / ``hidpi``                    | Boolean | Off                 | Should be checked when the display area is High-DPI (a.k.a Retina). Draws OpenGL overlays twice larger.                        |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Invert Mask / ``maskInvert``         | Boolean | Off                 | When checked, the effect is fully applied where the mask is 0.                                                                 |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Mix / ``mix``                        | Double  | 1                   | Mix factor between the original and the transformed image.                                                                     |
+--------------------------------------+---------+---------------------+--------------------------------------------------------------------------------------------------------------------------------+

.. |pluginIcon| image:: net.sf.openfx.Ramp.png
   :width: 10.0%