Back to Node List

Input Pin

input_pin

Defines an input port for a custom node

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

Output Ports

NameTypeDescription
value
Any
親グラフから渡される入力値

Parameters

NameTypeDefaultRangeDescription / Options
ピンID
pin_id
Text

入力ポートの不変IDです。

ポート名
pin_name
Text
input

この入力ポートの名前(カスタムノードの外側に表示)

ポート型
port_type
Enum
Image

この入力ポートの型

  • ImageImage
  • NumberNumber
  • FloatFloat
  • IntInt
  • ColorColor
  • BoolBool
  • TextText
  • Vec2Vec2
  • Vec3Vec3
  • OklchAdjustOklchAdjust
  • PalettePalette
  • ListList
  • PathPath
  • PixelLinePixelLine
  • SolidSolid
  • MapMap
  • TextLayoutTextLayout
  • PixelPatchPixelPatch
  • IndexedImageIndexedImage
  • IsoItemIsoItem
  • IsoSceneIsoScene
  • IsoWorldIsoWorld
  • AsepriteFileAsepriteFile
  • AnimationClipAnimationClip
  • RuleGridSpecRuleGridSpec
  • RuleTileSetRuleTileSet
  • RuleTileAssetRuleTileAsset
  • RuleSetRuleSet
  • RuleCanvasRuleCanvas
  • RuleResolvedRuleResolved
  • RuleTileAtlasRuleTileAtlas
  • TileAssetTileAsset
  • TilePaletteTilePalette
  • TileCanvasTileCanvas
  • TileResolvedTileResolved
  • NineSliceNineSlice
  • RegionMapRegionMap
  • RecordedLayerRecordedLayer
  • SpriteSheetSpriteSheet
  • FxState2DFxState2D
  • VariantSnapshotVariantSnapshot
  • VariantRecipeVariantRecipe
  • VariantRecordVariantRecord
  • SurfaceSurface
  • SurfaceGeometrySurfaceGeometry
  • ModelModel
  • PbrMaterialPbrMaterial
  • TangentNormalTangentNormal
  • TextureLayoutTextureLayout
  • ProceduralPaletteRecipeProceduralPaletteRecipe
  • AudioBufferAudioBuffer
  • AutomationCurveAutomationCurve
  • AnyAny
必須
required
Bool
true

この入力が必須かどうか

オプショナル
optional
Bool
false

カスタムノードの外部入力を未接続のまま評価できるようにします

Overview

A special node that defines an input to a custom node (a subgraph turned into a node). Place it inside a custom node to expose one input port on the outside. It has no purpose on its own in a regular graph.

Usage tips

  • Use it only inside a custom node. Place it in the internal graph where a value should enter from outside, then connect its value output to the internal processing.
  • pin_name and port_type determine how it appears outside. Choose the correct type from the start; changing it later disconnects external connections.
  • Enable required to report an error when the port is unconnected outside (for mandatory inputs such as an image).
  • Place multiple Input Pin nodes to give a custom node multiple inputs. Remember to manage their order as well.

Related nodes

  • output_pin — its output-side counterpart (use them together)
  • bake_subgraph / snapshot_node — caching nodes related to custom-node workflows
Back to Node List
Input Pin — PixPipeline Node Reference