Skip to main content

Create Shape Mask

KJNodes/masking/generate
CreateShapeMask

Creates 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

NameTypeStatusConstraintsDefault
shapeENUM
3 options
  • circle
  • square
  • triangle
required-"circle"
framesINTrequiredmin: 1, max: 4096, step: 11
location_xINTrequiredmin: 0, max: 4096, step: 1256
location_yINTrequiredmin: 0, max: 4096, step: 1256
growINTrequiredmin: -512, max: 512, step: 10
frame_widthINTrequiredmin: 16, max: 4096, step: 1512
frame_heightINTrequiredmin: 16, max: 4096, step: 1512
shape_widthINTrequiredmin: 8, max: 4096, step: 1128
shape_heightINTrequiredmin: 8, max: 4096, step: 1128

Outputs

IndexNameTypeIs ListConnection Reference
0maskMASKNo["{node_id}", 0]
1mask_invertedMASKNo["{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?