Input

Input Color, Input Grayscale, Input Value

In: Atomic Nodes

Intermediate

Input Value since version 2019.1.0


Description

Input nodes are a special type of node that creates a dynamic slot in your graph, allowing for any input to be connected once your Graph is used in another context.

Unlike Output Nodes, you have to explicitly place either a Color, Grayscale or Value input. It is not possible to create your own "agnostic" inputs that change type depending on what is connected to them.

Input Nodes are not as crucial as Output Nodes: you can have perfectly functioning, advanced Graphs that have no need for an Input. Inputs are only used when you want to base your Graph or Node Instance's result on an external input, for example when creating an Instance or a Filter for Substance 3D Painter.


Specific Parameters

By default an Input Color or Grayscale returns black if nothing is plugged in. You can either set a different default value, or drag an existing Bitmap Resource from the Explorer onto the Input Node in your graph, to preview this data in the slot. This only works for Color and Grayscale Inputs. The default value is persistent when used in other contexts, the preview bitmap is discarded everywhere else.

If you want to see it with the outputs of another Graph, you'll have to either export that Graph to Bitmap for the above method, or make use of "In-Context" editing.

  • PKG Resource Path:
    Points to a custom bitmap resource for previewing.
  • Default Value: Color/Grayscale
    Lets you use another value than black as default input, if nothing is connected to this slot. Since SD 2020.2


Attributes

  • Identifier:
    The only mandatory, unique Attribute. Can not contains spaces.
    This one is used for labeling inputs if no Label is set up, and for telling different outputs apart. Don't just leave these at "input_1"!
  • Description:
    Optional Description used in Designer's library and Painter's shelf.
  • Label
    UI Label used for nice labeling in Designer and Painter UI. Can contain spaces. Recommended to set up with a name similar to the Identifier, just with spacebars instead of underscores.
  • User Data
    Additional, optional User Data that can be used for specific filtering operations, Basically a wildcard, custom data field.
  • Group
    Group Attribute used to group inputs together for Designer's Link Creation Modes. Inputs with an identical (case-sensitive) Group Attribute, will be presented as a single connection in Compact Material Mode.


Inheritance

When multiple inputs are present, you need to pay attention to the way the graph will inherit its base parameters from these inputs.
Base parameters include, among others, the Output size, Output format and Tiling mode.

An input can be defined as the Primary input. This input then drives the attributes of all inputs which inheritance method is set to Relative to parent. This is the inheritance method set by default on Input nodes.
You may set an input node as a graph's Primary input by clicking RMB on the node and selecting the Set as Primary input option in the contextual menu.
The Primary input of a node is marked with a small dark dot in the connector (circled in red in the example next to this section).

Alternatively, any input set to the Relative to input inheritance method will inherit the attributes from the node it is connected to, regardless of the Primary input.

Finally, you may override any value for a given attribute by setting its inheritance method to Absolute.

To learn more about inheritance, go to the Output size page of this documentation for a detailed look at inheritance methods and how they relate to the Output size parameter as an example.

The Relative to input inheritance method for Input nodes is not supported in Substance 3D assets (SBSAR). Thus, please set all Input nodes' inheritance methods to Relative to Parent before publishing your package.

Integration Attributes

Inputs are not directly sent to the 3D View, but their Usage Attributes are used by Substance 3D Painter for automatically filling slots with certain maps (mostly used with Filters).

Additionally the Usage attributes are also used with Link Creation Modes, to match the correct input and output slots.

  • Usage
    • Component
      This determines what channels are actually in the resulting input. This is a legacy setting this is not used by integrations and graphs anymore.
    • Usage
      Define a type or usage for this input. It indicates how other nodes should connect to this input.
    • Color Space
      Sets the colorspace this input should be interpreted in.