Contents

addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:parameterFlags:)

Creates an RGB color parameter and adds it to the plug-in’s parameter list.

Declaration

func addColorParameter(withName name: String, parameterID: UInt32, defaultRed red: Double, defaultGreen green: Double, defaultBlue blue: Double, parameterFlags flags: FxParameterFlags) -> Bool

Parameters

  • name:

    The name of the parameter in the user interface.

  • parameterID:

    The unique identifier for a parameter. Used to retrieve, set, or validate the parameter.

  • red:

    The initial red value of the parameter in float (0.0 - 1.0) space.

  • green:

    The initial green value of the parameter in float (0.0 - 1.0) space.

  • blue:

    The initial blue value of the parameter in float (0.0 - 1.0) space.

  • flags:

    The flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates an RGB color parameter; otherwise NO.

Discussion

The parameter assumes the default color values are in the sRGB color space.

See Also

Instance Methods