===================
Mask Prompter
===================

Introduction
=============

Mask Prompter is the 2023 way of creating mattes. It's interactive and easy to use.

.. image:: img/interactive.gif


General workflow
=======================
You create mattes by specifying so-called prompts for the current frame. Prompts can either be points or rectangle masks around an object.

Parameters
===========

Points
-------------------
Enable "Active" and specify the coordinates of the point. By keyframing the points position you can follow objects.

Boxes
-------------------
Add rectangle masks to the layer and assign them to one of the five slots. This will create a matte for the object contained inside the rectangle.

Text Prompts
-------------------
Describe the objects you want to mask by linking in masks and changing the masks name. To key e.g. a horse click "Add Text Input", change the new masks name to "a horse" and link the mask layer in one of the five slots.
Sometimes the prompting requires some trial and error. Attention: This mode is slow in cpu only mode.

Negative Points
-------------------
Mark areas in the image you want to exclude from the masks.

Edge Enhancement
-------------------
Run an additional edge enhancement ai to improve the mask.

Output
-------------------
"Overlay" draws the matte as white overlay on top of the image (set opacity with "Overlay Strenght"). "Matte" will output a simple black and
white matte and "On Transparent" will give you the keyed object on alpha.

Overlay Hints
-------------------
Draw colored rectangles for each prompt point. For text prompts we draw two yellow points, one in the upper left and another in the lower right corner of the detected object.

Tips & Tricks
-------------------
If you use the "On Transparent" output the resulting matte can directly be postprocessed with After Effects internal effects like
"Refine Soft Matte".


Backend & Performance
-----------------------
.. include:: common-args.rst