Skip to content
On this page

class ShaderEvaluationFunctionTable

ShaderEvaluationFunctionTable keeps information on shader parameter used while setting up compute casting using the material evaluation shader.

Properties

PropertyDescription
NameThe name of the ShaderEvaluationFunctionTable object. (Inherited from Object)

Methods

MethodDescription
AddItemAdds 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)
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AddShaderEvaluationFunctionAdds details about the evaluation function to the table. The returned value of the shader evaluation function details
ClearClears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table)
CopyClears the current table and copies the items from a source table. (Inherited from Table)
FindItemFinds 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)
FindItemIdFinds 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)
FindShaderEvaluationFunctionFinds a shader evaluation function in the table, using the shader evaluation function name. Note names are unique
FindShaderEvaluationFunctionIdFinds the id of a shader evaluation function in the table, using the shader evaluation function name. Note parameter shader evaluation function are unique.
GetClassGet the name of the ShaderEvaluationFunctionTable class. (Inherited from Object)
GetItemReturns the i:th item, using the id of the item. (Inherited from Table)
GetItemsCountThe 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)
GetShaderEvaluationFunctionReturns the i:th shader evaluation function, using the id of the shader evaluation function .
GetShaderEvaluationFunctionsCountReturns the number of shader evaluation function in the table.
IsAReturns true if ShaderEvaluationFunctionTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ShaderEvaluationFunctionTable object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ShaderEvaluationFunctionTable object is valid. (Inherited from Object)
NonNullReturns true if the ShaderEvaluationFunctionTable object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ShaderEvaluationFunctionTable object to the log. (Inherited from Object)
RemoveItemRemoves 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)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RemoveShaderEvaluationFunctionRemoves a shader evaluation function. If GetShaderEvaluationFunction is called with the shader evaluation function id, the value returned will be null.
SetItemSets an item in the table. The id must exist in the table. (Inherited from Table)
SetShaderEvaluationFunctionSets a shader evaluation function in the table.

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spShaderEvaluationFunctionTable, and if this is the case, returns the object cast into spShaderEvaluationFunctionTable. (Inherited from Object)

Properties details

Name

The name of the ShaderEvaluationFunctionTable 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)

AddShaderEvaluationFunction

Adds details about the evaluation function to the table. The returned value of the shader evaluation function details

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.

FindShaderEvaluationFunction

Finds a shader evaluation function in the table, using the shader evaluation function name. Note names are unique

FindShaderEvaluationFunctionId

Finds the id of a shader evaluation function in the table, using the shader evaluation function name. Note parameter shader evaluation function are unique.

GetClass

Get the name of the ShaderEvaluationFunctionTable 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.

GetShaderEvaluationFunction

Returns the i:th shader evaluation function, using the id of the shader evaluation function .

GetShaderEvaluationFunctionsCount

Returns the number of shader evaluation function in the table.

IsA

Returns true if ShaderEvaluationFunctionTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)

IsNull

Returns true if the ShaderEvaluationFunctionTable object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the ShaderEvaluationFunctionTable object is valid. (Inherited from Object)

NonNull

Returns true if the ShaderEvaluationFunctionTable object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the ShaderEvaluationFunctionTable 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)

RemoveShaderEvaluationFunction

Removes a shader evaluation function. If GetShaderEvaluationFunction is called with the shader evaluation function id, the value returned will be null.

SetItem

Sets an item in the table. The id must exist in the table.

SetShaderEvaluationFunction

Sets a shader evaluation function 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 spShaderEvaluationFunctionTable, and if this is the case, returns the object cast into spShaderEvaluationFunctionTable. (Inherited from Object)