Simplygon 10.2.400.0
class MaterialEvaluationShader
MaterialEvaluationShader is used to setup information used during compute casting to aid in texture baking complicated shader graphs.
Properties
| Property | Description |
|---|---|
| MaterialEvaluationShaderAttributeTable | The material evaluation shader attributes. |
| MaterialEvaluationShaderDefineTable | The material evaluation shader evaluation preprocessor defines. |
| Name | The name of the MaterialEvaluationShader object. (Inherited from Object) |
| 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
| Method | Description |
|---|---|
| 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
| 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 spMaterialEvaluationShader, and if this is the case, returns the object cast into spMaterialEvaluationShader. (Inherited from Object) |
Properties details
MaterialEvaluationShaderAttributeTable
The material evaluation shader attributes.
Syntax
cpp
// Setter
void SetMaterialEvaluationShaderAttributeTable( const spMaterialEvaluationShaderAttributeTable & value ) const;
// Getter
spMaterialEvaluationShaderAttributeTable GetMaterialEvaluationShaderAttributeTable() const;SetMaterialEvaluationShaderAttributeTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| MaterialEvaluationShaderAttributeTable | value | The material evaluation shader attributes. |
GetMaterialEvaluationShaderAttributeTable return value
Syntax
csharp
// Setter
void SetMaterialEvaluationShaderAttributeTable(spMaterialEvaluationShaderAttributeTable value);
// Getter
spMaterialEvaluationShaderAttributeTable GetMaterialEvaluationShaderAttributeTable();SetMaterialEvaluationShaderAttributeTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| MaterialEvaluationShaderAttributeTable | value | The material evaluation shader attributes. |
GetMaterialEvaluationShaderAttributeTable return value
Syntax
python
# Setter
None SetMaterialEvaluationShaderAttributeTable(value: spMaterialEvaluationShaderAttributeTable)
# Getter
spMaterialEvaluationShaderAttributeTable GetMaterialEvaluationShaderAttributeTable()SetMaterialEvaluationShaderAttributeTable parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | MaterialEvaluationShaderAttributeTable | The material evaluation shader attributes. |
GetMaterialEvaluationShaderAttributeTable return value
MaterialEvaluationShaderDefineTable
The material evaluation shader evaluation preprocessor defines.
Syntax
cpp
// Setter
void SetMaterialEvaluationShaderDefineTable( const spMaterialEvaluationShaderDefineTable & value ) const;
// Getter
spMaterialEvaluationShaderDefineTable GetMaterialEvaluationShaderDefineTable() const;SetMaterialEvaluationShaderDefineTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| MaterialEvaluationShaderDefineTable | value | The material evaluation shader evaluation preprocessor defines. |
GetMaterialEvaluationShaderDefineTable return value
Syntax
csharp
// Setter
void SetMaterialEvaluationShaderDefineTable(spMaterialEvaluationShaderDefineTable value);
// Getter
spMaterialEvaluationShaderDefineTable GetMaterialEvaluationShaderDefineTable();SetMaterialEvaluationShaderDefineTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| MaterialEvaluationShaderDefineTable | value | The material evaluation shader evaluation preprocessor defines. |
GetMaterialEvaluationShaderDefineTable return value
Syntax
python
# Setter
None SetMaterialEvaluationShaderDefineTable(value: spMaterialEvaluationShaderDefineTable)
# Getter
spMaterialEvaluationShaderDefineTable GetMaterialEvaluationShaderDefineTable()SetMaterialEvaluationShaderDefineTable parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | MaterialEvaluationShaderDefineTable | The material evaluation shader evaluation preprocessor defines. |
GetMaterialEvaluationShaderDefineTable return value
Name
The name of the MaterialEvaluationShader object. (Inherited from Object)
Syntax
cpp
// Setter
void SetName( const char * name ) const;
// Getter
spString GetName() const;SetName parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | name | New name of the object. |
GetName return value
Type: spString
Syntax
csharp
// Setter
void SetName(string name);
// Getter
string GetName();SetName parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | name | New name of the object. |
GetName return value
Type: string
Syntax
python
# Setter
None SetName(name: str)
# Getter
str GetName()SetName parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| name | str | New name of the object. |
GetName return value
Type: str
ShaderCode
The user's block of the shader code.
Syntax
cpp
// Setter
void SetShaderCode( const char * value ) const;
// Getter
spString GetShaderCode() const;SetShaderCode parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | value | The shader code block. |
GetShaderCode return value
Type: spString
Syntax
csharp
// Setter
void SetShaderCode(string value);
// Getter
string GetShaderCode();SetShaderCode parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | value | The shader code block. |
GetShaderCode return value
Type: string
Syntax
python
# Setter
None SetShaderCode(value: str)
# Getter
str GetShaderCode()SetShaderCode parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | str | The shader code block. |
GetShaderCode return value
Type: str
ShaderEvaluationFunctionTable
The material evaluation shader evaluation functions binding.
Syntax
cpp
// Setter
void SetShaderEvaluationFunctionTable( const spShaderEvaluationFunctionTable & value ) const;
// Getter
spShaderEvaluationFunctionTable GetShaderEvaluationFunctionTable() const;SetShaderEvaluationFunctionTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| ShaderEvaluationFunctionTable | value | The material evaluation shader evaluation functions binding. |
GetShaderEvaluationFunctionTable return value
Syntax
csharp
// Setter
void SetShaderEvaluationFunctionTable(spShaderEvaluationFunctionTable value);
// Getter
spShaderEvaluationFunctionTable GetShaderEvaluationFunctionTable();SetShaderEvaluationFunctionTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| ShaderEvaluationFunctionTable | value | The material evaluation shader evaluation functions binding. |
GetShaderEvaluationFunctionTable return value
Syntax
python
# Setter
None SetShaderEvaluationFunctionTable(value: spShaderEvaluationFunctionTable)
# Getter
spShaderEvaluationFunctionTable GetShaderEvaluationFunctionTable()SetShaderEvaluationFunctionTable parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | ShaderEvaluationFunctionTable | The material evaluation shader evaluation functions binding. |
GetShaderEvaluationFunctionTable return value
ShaderHeader
An optional block of data which is included at the top of the generated shader code.
Syntax
cpp
// Setter
void SetShaderHeader( const char * value ) const;
// Getter
spString GetShaderHeader() const;SetShaderHeader parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | value | The shader header block. |
GetShaderHeader return value
Type: spString
Syntax
csharp
// Setter
void SetShaderHeader(string value);
// Getter
string GetShaderHeader();SetShaderHeader parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | value | The shader header block. |
GetShaderHeader return value
Type: string
Syntax
python
# Setter
None SetShaderHeader(value: str)
# Getter
str GetShaderHeader()SetShaderHeader parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | str | The shader header block. |
GetShaderHeader return value
Type: str
ShaderLanguage
The shading language used by the evaluation shader.
Syntax
cpp
// Setter
void SetShaderLanguage( Simplygon::EShaderLanguage value ) const;
// Getter
Simplygon::EShaderLanguage GetShaderLanguage() const;SetShaderLanguage parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| EShaderLanguage | value | The language to use |
GetShaderLanguage return value
Type: EShaderLanguage
| Key | Value | Comment |
|---|---|---|
| HLSL | 0 | HLSL, the High Level Shading Language. (default profile=6.0) |
| GLSL | 1 | GLSL, the OpenGL/Vulkan Shading Language. (default profile=4.50) |
| GLSL_4_50 | 17185 | GLSL 4.50 |
| GLSL_4_60 | 17345 | GLSL 4.60 |
| HLSL_6_0 | 24576 | HLSL 6.0 |
| HLSL_6_1 | 24592 | HLSL 6.1 |
| HLSL_6_2 | 24608 | HLSL 6.2 |
| HLSL_6_3 | 24624 | HLSL 6.3 |
| HLSL_6_4 | 24640 | HLSL 6.4 |
| HLSL_6_5 | 24656 | HLSL 6.5 |
| HLSL_6_6 | 24672 | HLSL 6.6 |
| HLSL_6_7 | 24688 | HLSL 6.7 |
Syntax
csharp
// Setter
void SetShaderLanguage(EShaderLanguage value);
// Getter
EShaderLanguage GetShaderLanguage();SetShaderLanguage parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| EShaderLanguage | value | The language to use |
GetShaderLanguage return value
Type: EShaderLanguage
| Key | Value | Comment |
|---|---|---|
| HLSL | 0 | HLSL, the High Level Shading Language. (default profile=6.0) |
| GLSL | 1 | GLSL, the OpenGL/Vulkan Shading Language. (default profile=4.50) |
| GLSL_4_50 | 17185 | GLSL 4.50 |
| GLSL_4_60 | 17345 | GLSL 4.60 |
| HLSL_6_0 | 24576 | HLSL 6.0 |
| HLSL_6_1 | 24592 | HLSL 6.1 |
| HLSL_6_2 | 24608 | HLSL 6.2 |
| HLSL_6_3 | 24624 | HLSL 6.3 |
| HLSL_6_4 | 24640 | HLSL 6.4 |
| HLSL_6_5 | 24656 | HLSL 6.5 |
| HLSL_6_6 | 24672 | HLSL 6.6 |
| HLSL_6_7 | 24688 | HLSL 6.7 |
Syntax
python
# Setter
None SetShaderLanguage(value: EShaderLanguage_*)
# Getter
EShaderLanguage_* GetShaderLanguage()SetShaderLanguage parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | EShaderLanguage | The language to use |
GetShaderLanguage return value
Type: EShaderLanguage
| Key | Value | Comment |
|---|---|---|
| EShaderLanguage_HLSL | 0 | HLSL, the High Level Shading Language. (default profile=6.0) |
| EShaderLanguage_GLSL | 1 | GLSL, the OpenGL/Vulkan Shading Language. (default profile=4.50) |
| EShaderLanguage_GLSL_4_50 | 17185 | GLSL 4.50 |
| EShaderLanguage_GLSL_4_60 | 17345 | GLSL 4.60 |
| EShaderLanguage_HLSL_6_0 | 24576 | HLSL 6.0 |
| EShaderLanguage_HLSL_6_1 | 24592 | HLSL 6.1 |
| EShaderLanguage_HLSL_6_2 | 24608 | HLSL 6.2 |
| EShaderLanguage_HLSL_6_3 | 24624 | HLSL 6.3 |
| EShaderLanguage_HLSL_6_4 | 24640 | HLSL 6.4 |
| EShaderLanguage_HLSL_6_5 | 24656 | HLSL 6.5 |
| EShaderLanguage_HLSL_6_6 | 24672 | HLSL 6.6 |
| EShaderLanguage_HLSL_6_7 | 24688 | HLSL 6.7 |
ShaderParameterTable
The material evaluation shader parameters.
Syntax
cpp
// Setter
void SetShaderParameterTable( const spShaderParameterTable & value ) const;
// Getter
spShaderParameterTable GetShaderParameterTable() const;SetShaderParameterTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| ShaderParameterTable | value | The material evaluation shader parameters. |
GetShaderParameterTable return value
Type: ShaderParameterTable
Syntax
csharp
// Setter
void SetShaderParameterTable(spShaderParameterTable value);
// Getter
spShaderParameterTable GetShaderParameterTable();SetShaderParameterTable parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| ShaderParameterTable | value | The material evaluation shader parameters. |
GetShaderParameterTable return value
Type: ShaderParameterTable
Syntax
python
# Setter
None SetShaderParameterTable(value: spShaderParameterTable)
# Getter
spShaderParameterTable GetShaderParameterTable()SetShaderParameterTable parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| value | ShaderParameterTable | The material evaluation shader parameters. |
GetShaderParameterTable return value
Type: ShaderParameterTable
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
cpp
rid AddObserver( const spObserver & observer ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
Observer | observer | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
csharp
int AddObserver(spObserver observer);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
Observer | observer | Observer is the object that will receive events. |
Return value
Type: int
Syntax
python
int AddObserver(observer: spObserver)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| observer | Observer | Observer is the object that will receive events. |
Return value
Type: int
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)
Syntax
cpp
bool IsA( const char * type ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | type | Name of the class to check if MaterialEvaluationShader is, or is a descendant of. |
Return value
Type: bool
Syntax
csharp
bool IsA(string type);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | type | Name of the class to check if MaterialEvaluationShader is, or is a descendant of. |
Return value
Type: bool
Syntax
python
bool IsA(type: str)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| type | str | Name of the class to check if MaterialEvaluationShader is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the MaterialEvaluationShader object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the MaterialEvaluationShader object is valid. (Inherited from Object)
Syntax
cpp
bool IsSameObjectAs( const spObject & object ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| Object | object | Object to compare with. |
Return value
Type: bool
Syntax
csharp
bool IsSameObjectAs(spObject object);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| Object | object | Object to compare with. |
Return value
Type: bool
Syntax
python
bool IsSameObjectAs(object: spObject)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| object | Object | Object to compare with. |
Return value
Type: bool
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.
Syntax
cpp
Simplygon::EErrorCodes LoadShaderFromFilePath( const char * path , Simplygon::EShaderLanguage language ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | path | The path to the shader to be loaded. | ||
| EShaderLanguage | language | The shader language the shader is written in |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|---|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FileError | -15 | a file read/write failed. |
| InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| UnexpectedError | -18 | an unexpected error happened. |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
csharp
EErrorCodes LoadShaderFromFilePath(string path, EShaderLanguage language);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | path | The path to the shader to be loaded. | ||
| EShaderLanguage | language | The shader language the shader is written in |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|---|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FileError | -15 | a file read/write failed. |
| InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| UnexpectedError | -18 | an unexpected error happened. |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
python
EErrorCodes_* LoadShaderFromFilePath(path: str, language: EShaderLanguage_*)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| path | str | The path to the shader to be loaded. | ||
| language | EShaderLanguage | The shader language the shader is written in |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|---|---|
| EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
| EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
| EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
| EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
| EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
| EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
| EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
| EErrorCodes_FileError | -15 | a file read/write failed. |
| EErrorCodes_InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| EErrorCodes_DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| EErrorCodes_UnexpectedError | -18 | an unexpected error happened. |
| EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
| EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
| EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
| EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
| EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
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)
Syntax
cpp
void RemoveObserver( rid observerId ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
rid | observerId | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
csharp
void RemoveObserver(int observerId);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
int | observerId | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
python
None RemoveObserver(observerId: int)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| observerId | int | ObserverId is the id returned by AddObserver when the observer was added. |
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)
Syntax
cpp
static bool IsClassA( const char * type ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
const char * | type | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
csharp
static bool IsClassA(string type);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
string | type | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
python
@staticmethod
bool IsClassA(type: str)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| type | str | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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)
Syntax
cpp
static spMaterialEvaluationShader SafeCast( const spObject & object ) const;Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| Object | object | Object to cast. |
Return value
Type: MaterialEvaluationShader
Syntax
csharp
static spMaterialEvaluationShader SafeCast(spObject object);Parameters
| Type | Name | Min | Max | Description |
|---|---|---|---|---|
| Object | object | Object to cast. |
Return value
Type: MaterialEvaluationShader
Syntax
python
@staticmethod
spMaterialEvaluationShader SafeCast(object: spObject)Parameters
| Name | Type | Min | Max | Description |
|---|---|---|---|---|
| object | Object | Object to cast. |
Return value
Type: MaterialEvaluationShader