Lua スクリプト for YMM4

YukkuriMovieMaker4 の映像エフェクト「Lua スクリプト」の公式ドキュメントです。 このエフェクトでは、Lua のコードで映像を毎フレーム加工できます。座標・回転・拡大率・不透明度の制御から、 ピクセル単位の画像処理、図形やテキストの生成、ほかのエフェクトの呼び出しまでを、1 つのスクリプト欄で行えます。

標準のスクリプトエンジンは LuaJIT で実行するネイティブレーンで、 決まった形のピクセル処理は CPU カーネルや GPU カーネルへ変換されます。 GPU カーネルは初回に CPU カーネルとの一致を検証したうえで自動選択します。 Lua 5.2 互換の MoonSharp はフォールバックとして使われます。 詳しくはエンジンと高速化を参照してください。

このドキュメントの構成

• 導入と使い方 … エフェクトの追加方法と、エディタ・パラメータパネルの使い方を説明します。
• Lua の基礎 … 変数・型・制御構文・関数・テーブルなど、Lua 言語そのものを学べます。
• obj オブジェクト … 座標・回転・拡大率・不透明度など、描画を制御する中心のテーブルです。
• anim ライブラリ … イージング・波・ノイズ・色変換など、アニメーション用の関数をまとめています。
• ピクセル操作 … 画像を 1 ピクセルずつ読み書きする方法と注意点を説明します。
• サンプル集 … そのまま貼り付けて使えるスクリプトを集めています。

最小の例

エフェクトを追加した直後に入っている既定のスクリプトは、フェードインです。

obj.alpha = math.min(time * 255, 255)

obj.alpha に値を代入すると不透明度が変わります。time はアイテム先頭からの経過秒数です。 スクリプトはフレームごとに実行され、obj の値を書き換えると描画へ反映されます。

できることの全体像