Create Shape Mask
KJNodes/masking/generate
CreateShapeMaskCreates a mask or batch of masks with the specified shape. Locations are center locations. Grow value is the amount to grow the shape on each frame, creating animated masks.
Example
JSON Example
{
"class_type": "CreateShapeMask",
"inputs": {
"shape": "circle",
"frames": 1,
"location_x": 256,
"location_y": 256,
"grow": 0,
"frame_width": 512,
"frame_height": 512,
"shape_width": 128,
"shape_height": 128
}
}This example shows required inputs only. Connection values like ["node_id", 0] should reference actual node IDs from your workflow.
Inputs
| Name | Type | Status | Constraints | Default |
|---|---|---|---|---|
shape | ENUM3 options
| required | - | "circle" |
frames | INT | required | min: 1, max: 4096, step: 1 | 1 |
location_x | INT | required | min: 0, max: 4096, step: 1 | 256 |
location_y | INT | required | min: 0, max: 4096, step: 1 | 256 |
grow | INT | required | min: -512, max: 512, step: 1 | 0 |
frame_width | INT | required | min: 16, max: 4096, step: 1 | 512 |
frame_height | INT | required | min: 16, max: 4096, step: 1 | 512 |
shape_width | INT | required | min: 8, max: 4096, step: 1 | 128 |
shape_height | INT | required | min: 8, max: 4096, step: 1 | 128 |
Outputs
| Index | Name | Type | Is List | Connection Reference |
|---|---|---|---|---|
0 | mask | MASK | No | ["{node_id}", 0] |
1 | mask_inverted | MASK | No | ["{node_id}", 1] |
How to connect to these outputs
To connect another node's input to an output from this node, use the connection reference format:
["node_id", output_index]Where node_id is the ID of this CreateShapeMask node in your workflow, and output_index is the index from the table above.
Example
If this node has ID "5" in your workflow:
mask (MASK):["5", 0]mask_inverted (MASK):["5", 1]
Was this page helpful?