.. _eu.gmic.GradientCustomShape:

G’MIC Gradient Custom Shape node
================================

.. raw:: html

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

*This documentation is for version 1.0 of G’MIC Gradient Custom Shape (eu.gmic.GradientCustomShape).*

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

Shape selection:

Note: Shapes with small strokes may lead to incorrect previews.

Gradient parameters:

Color definitions:

Author: David Tschumperle. Latest Update: 2013/03/10.

Wrapper for the G’MIC framework (http://gmic.eu) written by Tobias Fleischer (http://www.reduxfx.com) and Frederic Devernay.

Inputs
------

+--------+-------------+----------+
| Input  | Description | Optional |
+========+=============+==========+
| Source |             | No       |
+--------+-------------+----------+

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              |
+===========================================================+=========+=================================================+=======================+
| Select By / ``Select_By``                                 | Choice  | Auto                                            | |                     |
|                                                           |         |                                                 | | **Auto**            |
|                                                           |         |                                                 | | **Dark Pixels**     |
|                                                           |         |                                                 | | **Bright Pixels**   |
|                                                           |         |                                                 | | **Opaque Pixels**   |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Smoothness / ``Smoothness``                               | Double  | 0                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Threshold / ``Threshold``                                 | Double  | 0                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Preview Shape / ``Preview_Shape``                         | Boolean | On                                              |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Number of Colors / ``Number_of_Colors``                   | Integer | 4                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Cycles / ``Cycles``                                       | Double  | 1                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Offset / ``Offset``                                       | Double  | 0                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Shading / ``Shading``                                     | Double  | 128                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Inner Length / ``Inner_Length``                           | Double  | 100                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Outer Length / ``Outer_Length``                           | Double  | 100                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Spatial Metric / ``Spatial_Metric``                       | Choice  | Euclidean                                       | |                     |
|                                                           |         |                                                 | | **Chebyshev**       |
|                                                           |         |                                                 | | **Manhattan**       |
|                                                           |         |                                                 | | **Euclidean**       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Color Metric / ``Color_Metric``                           | Choice  | RGB                                             | |                     |
|                                                           |         |                                                 | | **RGB**             |
|                                                           |         |                                                 | | **HSV**             |
|                                                           |         |                                                 | | **Lab**             |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Shade Back to First Color / ``Shade_Back_to_First_Color`` | Boolean | On                                              |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Preview Gradient / ``Preview_Gradient``                   | Boolean | Off                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Save Gradient As / ``Save_Gradient_As``                   | String  |                                                 |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Colormap Type / ``Colormap_Type``                         | Choice  | User-Defined                                    | |                     |
|                                                           |         |                                                 | | **Pre-Defined**     |
|                                                           |         |                                                 | | **User-Defined**    |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Pre-Defined Colormap / ``PreDefined_Colormap``            | Integer | 0                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 1st Color / ``p1st_Color``                                | Color   | r: 0 g: 0 b: 0 a: 0                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 2nd Color / ``p2nd_Color``                                | Color   | r: 1 g: 0 b: 0 a: 0                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 3rd Color / ``p3rd_Color``                                | Color   | r: 1 g: 1 b: 0 a: 0                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 4th Color / ``p4th_Color``                                | Color   | r: 1 g: 1 b: 1 a: 1                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 5th Color / ``p5th_Color``                                | Color   | r: 0 g: 1 b: 1 a: 1                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 6th Color / ``p6th_Color``                                | Color   | r: 0 g: 1 b: 0 a: 0                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 7th Color / ``p7th_Color``                                | Color   | r: 0 g: 0 b: 1 a: 1                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 8th Color / ``p8th_Color``                                | Color   | r: 0.501961 g: 0.501961 b: 0.501961 a: 0.501961 |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 9th Color / ``p9th_Color``                                | Color   | r: 1 g: 0 b: 1 a: 1                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| 10th Color / ``p10th_Color``                              | Color   | r: 0 g: 0 b: 0 a: 0                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Output Layer / ``Output_Layer``                           | Choice  | Layer 0                                         | |                     |
|                                                           |         |                                                 | | **Merged**          |
|                                                           |         |                                                 | | **Layer 0**         |
|                                                           |         |                                                 | | **Layer -1**        |
|                                                           |         |                                                 | | **Layer -2**        |
|                                                           |         |                                                 | | **Layer -3**        |
|                                                           |         |                                                 | | **Layer -4**        |
|                                                           |         |                                                 | | **Layer -5**        |
|                                                           |         |                                                 | | **Layer -6**        |
|                                                           |         |                                                 | | **Layer -7**        |
|                                                           |         |                                                 | | **Layer -8**        |
|                                                           |         |                                                 | | **Layer -9**        |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Resize Mode / ``Resize_Mode``                             | Choice  | Dynamic                                         | |                     |
|                                                           |         |                                                 | | **Fixed (Inplace)** |
|                                                           |         |                                                 | | **Dynamic**         |
|                                                           |         |                                                 | | **Downsample 1/2**  |
|                                                           |         |                                                 | | **Downsample 1/4**  |
|                                                           |         |                                                 | | **Downsample 1/8**  |
|                                                           |         |                                                 | | **Downsample 1/16** |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Ignore Alpha / ``Ignore_Alpha``                           | Boolean | Off                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Preview/Draft Mode / ``PreviewDraft_Mode``                | Boolean | Off                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Global Random Seed / ``Global_Random_Seed``               | Integer | 0                                               |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Animate Random Seed / ``Animate_Random_Seed``             | Boolean | Off                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Log Verbosity / ``Log_Verbosity``                         | Choice  | Off                                             | |                     |
|                                                           |         |                                                 | | **Off**             |
|                                                           |         |                                                 | | **Level 1**         |
|                                                           |         |                                                 | | **Level 2**         |
|                                                           |         |                                                 | | **Level 3**         |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+