> For the complete documentation index, see [llms.txt](https://codalin.gitbook.io/nodalin-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codalin.gitbook.io/nodalin-docs/nodes-reference/effects/mask.md).

# Mask

<table data-header-hidden><thead><tr><th width="141.6597900390625"></th><th></th></tr></thead><tbody><tr><td><div><figure><img src="https://937151318-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F44MuVIHBk5o5yfcGn64w%2Fuploads%2FVkkaDw3ZwYavR1liqx63%2Fimage.png?alt=media&amp;token=dfbea039-f7a7-4e6b-b236-d7fe09153eaf" alt="" width="76"><figcaption></figcaption></figure></div></td><td>Uses the luminance of the mask input to control the visibility of the background input. White = fully visible, black = fully transparent, grey = proportional. </td></tr></tbody></table>

<table><thead><tr><th width="155.21484375">Property name</th><th width="405.046875">Description</th><th>Compatible datatype</th></tr></thead><tbody><tr><td>input</td><td>Background figure to be masked</td><td>figure</td></tr><tr><td>mask</td><td>Mask figure (luminance controls visibility)</td><td>figure</td></tr><tr><td>invert</td><td>Invert the mask (black = visible, white = hidden)</td><td>boolean</td></tr></tbody></table>

&#x20;
