Simplygon 9 Documentation

# class ColorCasterSettings

ColorCasterSettings is the interface for basic color caster settings.

# Properties

Property Description
BakeOpacityInAlpha If set, the total opacity of the baked layers replaces the alpha value in the output texture.
Dilation The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.
DitherType The type of dithering to use when creating the output object.
FillMode The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.
MaterialChannel The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
OpacityChannel The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used.
OutputDDSCompressionType DDS compression if output format is DDS.
OutputImageFileFormat File format for output texture.
OutputPixelFormat The output pixel format
OutputSRGB If set, output textures are exported in sRGB format. Input texture format is determined by the flag in the corresponding texture node in the material definition.
SkipCastingIfNoInputChannel If this flag is set, the caster will only run if there is at least one input material that has the main input channel which is to be cast. If the flag is not set, the caster will always produce an output, even if it is totally empty/unset.
UseMultisampling Enable or disable multisampling.

# Methods

Method Description
GetClass Get the name of the ColorCasterSettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
IsA Returns true if ColorCasterSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ColorCasterSettings object is invalid.
ValidateSettings Validates the current settings values.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spColorCasterSettings, and if this is the case, returns the object cast into spColorCasterSettings.

# Properties details

# BakeOpacityInAlpha

If set, the total opacity of the baked layers replaces the alpha value in the output texture.

    # Dilation

    The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.

      # DitherType

      The type of dithering to use when creating the output object.

        # FillMode

        The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.

          # MaterialChannel

          The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.

            # OpacityChannel

            The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used.

              # OutputDDSCompressionType

              DDS compression if output format is DDS.

                # OutputImageFileFormat

                File format for output texture.

                  # OutputPixelFormat

                  The output pixel format

                    # OutputSRGB

                    If set, output textures are exported in sRGB format. Input texture format is determined by the flag in the corresponding texture node in the material definition.

                      # SkipCastingIfNoInputChannel

                      If this flag is set, the caster will only run if there is at least one input material that has the main input channel which is to be cast. If the flag is not set, the caster will always produce an output, even if it is totally empty/unset.

                        # UseMultisampling

                        Enable or disable multisampling.

                          # Methods details

                          # GetClass

                          Get the name of the ColorCasterSettings class.

                            # GetErrorString

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

                              # IsA

                              Returns true if ColorCasterSettings is a or is a descendant of the class named as the type parameter.

                                # IsNull

                                Returns true if the ColorCasterSettings object is invalid.

                                  # 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.

                                      # SafeCast

                                      SafeCast makes sure the input object is of a class that can be cast into spColorCasterSettings, and if this is the case, returns the object cast into spColorCasterSettings.

                                        ← DisplacementCasterSettings →