`class` AttributeTessellationSamplingSettings

Settings for sampling tessellated attributes from input data, either direct injected or through material casting.

Properties

Property	Description
AttributeFormat	The attribute data format (Setting only applicable if also allocating the attribute while sampling/injecting data)
BlendOperation	Blend operation. How to interpret multiple samples when inserting into the final sample.
Name	The name of the AttributeTessellationSamplingSettings object. (Inherited from Object)
SourceMaterialId	Id of the source material in the materials list to sample. To sample all materials, set to -1.
SupersamplingCount	The number of times to super-sample into the tessellated attribute.

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
FlipChannel	Flips/negates the values on one channel (0-3)
GetBoolParameter	Get a named parameter boolean value. (Inherited from SettingsObject)
GetChannelBias	Gets the current bias value for one channel (0-3)
GetClass	Get the name of the AttributeTessellationSamplingSettings class. (Inherited from Object)
GetDoubleParameter	Get a named parameter floating point value. (Inherited from SettingsObject)
GetErrorString	Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameter	Get a named parameter integer value. (Inherited from SettingsObject)
GetStringParameter	Get a named parameter string value. (Inherited from SettingsObject)
GetTransformationToMatrix4x4	Copy the transformation kernel data to a 4x4 matrix
GetUIntParameter	Get a named parameter unsigned integer value. (Inherited from SettingsObject)
IsA	Returns true if AttributeTessellationSamplingSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the AttributeTessellationSamplingSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
NonNull	Returns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the AttributeTessellationSamplingSettings object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
ResetTransformation	Set the sample transformation to pass the data unmodified.
SetBoolParameter	Set a named parameter boolean value. (Inherited from SettingsObject)
SetChannelBias	Sets the bias value for one channel (0-3)
SetChannelSamplingKernel	Sets the sampling kernel on one channel (0-3)
SetDoubleParameter	Set a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameter	Set a named parameter integer value. (Inherited from SettingsObject)
SetStringParameter	Set a named parameter string value. (Inherited from SettingsObject)
SetTransformationFromMatrix4x4	Copy the transformation kernel data from a 4x4 matrix
SetUIntParameter	Set a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNames	Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject)
ToJSON	Get settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettings	Validates the current settings values. (Inherited from SettingsObject)

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

Properties details

AttributeFormat

The attribute data format (Setting only applicable if also allocating the attribute while sampling/injecting data)

Type	Name	Min	Max	Description
EAttributeFormat	value			The value to set AttributeFormat to.

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 value to set AttributeFormat to.

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 SetAttributeFormat(value: EAttributeFormat_*)

# Getter
EAttributeFormat_* GetAttributeFormat()

SetAttributeFormat parameters

Name	Type	Min	Max	Description
value	EAttributeFormat			The value to set AttributeFormat to.

GetAttributeFormat return value

Type: EAttributeFormat

Default: U8

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.

BlendOperation

Blend operation. How to interpret multiple samples when inserting into the final sample.

Type	Name	Min	Max	Description
EBlendOperation	value			The value to set BlendOperation to.

Key	Value	Comment
Mean	0	Use the mean of all samples
Min	1	Keep the minimum sample
Max	2	Keep the maximum sample

Type	Name	Min	Max	Description
EBlendOperation	value			The value to set BlendOperation to.

Key	Value	Comment
Mean	0	Use the mean of all samples
Min	1	Keep the minimum sample
Max	2	Keep the maximum sample

Name	Type	Min	Max	Description
value	EBlendOperation			The value to set BlendOperation to.

Key	Value	Comment
EBlendOperation_Mean	0	Use the mean of all samples
EBlendOperation_Min	1	Keep the minimum sample
EBlendOperation_Max	2	Keep the maximum sample

Name

The name of the AttributeTessellationSamplingSettings 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.

SourceMaterialId

Id of the source material in the materials list to sample. To sample all materials, set to -1.

Type	Name	Min	Max	Description
`rid`	value			The value to set SourceMaterialId to.

Type	Name	Min	Max	Description
`int`	value			The value to set SourceMaterialId to.

