Back to Node List

Surface ID Mask

surface_id_mask

Creates a white mask from pixels that match a material ID or face ID in a Surface.

Reviewed
Guide available
The node name and summary are available in English. Port, parameter, and article details are currently shown in Japanese.

Input Ports

NameTypeDescription
サーフェース
surface
Surface
Required
素材IDや面IDを探したいサーフェースです。

Output Ports

NameTypeDescription
マスク
mask
Image
選んだIDと一致する場所が白、それ以外が黒のマスクです。

Parameters

NameTypeDefaultRangeDescription / Options
IDの種類
id_kind
Enum
Material

素材IDと面IDのどちらからマスクを作るか選びます。

  • 素材IDMaterial
    素材IDから探します。
  • 面IDFace
    面IDから探します。
素材ID
material_id
Text
core:default

マスクとして取り出す素材IDです。

面ID
face_id
Text
surface:default

マスクとして取り出す面IDです。

反転
invert
Bool
false

オンにすると、白と黒を反転します。

What is it for?

  • Processing only metal, stone, walls, or another selected part
  • Creating a height or emission map for Surface Set Map only at a particular ID
  • Creating a mask for Surface Composite or image filters

Overview

Extracts only areas with a specified material or face ID as a white mask from a Surface. It enables part-specific processing such as metal only or the left wall without manually drawing a mask.

Usage tips

  • This highlights the strength of the Surface workflow. If material IDs are assigned during solid_render, any part can be extracted later, automating selections.
  • The extracted mask is a regular Image. Use it as a filter mask, to limit a map for surface_set_map, or in combinations built with mask_boolean.
  • An absent ID produces a black image. Inspect material_mask or face_mask from surface_unpack first to see which IDs are present.

Related nodes

  • surface_assign_id / surface_assign_material — paint IDs

  • surface_unpack — visually inspects the ID distribution

  • mask_boolean — combines extracted masks

  • surface_set_map — uses masks in map processing

  • Version: 1

Examples

[Surface] → surface → [Surface ID Mask(id_kind:Material, material_id:core:metal)] → mask

The output is white only over metal. Use it to build a map for Surface Set Map or as a mask for a regular image filter.

Back to Node List
Surface ID Mask — PixPipeline Node Reference