.. _net.sf.openfx.Rectangle:

Rectangle node
==============

.. raw:: html

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

|pluginIcon| 

*This documentation is for version 2.1 of Rectangle (net.sf.openfx.Rectangle).*

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

Draw a rectangle.

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

If no source is connected, this effect behaves like a generator. Its region of definition is:

- The selected format if the Extent parameter is a format.

- The project output format if Color0 is not black and transparent.

- The selected extent plus a one-pixel border if Color0 is black and transparent.

See also: http://opticalenquiry.com/nuke/index.php?title=Rectangle

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                                                                                                                                                   |
+======================================+=========+=====================+============================================================================================================================================================+
| Extent / ``extent``                  | Choice  | Size                | | Extent (size and offset) of the output.                                                                                                                  |
|                                      |         |                     | | **Format (format)**: Use a pre-defined image format.                                                                                                     |
|                                      |         |                     | | **Size (size)**: Use a specific extent (size and offset).                                                                                                |
|                                      |         |                     | | **Project (project)**: Use the project extent (size and offset).                                                                                         |
|                                      |         |                     | | **Default (default)**: Use the default extent (e.g. the source clip extent, if connected).                                                               |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Center / ``recenter``                | Button  |                     | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Reformat / ``reformat``              | Boolean | Off                 | Set the output format to the given extent, except if the Bottom Left or Size parameters is animated.                                                       |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Format / ``NatronParamFormatChoice`` | Choice  | HD 1920x1080        | | The output format                                                                                                                                        |
|                                      |         |                     | | **PC_Video 640x480 (PC_Video)**                                                                                                                          |
|                                      |         |                     | | **NTSC 720x486 0.91 (NTSC)**                                                                                                                             |
|                                      |         |                     | | **PAL 720x576 1.09 (PAL)**                                                                                                                               |
|                                      |         |                     | | **NTSC_16:9 720x486 1.21 (NTSC_16:9)**                                                                                                                   |
|                                      |         |                     | | **PAL_16:9 720x576 1.46 (PAL_16:9)**                                                                                                                     |
|                                      |         |                     | | **HD_720 1280x720 (HD_720)**                                                                                                                             |
|                                      |         |                     | | **HD 1920x1080 (HD)**                                                                                                                                    |
|                                      |         |                     | | **UHD_4K 3840x2160 (UHD_4K)**                                                                                                                            |
|                                      |         |                     | | **1K_Super_35(full-ap) 1024x778 (1K_Super_35(full-ap))**                                                                                                 |
|                                      |         |                     | | **1K_Cinemascope 914x778 2.00 (1K_Cinemascope)**                                                                                                         |
|                                      |         |                     | | **2K_Super_35(full-ap) 2048x1556 (2K_Super_35(full-ap))**                                                                                                |
|                                      |         |                     | | **2K_Cinemascope 1828x1556 2.00 (2K_Cinemascope)**                                                                                                       |
|                                      |         |                     | | **2K_DCP 2048x1080 (2K_DCP)**                                                                                                                            |
|                                      |         |                     | | **4K_Super_35(full-ap) 4096x3112 (4K_Super_35(full-ap))**                                                                                                |
|                                      |         |                     | | **4K_Cinemascope 3656x3112 2.00 (4K_Cinemascope)**                                                                                                       |
|                                      |         |                     | | **4K_DCP 4096x2160 (4K_DCP)**                                                                                                                            |
|                                      |         |                     | | **square_256 256x256 (square_256)**                                                                                                                      |
|                                      |         |                     | | **square_512 512x512 (square_512)**                                                                                                                      |
|                                      |         |                     | | **square_1K 1024x1024 (square_1K)**                                                                                                                      |
|                                      |         |                     | | **square_2K 2048x2048 (square_2K)**                                                                                                                      |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Bottom Left / ``bottomLeft``         | Double  | x: 0 y: 0           | Coordinates of the bottom left corner of the size rectangle.                                                                                               |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Size / ``size``                      | Double  | w: 1 h: 1           | Width and height of the size rectangle.                                                                                                                    |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.                                                    |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Frame Range / ``frameRange``         | Integer | min: 1 max: 1       | Time domain.                                                                                                                                               |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Corner Radius / ``cornerRadius``     | Double  | x: 0 y: 0           | If non-zero, this is the radius of the round corners.                                                                                                      |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Softness / ``softness``              | Double  | 0                   | Softness of the rectangle edges. Draws an anti-aliased rectangle if zero                                                                                   |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 0 / ``color0``                 | Color   | r: 0 g: 0 b: 0 a: 0 |                                                                                                                                                            |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 1 / ``color1``                 | Color   | r: 1 g: 1 b: 1 a: 1 |                                                                                                                                                            |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Expand RoD / ``expandRoD``           | Boolean | On                  | Expand the source region of definition by the shape RoD (if Source is connected and color0=(0,0,0,0)).                                                     |
+--------------------------------------+---------+---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.Rectangle.png
   :width: 10.0%
