class ShadingLayeredBlendNode
LayeredBlendNode is a node with an arbitrary number of inputs that can be blended differently.
Properties
| Property | Description |
|---|
| InputCount | The number of inputs for this node. |
Methods
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spShadingLayeredBlendNode, and if this is the case, returns the object cast into spShadingLayeredBlendNode. |
Properties details
The number of inputs for this node.
Syntax
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | SG_NUM_SUPPORTED_CUSTOM_NODE_INPUTS | The number of inputs for this node. |
Type: unsigned int
Syntax
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | SG_NUM_SUPPORTED_CUSTOM_NODE_INPUTS | The number of inputs for this node. |
Type: uint
Syntax
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | SG_NUM_SUPPORTED_CUSTOM_NODE_INPUTS | The number of inputs for this node. |
Type: int
Methods details
GetClass
Get the name of the ShadingLayeredBlendNode class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetDefaultParameterAlpha
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterBlue
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterGreen
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterRed
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
The default node inputs.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| input_id | int | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
GetParameterCount
The input count.
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: int
Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | param_id | | | The id of the parameter to be checked. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | param_id | | | The id of the parameter to be checked. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| param_id | int | | | The id of the parameter to be checked. |
Return value
Type: bool
GetParameterName
The name of a parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to fetch the name of. |
Return value
Type: str
The blend type per input connection.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | _input | | | The input index. |
Return value
Type: ETextureBlendType
| Key | Value | Comment |
|---|
| Replace | 0 | |
| Add | 1 | |
| Subtract | 2 | |
| Multiply | 3 | |
| Alpha | 4 | |
| PreMultipliedAlpha | 5 | |
| Over | 6 | |
| In | 7 | |
| Out | 8 | |
| AddWAlpha | 9 | |
| SubtractWAlpha | 10 | |
| MultiplyWAlpha | 11 | |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | _input | | | The input index. |
Return value
Type: ETextureBlendType
| Key | Value | Comment |
|---|
| Replace | 0 | |
| Add | 1 | |
| Subtract | 2 | |
| Multiply | 3 | |
| Alpha | 4 | |
| PreMultipliedAlpha | 5 | |
| Over | 6 | |
| In | 7 | |
| Out | 8 | |
| AddWAlpha | 9 | |
| SubtractWAlpha | 10 | |
| MultiplyWAlpha | 11 | |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| _input | int | | | The input index. |
Return value
Type: ETextureBlendType
| Key | Value | Comment |
|---|
| ETextureBlendType_Replace | 0 | |
| ETextureBlendType_Add | 1 | |
| ETextureBlendType_Subtract | 2 | |
| ETextureBlendType_Multiply | 3 | |
| ETextureBlendType_Alpha | 4 | |
| ETextureBlendType_PreMultipliedAlpha | 5 | |
| ETextureBlendType_Over | 6 | |
| ETextureBlendType_In | 7 | |
| ETextureBlendType_Out | 8 | |
| ETextureBlendType_AddWAlpha | 9 | |
| ETextureBlendType_SubtractWAlpha | 10 | |
| ETextureBlendType_MultiplyWAlpha | 11 | |
IsA
Returns true if ShadingLayeredBlendNode is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ShadingLayeredBlendNode is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ShadingLayeredBlendNode is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ShadingLayeredBlendNode is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ShadingLayeredBlendNode object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
SetDefaultParameter
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be set. |
real | r | | | The value of red to which the default input will be set. |
real | g | | | The value of green to which the default input will be set. |
real | b | | | The value of blue to which the default input will be set. |
real | a | | | The value of alpha to which the default input will be set. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be set. |
float | r | | | The value of red to which the default input will be set. |
float | g | | | The value of green to which the default input will be set. |
float | b | | | The value of blue to which the default input will be set. |
float | a | | | The value of alpha to which the default input will be set. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be set. |
| r | float | | | The value of red to which the default input will be set. |
| g | float | | | The value of green to which the default input will be set. |
| b | float | | | The value of blue to which the default input will be set. |
| a | float | | | The value of alpha to which the default input will be set. |
The default node inputs.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be set. |
ShadingNode | input_node | | | The node to be set as input. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be set. |
ShadingNode | input_node | | | The node to be set as input. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| input_id | int | | | The id of the input to be set. |
| input_node | ShadingNode | | | The node to be set as input. |
Return value
Type: bool
The blend type per input connection.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | _input | | | The input index. |
| ETextureBlendType | _blendType | | | The blend type to use. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | _input | | | The input index. |
| ETextureBlendType | _blendType | | | The blend type to use. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| _input | int | | | The input index. |
| _blendType | ETextureBlendType | | | The blend type to use. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spShadingLayeredBlendNode, and if this is the case, returns the object cast into spShadingLayeredBlendNode.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ShadingLayeredBlendNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ShadingLayeredBlendNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ShadingLayeredBlendNode
