.. _eu.gmic.Illuminate2dshape:

G’MIC Illuminate 2d shape node
==============================

*This documentation is for version 1.0 of G’MIC Illuminate 2d 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                                      |
+===============================================================================+=========+======================================+===============================================+
| Input type / ``Input_type``                                                   | Choice  | Single opaque shapes over transp. bg | |                                             |
|                                                                               |         |                                      | | **Single opaque shapes over transp. bg**    |
|                                                                               |         |                                      | | **Multiple colored shapes over transp. bg** |
|                                                                               |         |                                      | | **Bump map**                                |
|                                                                               |         |                                      | | **Normal map**                              |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Output type / ``Output_type``                                                 | Choice  | Illumination                         | |                                             |
|                                                                               |         |                                      | | **Illumination**                            |
|                                                                               |         |                                      | | **Bump map**                                |
|                                                                               |         |                                      | | **Normal map**                              |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Input guide color / ``Input_guide_color``                                     | Color   | r: 1 g: 0 b: 0 a: 0                  |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Keep base layer as input background / ``Keep_base_layer_as_input_background`` | Boolean | On                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Keep transparency in output / ``Keep_transparency_in_output``                 | Boolean | On                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Minimal shape area / ``Minimal_shape_area``                                   | Integer | 4                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Preview detected shapes / ``Preview_detected_shapes``                         | Boolean | Off                                  |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Erosion/Dilation / ``ErosionDilation``                                        | Double  | 0                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Smoothness / ``Smoothness``                                                   | Double  | 2                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Bump factor / ``Bump_factor``                                                 | Double  | 1                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Avg / max weight / ``Avg__max_weight``                                        | Double  | 1                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Resolution / ``Resolution``                                                   | Choice  | 256                                  | |                                             |
|                                                                               |         |                                      | | **Full (slower)**                           |
|                                                                               |         |                                      | | **2048**                                    |
|                                                                               |         |                                      | | **1024**                                    |
|                                                                               |         |                                      | | **512**                                     |
|                                                                               |         |                                      | | **256**                                     |
|                                                                               |         |                                      | | **128**                                     |
|                                                                               |         |                                      | | **64 (faster)**                             |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Blending mode / ``Blending_mode``                                             | Choice  | Hard light                           | |                                             |
|                                                                               |         |                                      | | **Normal**                                  |
|                                                                               |         |                                      | | **Lighten**                                 |
|                                                                               |         |                                      | | **Screen**                                  |
|                                                                               |         |                                      | | **Dodge**                                   |
|                                                                               |         |                                      | | **Add**                                     |
|                                                                               |         |                                      | | **Darken**                                  |
|                                                                               |         |                                      | | **Multiply**                                |
|                                                                               |         |                                      | | **Burn**                                    |
|                                                                               |         |                                      | | **Overlay**                                 |
|                                                                               |         |                                      | | **Soft light**                              |
|                                                                               |         |                                      | | **Hard light**                              |
|                                                                               |         |                                      | | **Grain merge**                             |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Opacity (%) / ``Opacity_``                                                    | Double  | 75                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Ambient (%) / ``Ambient_``                                                    | Double  | 30                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Diffuse (%) / ``Diffuse_``                                                    | Double  | 40                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Specular (%) / ``Specular_``                                                  | Double  | 40                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Shininess / ``Shininess``                                                     | Double  | 80                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Smoothness_2 / ``Smoothness_2``                                               | Double  | 0.2                                  |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Flatness / ``Flatness``                                                       | Double  | 1                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Linearity / ``Linearity``                                                     | Double  | 0                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Levels / ``Levels``                                                           | Integer | 0                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Light-X / ``LightX``                                                          | Double  | 2                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Light-Y / ``LightY``                                                          | Double  | -2                                   |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Light-Z / ``LightZ``                                                          | Double  | 2                                    |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Normalize illumination / ``Normalize_illumination``                           | Boolean | Off                                  |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Open interactive preview / ``Open_interactive_preview``                       | Boolean | Off                                  |                                               |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| Preview type / ``Preview_type``                                               | Choice  | Full                                 | |                                             |
|                                                                               |         |                                      | | **Full**                                    |
|                                                                               |         |                                      | | **Forward horizontal**                      |
|                                                                               |         |                                      | | **Forward vertical**                        |
|                                                                               |         |                                      | | **Backward horizontal**                     |
|                                                                               |         |                                      | | **Backward vertical**                       |
|                                                                               |         |                                      | | **Duplicate top**                           |
|                                                                               |         |                                      | | **Duplicate left**                          |
|                                                                               |         |                                      | | **Duplicate bottom**                        |
|                                                                               |         |                                      | | **Duplicate right**                         |
|                                                                               |         |                                      | | **Duplicate horizontal**                    |
|                                                                               |         |                                      | | **Duplicate vertical**                      |
|                                                                               |         |                                      | | **Checkered**                               |
|                                                                               |         |                                      | | **Checkered inverse**                       |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
| 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**                                 |
+-------------------------------------------------------------------------------+---------+--------------------------------------+-----------------------------------------------+
