Contents

getRedValue(_:greenValue:blueValue:fromParameter:at:)

Gets RGB color values (in 0.0 - 1.0 floating point) from a parameter.

Declaration

func getRedValue(_ red: UnsafeMutablePointer<Double>, greenValue green: UnsafeMutablePointer<Double>, blueValue blue: UnsafeMutablePointer<Double>, fromParameter parameterID: UInt32, at time: CMTime) -> Bool

Parameters

  • red:

    The pointer to the plug-in variable for the red value.

  • green:

    The pointer to the plug-in variable for the green value.

  • blue:

    The pointer to the plug-in variable for the blue value.

  • parameterID:

    The unique identifier for the parameter.

  • time:

    The specified time to get the values.

Return Value

Returns YES if the values are retrieved successfully; otherwise NO.

Discussion

The returned color values are in the project working color space, unless the parameter has the kFxParameterFlag_DONT_REMAP_COLORS flag set. If this flag is set, the color values are copied verbatim from the parameter with no conversion.

Depending on the host application, the time value may be relative to the start of the timeline or to the start of the clip. See Understanding time in FxPlug.

See Also

Instance Methods