.. _eu.gmic.Gradientcustomshape:

G’MIC Gradient custom shape node
================================

*This documentation is for version 1.0 of G’MIC Gradient custom shape.*

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

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                                             |                       |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
| Log Verbosity / ``Log_Verbosity``                         | Choice  | Off                                             | |                     |
|                                                           |         |                                                 | | **Off**             |
|                                                           |         |                                                 | | **Level 1**         |
|                                                           |         |                                                 | | **Level 2**         |
|                                                           |         |                                                 | | **Level 3**         |
+-----------------------------------------------------------+---------+-------------------------------------------------+-----------------------+
