プラグインリファレンス

すべてのプラグインは astrofox.plugin.json マニフェストから始まります。

マニフェストのフィールド#

パスはマニフェストの URL を基準とした相対パスとして解決されます。公開するファイルには HTTPS を使用する必要があります。開発時は http://localhost も使用できます。

オーディオデータ#

プラグインが必要とするオーディオデータのみを宣言します。

"audio": {
  "fft": {
    "bins": 64,
    "minFrequency": 0,
    "maxFrequency": 6000,
    "smoothing": 0.5,
    "minDecibels": -100,
    "maxDecibels": -12
  },
  "td": {
    "samples": 256
  }
}

FFT の値は 0〜1 の範囲で渡されます。時間領域の値も 0〜1 の範囲で、無音は 0.5 を中心とします。ワーカーディスプレイは FFT データと時間領域データの両方を要求できます。シェーダーディスプレイが受け取るのは FFT と volume のみです。シェーダーエフェクトが受け取るのは volume、time、delta、inputTexture で、FFT や時間領域の配列は受け取りません。再生中と動画の書き出し中には同じ解析処理が使用されます。

コントロール#

対応しているコントロールの種類は、text、number、toggle、checkbox、color、colorrange、range、select、time です。

主なフィールドは次のとおりです。

マニフェストは JSON であるため、動的な値には参照を使用します。

{
  "width": {
    "label": "Width",
    "type": "number",
    "min": 16,
    "max": { "$stage": "width" },
    "withRange": true
  },
  "detail": {
    "label": "Detail",
    "type": "number",
    "min": { "$prop": "minimumDetail" },
    "max": 64
  },
  "manualSize": {
    "label": "Manual size",
    "type": "number",
    "hidden": { "$prop": "autoSize" }
  }
}

ステージの参照には scale を含めることができます。たとえば、{ "$stage": "width", "scale": -1 } はステージの幅を負にした値に解決されます。

uniform の対応付け#

シェーダーランタイムは、プロパティを GLSL の uniform に対応付けます。

"uniforms": {
  "amount": { "type": "float", "from": "amount" },
  "tint": { "type": "color", "from": "color" },
  "center": { "type": "vec2", "from": ["x", "y"] }
}

color は 16 進数の色を 3 成分のベクトルに変換します。ベクトルの対応付けでは、列挙したプロパティから各成分を読み取ります。

ワーカーファクトリーの入力#

マニフェストの内容に応じて、ワーカーファクトリーは次のものを受け取ります。

フレームデータ#

render(frame) は次のデータを受け取ります。

書き出し中、delta は 1000 / fps に固定されます。再現性のあるアニメーションにするには、time、delta、seed を使用してください。

レンダリング結果#

ワーカーの render() メソッドは次の値を返すことができます。

return {
  width,
  height,
  originX,
  originY,
};

幅と高さはレイヤーの境界を設定します。任意の origin 値は、トランスフォームの原点を設定します。