Entry Point — After Effects SDK Guide 22.0.0 documentation
After Effectsとエフェクトプラグイン間の通信はすべてAfter Effectsから開始され、ホスト(After Effects)が1つのエントリポイント関数を呼び出すことで行われます。
すべてのエフェクトプラグインにおいて、エントリポイント関数は以下のシグネチャを持つ必要があります。
PF_Err main (
PF_Cmd cmd,
PF_InData *in_data,
PF_OutData *out_data,
PF_ParamDef *params[],
PF_LayerDef *output,
void *extra)
上記のエントリポイント関数の名前は "main" ですが、PiPL Resources で指定されたものであれば何でも構いません。
エントリーポイント関数を呼び出す前に、After EffectsはPF_InDataとプラグインのパラメータ配列PF_ParamDef[]を更新します(特記事項以外)。
プラグインがその呼び出しから戻った後,After Effects は PF_OutData に変更がないかチェックし,適切な場合には,エフェクトがレンダリングしたPF_LayerDefを使用する。
cmd | After Effectsのコマンドセレクタを設定し、プラグインに何をすべきかを指示します。 |
---|---|
in_data | アプリケーションの状態や、プラグインに指示するデータに関する情報。多数のインターフェースと画像操作関数へのポインタも提供される。 |
out_data | out_data内のフィールドを設定することにより、After Effectsに情報を渡す。 |
params | in_data> current_time で指定された時刻におけるプラグインのパラメータの配列。 |
params[0] は、効果を適用する入力画像(PF_EffectWorld / PF_LayerDef)です。 |
|
これらの値は、特定のセレクタの間のみ有効です(これはセレクタの説明に記載されています)。 | |
パラメータについては、こちらで詳しく説明しています。PF_ParamDef. | |
output | エフェクトプラグインによってレンダリングされ、After Effects に戻される出力画像。特定のセレクタの間のみ有効です。 |
extra | extra パラメータは、送信されたコマンドまたは (PF_Cmd_EVENT の場合) イベントタイプによって変化します。主にイベント管理、パラメータ監視に使用します。 |