TCPPFruityPlug

[C++ only]

Declared in : FP_CPlug.h

This class is derived from TFruityPlug and adds some helper functions. It's not necessary to derive from this class if you want to create a plugin.

Methods
Members

Methods

GetStep_Cents (internal)
Parameters :
        Pitch (int)
Result (int)
GetStep_Freq (internal)
Parameters :
        Freq (int)
Result (integer)
ProcessAllParams (internal) Calls ProcessParam for all parameters
Parameters : none
Result : none
SkipRendering (internal)
Parameters :
        SourceBuffer (void *)
        DestBuffer (void *)
        Length (int)
Result : none
ShowHintMsg Let the host show a hint to the user
Parameters :
        Msg (char *) : The hint to show. Add "^a" (parameter can be linked to a midi controller) and "^b" (parameter is recordable) to the beginning of the hint to have FL Studio show little icons
Result : none
ShowHintMsg_Direct Show a hint to the user. Unlike ShowHintMsg, this function shows it without any delay. Useful for progress indicators.
Parameters :
        Msg (char *) : The hint to show. Add "^a" (parameter can be linked to a midi controller) and "^b" (parameter is recordable) to the beginning of the hint to have FL Studio show little icons
Result : none
ShowHintMsg_Percent Shows a hint for a value in percentage
Parameters :
        Value (int) : The value to be shown as a percentage
        Max (int) : The maximum for the value (the value is counted from 0..Max)
Result : none
ShowHintMsg_Pitch Show a hint for a value in terms of pitch
Parameters :
        Value (int) : The value to be shown in terms of pitch
        PitchType (int) : ?
Result : none
AdjustParamPopup
(VCL version)
Adds menu items that FL Studio tells it about to the specified menu item. Note that clicks for these menu items are handled by TCPPFruityPlug, so you don't need to worry about them.
Parameters :
        Item (TMenuItem *) : The menu item to set the state of
        ParamNum (int) : The index of the parameter
        ItemIndex (int) : The index of the menu item (see Parameter Popup Menu Item Indexes)
Result : none
AdjustParamPopup
(Windows API version)
Adds menu items that FL Studio tells it about to the specified menu item.
Parameters :
        Item (HMENU) : The menu item to set the state of
        ParamNum (int) : The index of the parameter
        ItemIndex (int) : The index of the menu item (see Parameter Popup Menu Item Indexes)
        FirstID (int) : The command id of the first menu item that this function adds. The next menu item's id will be FirstID+1 and so on. You'll need this to respond to a click from the user. See the VC++ examples to see how it's done.
Result : none
Lock Lock the critical section in order to change something that could be accessed by multiple threads
Parameters : none
Result : none
Unlock Unlock the critical section
Parameters : none
Result : none

Members

PlugHost (TFruityPlugHost *) This object is used by the plugin to talk to the host application
SmpRate (integer) The current sample rate
PitchMul (single)
ProgPath (FL 7.0) (char *) Will hold the path where FL Studio is installed