FxParameterCreationAPI_v5
Defines the methods provided by the host application to create parameters.
Declaration
protocol FxParameterCreationAPI_v5Mentioned in
Overview
A plug-in uses the methods defined in this protocol (along with those defined in FxOptionalParameterAPI.h) to populate its parameter list. Each parameter is created with a unique numeric parameter ID. The host application uses this parameter ID to identify a parameter, and stores the parameter ID in a saved project file. If a new version of a plug-in removes a parameter, the host application will then ignore any saved parameter data for that obsolete parameter in a project that was saved while using the old version of the plug-in. This implies that a new version plug-in should never change the ID of a given parameter unless it intentionally wants to obsolesce old value data in saved projects. Similarly, it should not introduce a new parameter with an ID that has already been obsolesced.
This is version 5 of the Parameter Creation API. This version 5 protocol is not a superset of version 4.
Topics
Instance Methods
addAngleSlider(withName:parameterID:defaultDegrees:parameterMinDegrees:parameterMaxDegrees:parameterFlags:)addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parameterFlags:)addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:parameterFlags:)addCustomParameter(withName:parameterID:defaultValue:parameterFlags:)addFloatSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addFontMenu(withName:parameterID:fontName:parameterFlags:)addGradient(withName:parameterID:parameterFlags:)addHelpButton(withName:parameterID:selector:parameterFlags:)addHistogram(withName:parameterID:parameterFlags:)addImageReference(withName:parameterID:parameterFlags:)addIntSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addPathPicker(withName:parameterID:parameterFlags:)addPercentSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addPointParameter(withName:parameterID:defaultX:defaultY:parameterFlags:)addPopupMenu(withName:parameterID:defaultValue:menuEntries:parameterFlags:)addPushButton(withName:parameterID:selector:parameterFlags:)addStringParameter(withName:parameterID:defaultValue:parameterFlags:)addToggleButton(withName:parameterID:defaultValue:parameterFlags:)endParameterSubGroup()startParameterSubGroup(_:parameterID:parameterFlags:)