`class` MaterialEvaluationShaderAttribute

MaterialEvaluationShaderAttribute is used to bind geometry data fields to the generated compute caster.

Properties

Property	Description
FieldFormat	The attribute format
FieldName	The geometry field name. This is optional parameter unless using a custom field.
FieldType	The geometry field data type. Required field.
Name	The name of the MaterialEvaluationShaderAttribute object. (Inherited from Object)

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 MaterialEvaluationShaderAttribute class. (Inherited from Object)
IsA	Returns true if MaterialEvaluationShaderAttribute is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the MaterialEvaluationShaderAttribute object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the MaterialEvaluationShaderAttribute object is valid. (Inherited from Object)
NonNull	Returns true if the MaterialEvaluationShaderAttribute object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the MaterialEvaluationShaderAttribute 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 spMaterialEvaluationShaderAttribute, and if this is the case, returns the object cast into spMaterialEvaluationShaderAttribute. (Inherited from Object)

Properties details

FieldFormat

The attribute format

Type	Name	Min	Max	Description
EAttributeFormat	value			The attribute format.

Key	Value	Comment
U8	4097	1 unsigned 8-bit value.
S8	4353	1 signed 8-bit value.
U8vec2	8193	2 unsigned 8-bit values.
S8vec2	8449	2 signed 8-bit values.
U8vec3	12289	3 unsigned 8-bit values.
S8vec3	12545	3 signed 8-bit values.
U8vec4	16385	4 unsigned 8-bit values.
S8vec4	16641	4 signed 8-bit values.
U16	4098	1 unsigned 16-bit value.
S16	4354	1 signed 16-bit value.
U16vec2	8194	2 unsigned 16-bit values.
S16vec2	8450	2 signed 16-bit values.
U16vec3	12290	3 unsigned 16-bit values.
S16vec3	12546	3 signed 16-bit values.
U16vec4	16386	4 unsigned 16-bit values.
S16vec4	16642	4 signed 16-bit values.
U32	4100	1 unsigned 32-bit value.
S32	4356	1 signed 32-bit value.
F32	4612	1 floating-point 32-bit value.
U32vec2	8196	2 unsigned 32-bit values.
S32vec2	8452	2 signed 32-bit values.
F32vec2	8708	2 floating-point 32-bit values.
U32vec3	12292	3 unsigned 32-bit values.
S32vec3	12548	3 signed 32-bit values.
F32vec3	12804	3 floating-point 32-bit values.
U32vec4	16388	4 unsigned 32-bit values.
S32vec4	16644	4 signed 32-bit values.
F32vec4	16900	4 floating-point 32-bit values.
U64	4104	1 unsigned 64-bit value.
S64	4360	1 signed 64-bit value.
F64	4616	1 floating-point 64-bit value.
F64vec2	8712	2 floating-point 64-bit values.
F64vec3	12808	3 floating-point 64-bit values.
F64vec4	16904	4 floating-point 64-bit values.

Type	Name	Min	Max	Description
EAttributeFormat	value			The attribute format.

Key	Value	Comment
U8	4097	1 unsigned 8-bit value.
S8	4353	1 signed 8-bit value.
U8vec2	8193	2 unsigned 8-bit values.
S8vec2	8449	2 signed 8-bit values.
U8vec3	12289	3 unsigned 8-bit values.
S8vec3	12545	3 signed 8-bit values.
U8vec4	16385	4 unsigned 8-bit values.
S8vec4	16641	4 signed 8-bit values.
U16	4098	1 unsigned 16-bit value.
S16	4354	1 signed 16-bit value.
U16vec2	8194	2 unsigned 16-bit values.
S16vec2	8450	2 signed 16-bit values.
U16vec3	12290	3 unsigned 16-bit values.
S16vec3	12546	3 signed 16-bit values.
U16vec4	16386	4 unsigned 16-bit values.
S16vec4	16642	4 signed 16-bit values.
U32	4100	1 unsigned 32-bit value.
S32	4356	1 signed 32-bit value.
F32	4612	1 floating-point 32-bit value.
U32vec2	8196	2 unsigned 32-bit values.
S32vec2	8452	2 signed 32-bit values.
F32vec2	8708	2 floating-point 32-bit values.
U32vec3	12292	3 unsigned 32-bit values.
S32vec3	12548	3 signed 32-bit values.
F32vec3	12804	3 floating-point 32-bit values.
U32vec4	16388	4 unsigned 32-bit values.
S32vec4	16644	4 signed 32-bit values.
F32vec4	16900	4 floating-point 32-bit values.
U64	4104	1 unsigned 64-bit value.
S64	4360	1 signed 64-bit value.
F64	4616	1 floating-point 64-bit value.
F64vec2	8712	2 floating-point 64-bit values.
F64vec3	12808	3 floating-point 64-bit values.
F64vec4	16904	4 floating-point 64-bit values.

Syntax

python

# Setter
None SetFieldFormat(value: EAttributeFormat_*)

# Getter
EAttributeFormat_* GetFieldFormat()

SetFieldFormat parameters

Name	Type	Min	Max	Description
value	EAttributeFormat			The attribute format.

GetFieldFormat return value

Type: EAttributeFormat

Default: F32vec4

