ShaderParamDef

Object Hierarchy | Related C++ Class: ShaderParamDef

Inheritance

SIObject
   ShaderParamDef

Introduced

9.0 (2011)

Description

This object represents a definition for a ShaderParameter. Shader parameter definitions are stored on the ShaderDef object in a special ShaderParamDefContainer object, which allows you to access existing parameter definitions or add new ones. To access the ShaderParamDefContainer object, call ShaderDef.InputParamDefs or ShaderDef.OutputParamDefs. From the ShaderParamDefContainer you can add new parameter definitions by calling ShaderParamDefContainer.AddParamDef or ShaderParamDefContainer.AddArrayParamDef with a set of ShaderParamDefOptions.

To access a specific shader parameter definition from an instantiated shader definition, use the ShaderParamDefContainer.GetParamDefByName method. To iterate over the entire list of input or output parameter definitions for an instantiated shader definition, use the ShaderParamDefContainer.Definitions property.

To access existing shader parameter definitions from a ShaderParameter instance, use the ShaderParameter.Definition property.

To add an array parameter (ShaderArrayParamDef), use the ShaderParamDefContainer.AddArrayParamDef method. For all other parameter types, use the ShaderParamDefContainer.AddParamDef method.

Note: This object is a generic interface. There are special accessors on the specializations of this object for the array and struct parameter types. See the ShaderArrayParamDef and ShaderStructParamDef reference pages for more details on these specializations.

Methods

IsClassOf

IsEqualTo

Properties

Application

Attributes

Capabilities

Categories

DataType

DefaultValue

DisplayName

FullName

HasDefaultValue

Help

IsArray

IsInput

IsOutput

IsStructure

MainPort

MaxValue

MinValue

Name

NestedObjects

Origin

OriginPath

Parent

SuggestedMaxValue

SuggestedMinValue

Texturable

Type

 

 

See Also

ShaderParamDefContainer.AddParamDef

ShaderParamDefContainer.AddArrayParamDef

ShaderParameter.Definition

ShaderParamDefContainer

Shader Parameter Definitions

Shader Definition examples installed with Softimage

Shader Parser examples installed with Softimage

 

Examples

• See ShaderParamDef.1.pys



Autodesk Softimage 2011