Simplygon 10.3.2100.0
class ShaderParameterTable
ShaderParameterTable keeps information on shader parameter used while setting up compute casting using the material evaluation shader.
Properties
| Property | Description |
|---|---|
| Name | The name of the ShaderParameterTable object. (Inherited from Object) |
Methods
| Method | Description |
|---|---|
| AddItem | Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem(). (Inherited from Table) |
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| AddShaderParameter | Adds a shader to the table. The returned value is the id of the parameter within the table. |
| Clear | Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table) |
| Copy | Clears the current table and copies the items from a source table. (Inherited from Table) |
| FindItem | Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned. (Inherited from Table) |
| FindItemId | Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1. (Inherited from Table) |
| FindShaderParameter | Finds a parameter in the table, using the parameter name. Note names are unique |
| FindShaderParameterId | Finds the id of a parameter in the table, using the parameter name. Note parameter names are unique. |
| GetClass | Get the name of the ShaderParameterTable class. (Inherited from Object) |
| GetItem | Returns the i:th item, using the id of the item. (Inherited from Table) |
| GetItemsCount | The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table. (Inherited from Table) |
| GetShaderParameter | Returns the i:th parameter, using the id of the parameter. |
| GetShaderParametersCount | Returns the number of parameters in the table. |
| IsA | Returns true if ShaderParameterTable is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ShaderParameterTable object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ShaderParameterTable object is valid. (Inherited from Object) |
| NonNull | Returns true if the ShaderParameterTable object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ShaderParameterTable object to the log. (Inherited from Object) |
| RemoveItem | Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id. (Inherited from Table) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RemoveShaderParameter | Removes a parameter. If GetShaderParameter is called with the parameter id, the value returned will be null. |
| SetItem | Sets an item in the table. The id must exist in the table. (Inherited from Table) |
| SetShaderParameter | Sets a parameter in the table. |
Static methods
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spShaderParameterTable, and if this is the case, returns the object cast into spShaderParameterTable. (Inherited from Object) |
Properties details
Name
The name of the ShaderParameterTable object. (Inherited from Object)
Methods details
AddItem
Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem().
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AddShaderParameter
Adds a shader to the table. The returned value is the id of the parameter within the table.
Clear
Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.
Copy
Clears the current table and copies the items from a source table.
FindItem
Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned.
FindItemId
Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1.
FindShaderParameter
Finds a parameter in the table, using the parameter name. Note names are unique
FindShaderParameterId
Finds the id of a parameter in the table, using the parameter name. Note parameter names are unique.
GetClass
Get the name of the ShaderParameterTable class. (Inherited from Object)
GetItem
Returns the i:th item, using the id of the item.
GetItemsCount
The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table.
GetShaderParameter
Returns the i:th parameter, using the id of the parameter.
GetShaderParametersCount
Returns the number of parameters in the table.
IsA
Returns true if ShaderParameterTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the ShaderParameterTable object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the ShaderParameterTable object is valid. (Inherited from Object)
NonNull
Returns true if the ShaderParameterTable object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the ShaderParameterTable object to the log. (Inherited from Object)
RemoveItem
Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
RemoveShaderParameter
Removes a parameter. If GetShaderParameter is called with the parameter id, the value returned will be null.
SetItem
Sets an item in the table. The id must exist in the table.
SetShaderParameter
Sets a parameter in the table.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spShaderParameterTable, and if this is the case, returns the object cast into spShaderParameterTable. (Inherited from Object)