Back to Node List

Surface Assign ID

surface_assign_id

Paints a material ID or face ID onto a Surface using a mask image.

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を塗りたいサーフェースです。
マスク
mask
Image
Required
白い部分、または不透明な部分に選んだIDを塗ります。

Output Ports

NameTypeDescription
サーフェース
surface
Surface
素材IDまたは面IDを更新したサーフェースです。
IDマスク
id_mask
Image
更新したIDマップを白黒で見やすくした確認用画像です。

Parameters

NameTypeDefaultRangeDescription / Options
IDの種類
id_kind
Enum
Material

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

  • 素材IDMaterial
    素材IDを塗ります。
  • 面IDFace
    面IDを塗ります。
素材ID
material_id
Text
core:metal

マスク部分に塗る素材IDです。例: core:metal、core:emissive

面ID
face_id
Text
surface:detail

マスク部分に塗る面IDです。例: iso:top、wall:left、roof:slope-ne

マスクの見方
mask_source
Enum
Alpha

マスク画像のどの値で塗る場所を決めるかです。

  • アルファAlpha
    透明度で塗る場所を決めます。
  • 明るさLuminance
    白黒の明るさで塗る場所を決めます。
  • Red
    赤チャンネルで塗る場所を決めます。
  • Green
    緑チャンネルで塗る場所を決めます。
  • Blue
    青チャンネルで塗る場所を決めます。
しきい値
threshold
Float
0.50–1 / step 0.01

この値以上のピクセルに選んだIDを塗ります。

What is it for?

  • Changing only metal areas to core:metal
  • Assigning different face IDs to floors, walls, and roofs after creation
  • Creating custom regions that Surface ID Mask can extract

Overview

Paints material or face IDs onto white areas of a mask. It does not change the visible appearance; it writes information such as “this is metal” or “this is the left wall” into the Surface. Downstream lighting, material-specific processing, and extraction with surface_id_mask can then use that information.

Usage tips

  • It forms a round trip with surface_id_mask: paint a region with Assign, then extract it later with Mask. This enables custom divisions where regions you paint drive your own processing.
  • Face IDs such as wall:left enable direction-specific shading and outline control. Review the divisions with the F view in the Surface preview.
  • If you need to paint only material IDs, the dedicated surface_assign_material provides the same operation.

Related nodes

  • surface_id_mask — extracts a painted ID

  • surface_assign_material — material-ID-only version

  • path_mask / mask_boolean — create the mask that defines the painted area

  • surface_light_preview — reviews the effect of IDs

  • Version: 1

Examples

[Surface] → surface → [Surface Assign ID(id_kind:Face, face_id:wall:left)] → surface
              [Mask] → mask

After painting the face ID, use the F Surface preview to see the painted face in a separate color.

Back to Node List
Surface Assign ID — PixPipeline Node Reference