Name	Type	Min	Max	Description
value	`int`			The value to set SourceMaterialId to.

SupersamplingCount

The number of times to super-sample into the tessellated attribute.

Type	Name	Min	Max	Description
`unsigned int`	value	1		The value to set SupersamplingCount to.

Type	Name	Min	Max	Description
`uint`	value	1		The value to set SupersamplingCount to.

Name	Type	Min	Max	Description
value	`int`	1		The value to set SupersamplingCount to.

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.

FlipChannel

Flips/negates the values on one channel (0-3)

Type	Name	Min	Max	Description
`unsigned int`	channelIndex	0	3	The channel to flip (0-3)

Type	Name	Min	Max	Description
`uint`	channelIndex	0	3	The channel to flip (0-3)

Name	Type	Min	Max	Description
channelIndex	`int`	0	3	The channel to flip (0-3)

GetBoolParameter

Get a named parameter boolean value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetChannelBias

Gets the current bias value for one channel (0-3)

Type	Name	Min	Max	Description
`unsigned int`	channelIndex	0	3	The channel to modify bias value for

Type	Name	Min	Max	Description
`uint`	channelIndex	0	3	The channel to modify bias value for

Name	Type	Min	Max	Description
channelIndex	`int`	0	3	The channel to modify bias value for

GetClass

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

GetDoubleParameter

Get a named parameter floating point value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

GetIntParameter

Get a named parameter integer value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetStringParameter

Get a named parameter string value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetTransformationToMatrix4x4

Copy the transformation kernel data to a 4x4 matrix

Type	Name	Min	Max	Description
Matrix4x4	destMatrix			The matrix to copy the transformation kernel to.

Type	Name	Min	Max	Description
Matrix4x4	destMatrix			The matrix to copy the transformation kernel to.

Name	Type	Min	Max	Description
destMatrix	Matrix4x4			The matrix to copy the transformation kernel to.

GetUIntParameter

Get a named parameter unsigned integer value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

IsA

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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

RemoveObserver

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

ResetTransformation

Set the sample transformation to pass the data unmodified.

SetBoolParameter

Set a named parameter boolean value.

SetChannelBias

Sets the bias value for one channel (0-3)

SetChannelSamplingKernel

Sets the sampling kernel on one channel (0-3)

SetDoubleParameter

Set a named parameter floating point value.

SetIntParameter

Set a named parameter integer value.

SetStringParameter

Set a named parameter string value.

SetTransformationFromMatrix4x4

Copy the transformation kernel data from a 4x4 matrix

SetUIntParameter

Set a named parameter unsigned integer value.

SetValidateParameterNames

Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.

ToJSON

Get settings as JSON for debugging purposes.

ValidateSettings

Validates the current settings values.

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

Type	Name	Min	Max	Description
`unsigned int`	channelIndex	0	3	The channel to flip (0-3)
`real`	bias			The bias value, which is added to the final result.
`real`	input0			Input 0 (red / x)
`real`	input1			Input 1 (green / y)
`real`	input2			Input 2 (blue / z)
`real`	input3			Input 3 (alpha / w)

Type	Name	Min	Max	Description
`uint`	channelIndex	0	3	The channel to flip (0-3)
`float`	bias			The bias value, which is added to the final result.
`float`	input0			Input 0 (red / x)
`float`	input1			Input 1 (green / y)
`float`	input2			Input 2 (blue / z)
`float`	input3			Input 3 (alpha / w)

Name	Type	Min	Max	Description
channelIndex	`int`	0	3	The channel to flip (0-3)
bias	`float`			The bias value, which is added to the final result.
input0	`float`			Input 0 (red / x)
input1	`float`			Input 1 (green / y)
input2	`float`			Input 2 (blue / z)
input3	`float`			Input 3 (alpha / w)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class AttributeTessellationSamplingSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

AttributeFormat ​

BlendOperation ​

Name ​

SourceMaterialId ​

SupersamplingCount ​

Methods details ​

AddObserver ​

FlipChannel ​

GetBoolParameter ​

GetChannelBias ​

GetClass ​

GetDoubleParameter ​