Simplygon 10.4.132.0

Appearance

On this page

class MaterialEvaluationShader ​

MaterialEvaluationShader is used to setup information used during compute casting to aid in texture baking complicated shader graphs.

Properties ​

PropertyDescription
MaterialEvaluationShaderAttributeTableThe material evaluation shader attributes.
MaterialEvaluationShaderDefineTableThe material evaluation shader evaluation preprocessor defines.
NameThe name of the MaterialEvaluationShader object. (Inherited from Object)
ShaderBinaryAn optional pre-build binary which replaces the generated shader in e.g. ComputeCasting. Note that this binary is used for advanced integrations which want to be able to e.g. amortize compilation cost or reuse bespoke shaders between castings, and is not recommended to use until the performance need arise.
ShaderBinaryBindingDigestAn optional binding digest which defines the expected input bindings for the ShaderBinary pre-compiled binary. If defined, a digest will be calculated from the current input bindings, and confirmed to match the expected digest.
ShaderBinarySourceDigestAn optional source digest which defines the expected source generated for the ShaderBinary pre-compiled binary. If defined, the source will be re-generated and compared with the expected digest.
ShaderCodeThe user's block of the shader code.
ShaderEvaluationFunctionTableThe material evaluation shader evaluation functions binding.
ShaderHeaderAn optional block of data which is included at the top of the generated shader code.
ShaderLanguageThe shading language used by the evaluation shader.
ShaderParameterTableThe material evaluation shader parameters.

Methods ​

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the MaterialEvaluationShader class. (Inherited from Object)
HasShaderThe method returns if a shader was loaded into memory. Use SetShaderFilePath to set the path only or use LoadShaderFromFilePath to load the shader file.
IsAReturns true if MaterialEvaluationShader is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the MaterialEvaluationShader object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the MaterialEvaluationShader object is valid. (Inherited from Object)
LoadShaderFromFilePathThis method load the shader source from disk into memory. If the load is successful HasShader method will return true and GetShaderFilePath will return null.
NonNullReturns true if the MaterialEvaluationShader object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the MaterialEvaluationShader object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)

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 spMaterialEvaluationShader, and if this is the case, returns the object cast into spMaterialEvaluationShader. (Inherited from Object)

Properties details ​

MaterialEvaluationShaderAttributeTable ​

The material evaluation shader attributes.

MaterialEvaluationShaderDefineTable ​

The material evaluation shader evaluation preprocessor defines.

Name ​

The name of the MaterialEvaluationShader object. (Inherited from Object)

ShaderBinary ​

An optional pre-build binary which replaces the generated shader in e.g. ComputeCasting. Note that this binary is used for advanced integrations which want to be able to e.g. amortize compilation cost or reuse bespoke shaders between castings, and is not recommended to use until the performance need arise.

ShaderBinaryBindingDigest ​

An optional binding digest which defines the expected input bindings for the ShaderBinary pre-compiled binary. If defined, a digest will be calculated from the current input bindings, and confirmed to match the expected digest.

ShaderBinarySourceDigest ​

An optional source digest which defines the expected source generated for the ShaderBinary pre-compiled binary. If defined, the source will be re-generated and compared with the expected digest.

ShaderCode ​

The user's block of the shader code.

ShaderEvaluationFunctionTable ​

The material evaluation shader evaluation functions binding.

ShaderHeader ​

An optional block of data which is included at the top of the generated shader code.

ShaderLanguage ​

The shading language used by the evaluation shader.

ShaderParameterTable ​

The material evaluation shader parameters.

Methods details ​

AddObserver ​

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

GetClass ​

Get the name of the MaterialEvaluationShader class. (Inherited from Object)

HasShader ​

The method returns if a shader was loaded into memory. Use SetShaderFilePath to set the path only or use LoadShaderFromFilePath to load the shader file.

IsA ​

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

IsNull ​

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

IsSameObjectAs ​

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

LoadShaderFromFilePath ​

This method load the shader source from disk into memory. If the load is successful HasShader method will return true and GetShaderFilePath will return null.

NonNull ​

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

PrintInfo ​

Prints the content/info of the MaterialEvaluationShader object to the log. (Inherited from Object)

RemoveObserver ​

Removes a previously added observer object. (Inherited from Object)

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 spMaterialEvaluationShader, and if this is the case, returns the object cast into spMaterialEvaluationShader. (Inherited from Object)