Skip to content
On this page

class AttributeTessellationSamplingSettings

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

Properties

PropertyDescription
AttributeFormatThe attribute data format (Setting only applicable if also allocating the attribute while sampling/injecting data)
BlendOperationBlend operation. How to interpret multiple samples when inserting into the final sample.
NameThe name of the AttributeTessellationSamplingSettings object. (Inherited from Object)
SourceMaterialIdId of the source material in the materials list to sample. To sample all materials, set to -1.
SupersamplingCountThe number of times to super-sample into the tessellated attribute.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
FlipChannelFlips/negates the values on one channel (0-3)
GetBoolParameterGet a named parameter boolean value. (Inherited from SettingsObject)
GetChannelBiasGets the current bias value for one channel (0-3)
GetClassGet the name of the AttributeTessellationSamplingSettings class. (Inherited from Object)
GetDoubleParameterGet a named parameter floating point value. (Inherited from SettingsObject)
GetErrorStringReturns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameterGet a named parameter integer value. (Inherited from SettingsObject)
GetStringParameterGet a named parameter string value. (Inherited from SettingsObject)
GetTransformationToMatrix4x4Copy the transformation kernel data to a 4x4 matrix
GetUIntParameterGet a named parameter unsigned integer value. (Inherited from SettingsObject)
IsAReturns true if AttributeTessellationSamplingSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the AttributeTessellationSamplingSettings object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
NonNullReturns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the AttributeTessellationSamplingSettings object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
ResetTransformationSet the sample transformation to pass the data unmodified.
SetBoolParameterSet a named parameter boolean value. (Inherited from SettingsObject)
SetChannelBiasSets the bias value for one channel (0-3)
SetChannelSamplingKernelSets the sampling kernel on one channel (0-3)
SetDoubleParameterSet a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameterSet a named parameter integer value. (Inherited from SettingsObject)
SetStringParameterSet a named parameter string value. (Inherited from SettingsObject)
SetTransformationFromMatrix4x4Copy the transformation kernel data from a 4x4 matrix
SetUIntParameterSet a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNamesSet 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)
ToJSONGet settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettingsValidates the current settings values. (Inherited from SettingsObject)

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 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)

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 details

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.

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.

GetErrorString

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

GetIntParameter

Get a named parameter integer value.

GetStringParameter

Get a named parameter string value.

GetTransformationToMatrix4x4

Copy the transformation kernel data to a 4x4 matrix

GetUIntParameter

Get a named parameter unsigned integer value.

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)