v9.0 (2011)
ICE Shaders
Registers a new shader family. This shader family can
subsequently be used to apply to new shaders using the ShaderDef.AddShaderFamily
call. The family name should be kept reasonably short. The display
name is shown to the user if the family is registered, for any
informative messages and tooltips.
The family can set a default display color, that will be used if
the a shader node of this family is shown in the rendertree. If
multiple families are used on a given shader, the primary family
dictates the color.
The family can also indicate whether the shader node will support a
shaderball by default.
XSIApplication.RegisterShaderFamily( in_name, in_displayName, [in_description], [in_nodeRed], [in_nodeGreen], [in_nodeBlue], [in_shaderball] ); |
| Parameter | Type | Description |
|---|---|---|
| in_name | String | The intrinsic family name. This should be kept fairly short (6-10 characters). |
| in_displayName | String | The display name of the shader family. This is the family name as shown in the UI. |
| in_description | String | An optional, verbose description of the shader family.
Default Value: "" |
| in_nodeRed | Long | The red color component of the family's node color, as shown in
the rendertree. Range: 0-255.
Default Value: 212 |
| in_nodeGreen | Long | The green color component of the family's node color, as shown
in the rendertree. Range: 0-255.
Default Value: 154 |
| in_nodeBlue | Long | The blue color component of the family's node color, as shown
in the rendertree. Range: 0-255.
Default Value: 96 |
| in_shaderball | Boolean | If true, this shader family supports rendering through the
shaderball.
Default Value: False |