Playbook Mask Pass Node

The Playbook Mask Pass node retrieves a single Mask Render Pass frame from Playbook3D. It extracts and returns both the composite mask and 8 individual color-based masks.

🛠️ Node Configuration

Inputs

NameTypeRequiredDefaultDescription
api_keySTRINGN/AAPI key for authentication.
blur_sizeFLOAT0.0Gaussian blur radius (0 for no blur).
run_idSTRINGN/AOptional identifier for a specific run.

Outputs

NameTypeDescription
mask_passIMAGEComposite mask image.
mask_1MASKMask extracted from color code #ffe906.
mask_2MASKMask extracted from color code #0589d6.
mask_3MASKMask extracted from color code #a2d4d5.
mask_4MASKMask extracted from color code #000016.
mask_5MASKMask extracted from color code #00ad58.
mask_6MASKMask extracted from color code #f084cf.
mask_7MASKMask extracted from color code #ee9e3e.
mask_8MASKMask extracted from color code #e6000c.

⚙️ Functionality

  • Uses api_key to authenticate with Playbook3D.
  • Fetches the composite mask and extracts 8 color-based masks.
  • Applies optional Gaussian blur to smooth mask edges.

Playbook Mask Pass Sequence Node

The Playbook Mask Pass Sequence node retrieves a sequence of Mask Render Pass frames from Playbook3D. It fetches a ZIP file containing multiple mask images and processes them.

🛠️ Node Configuration

Inputs

NameTypeRequiredDefaultDescription
api_keySTRINGN/AAPI key for authentication.
blur_sizeFLOAT0.0Gaussian blur radius (0 for no blur).
run_idSTRINGN/AOptional identifier for a specific run.

Outputs

NameTypeDescription
ImagesIMAGEA batch tensor containing extracted Mask Pass frames.

⚙️ Functionality

  • Uses api_key to authenticate with Playbook3D.
  • Retrieves a ZIP file containing multiple Mask Pass frames.
  • Extracts and processes the masks from the ZIP file.