Key	Value	Comment
EAttributeFormat_U8	4097	1 unsigned 8-bit value.
EAttributeFormat_S8	4353	1 signed 8-bit value.
EAttributeFormat_U8vec2	8193	2 unsigned 8-bit values.
EAttributeFormat_S8vec2	8449	2 signed 8-bit values.
EAttributeFormat_U8vec3	12289	3 unsigned 8-bit values.
EAttributeFormat_S8vec3	12545	3 signed 8-bit values.
EAttributeFormat_U8vec4	16385	4 unsigned 8-bit values.
EAttributeFormat_S8vec4	16641	4 signed 8-bit values.
EAttributeFormat_U16	4098	1 unsigned 16-bit value.
EAttributeFormat_S16	4354	1 signed 16-bit value.
EAttributeFormat_U16vec2	8194	2 unsigned 16-bit values.
EAttributeFormat_S16vec2	8450	2 signed 16-bit values.
EAttributeFormat_U16vec3	12290	3 unsigned 16-bit values.
EAttributeFormat_S16vec3	12546	3 signed 16-bit values.
EAttributeFormat_U16vec4	16386	4 unsigned 16-bit values.
EAttributeFormat_S16vec4	16642	4 signed 16-bit values.
EAttributeFormat_U32	4100	1 unsigned 32-bit value.
EAttributeFormat_S32	4356	1 signed 32-bit value.
EAttributeFormat_F32	4612	1 floating-point 32-bit value.
EAttributeFormat_U32vec2	8196	2 unsigned 32-bit values.
EAttributeFormat_S32vec2	8452	2 signed 32-bit values.
EAttributeFormat_F32vec2	8708	2 floating-point 32-bit values.
EAttributeFormat_U32vec3	12292	3 unsigned 32-bit values.
EAttributeFormat_S32vec3	12548	3 signed 32-bit values.
EAttributeFormat_F32vec3	12804	3 floating-point 32-bit values.
EAttributeFormat_U32vec4	16388	4 unsigned 32-bit values.
EAttributeFormat_S32vec4	16644	4 signed 32-bit values.
EAttributeFormat_F32vec4	16900	4 floating-point 32-bit values.
EAttributeFormat_U64	4104	1 unsigned 64-bit value.
EAttributeFormat_S64	4360	1 signed 64-bit value.
EAttributeFormat_F64	4616	1 floating-point 64-bit value.
EAttributeFormat_F64vec2	8712	2 floating-point 64-bit values.
EAttributeFormat_F64vec3	12808	3 floating-point 64-bit values.
EAttributeFormat_F64vec4	16904	4 floating-point 64-bit values.

FieldName

The geometry field name. This is optional parameter unless using a custom field.

Type	Name	Min	Max	Description
`const char *`	value			The geometry field name.

Type	Name	Min	Max	Description
`string`	value			The geometry field name.

Name	Type	Min	Max	Description
value	`str`			The geometry field name.

FieldType

The geometry field data type. Required field.

Type	Name	Min	Max	Description
EGeometryDataFieldType	value			The geometry field data type.

Key	Value	Comment
Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
UserVertexField	9	User-defined Per-vertex geometry data field.
UserCornerField	10	User-defined Per-corner geometry data field.
UserTriangleField	11	User-defined Per-triangle geometry data field.
CustomField	12	Custom-size user-defined geometry data field.

Type	Name	Min	Max	Description
EGeometryDataFieldType	value			The geometry field data type.

Key	Value	Comment
Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
UserVertexField	9	User-defined Per-vertex geometry data field.
UserCornerField	10	User-defined Per-corner geometry data field.
UserTriangleField	11	User-defined Per-triangle geometry data field.
CustomField	12	Custom-size user-defined geometry data field.

Name	Type	Min	Max	Description
value	EGeometryDataFieldType			The geometry field data type.

Key	Value	Comment
EGeometryDataFieldType_Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
EGeometryDataFieldType_Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
EGeometryDataFieldType_TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_UserVertexField	9	User-defined Per-vertex geometry data field.
EGeometryDataFieldType_UserCornerField	10	User-defined Per-corner geometry data field.
EGeometryDataFieldType_UserTriangleField	11	User-defined Per-triangle geometry data field.
EGeometryDataFieldType_CustomField	12	Custom-size user-defined geometry data field.

Name

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

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

Methods details

AddObserver

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

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

GetClass

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

IsA

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

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if MaterialEvaluationShaderAttribute is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if MaterialEvaluationShaderAttribute is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if MaterialEvaluationShaderAttribute is, or is a descendant of.

IsNull

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

IsSameObjectAs

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

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Name	Type	Min	Max	Description
object	Object			Object to compare with.

NonNull

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

PrintInfo

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

RemoveObserver

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

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

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)

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spMaterialEvaluationShaderAttribute, and if this is the case, returns the object cast into spMaterialEvaluationShaderAttribute. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class MaterialEvaluationShaderAttribute ​

Properties ​

Methods ​

Static methods ​

Properties details ​

FieldFormat ​

FieldName ​

FieldType ​

Name ​

Methods details ​

AddObserver ​

GetClass ​

IsA ​

IsNull ​

IsSameObjectAs ​

NonNull ​