.. _net.sf.openfx.CheckerBoardPlugin:

CheckerBoard node
=================

.. raw:: html

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

|pluginIcon| 

*This documentation is for version 1.0 of CheckerBoard (net.sf.openfx.CheckerBoardPlugin).*

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

Generate an image with a checkerboard.

A frame range may be specified for operators that need it.

See also: http://opticalenquiry.com/nuke/index.php?title=Constant,_CheckerBoard,_ColorBars,_ColorWheel

Inputs
------

+--------+-------------+----------+
| Input  | Description | Optional |
+========+=============+==========+
| Source |             | 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  | Default                   | | 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.                                                                                                                                               |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Output Components / ``outputComponents`` | Choice  | RGBA                      | | Components in the output                                                                                                                                 |
|                                          |         |                           | | **RGBA**                                                                                                                                                 |
|                                          |         |                           | | **RGB**                                                                                                                                                  |
|                                          |         |                           | | **Alpha**                                                                                                                                                |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Box Size / ``boxSize``                   | Double  | x: 64 y: 64               | Size of the checkerboard boxes in pixels.                                                                                                                  |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 0 / ``color0``                     | Color   | r: 0.1 g: 0.1 b: 0.1 a: 1 | Color to fill the box on top-left of image center and every other row and column.                                                                          |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 1 / ``color1``                     | Color   | r: 0.5 g: 0.5 b: 0.5 a: 1 | Color to fill the box on top-right of image center and every other row and column.                                                                         |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 2 / ``color2``                     | Color   | r: 0.1 g: 0.1 b: 0.1 a: 1 | Color to fill the box on bottom-right of image center and every other row and column.                                                                      |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Color 3 / ``color3``                     | Color   | r: 0.5 g: 0.5 b: 0.5 a: 1 | Color to fill the box on bottom-left of image center and every other row and column.                                                                       |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Line Color / ``lineColor``               | Color   | r: 1 g: 1 b: 1 a: 1       | Color of the line drawn between boxes.                                                                                                                     |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Line Width / ``lineWidth``               | Double  | 0                         | Width, in pixels, of the lines drawn between boxes.                                                                                                        |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Centerline Color / ``centerlineColor``   | Color   | r: 1 g: 1 b: 0 a: 1       | Color of the center lines.                                                                                                                                 |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Centerline Width / ``centerlineWidth``   | Double  | 1                         | Width, in pixels, of the center lines.                                                                                                                     |
+------------------------------------------+---------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+

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