Skip to main content

Create Shape Mask On Path

KJNodes/masking/generateDeprecated
CreateShapeMaskOnPath

Creates a mask or batch of masks with the specified shape. Locations are center locations.

Deprecated: This node is deprecated and may be removed in future versions. Consider using an alternative node if available.

Example

JSON Example
{
  "class_type": "CreateShapeMaskOnPath",
  "inputs": {
    "shape": "circle",
    "coordinates": "",
    "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"
coordinatesSTRINGrequired--
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
size_multiplierFLOAToptional-[1]

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 CreateShapeMaskOnPath 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?