obj の関数

obj には値だけでなく関数も用意されています。他アイテムの参照、ピクセル操作、 図形やテキストの生成、他エフェクトの適用などができます。座標などの値メンバーは obj オブジェクト を参照してください。

obj.getobject — 他アイテムの参照

obj.getobject(tag [, frame]) は、対象アイテムの「備考」欄に入力した文字列を tag として、 そのアイテムの描画情報を取得します。備考欄はプロパティエリアの上側にあります。 第 2 引数 frame を指定すると、そのタイムラインフレーム時点の値を取得します（省略時は現在フレーム）。 一致するアイテムが無い場合は nil を返します。

返り値は対象アイテム自身の座標・回転・拡大率であり、グループ制御・カメラ制御による変形は含みません。 同じタグのアイテムが複数あるときは、対象フレームで表示中のものが優先されます。 音声アイテム（合成音声等）も対象になり、座標・拡大率・回転・不透明度は字幕の表示情報を返します。

キャラクター名で演出を分ける

local v = obj.getobject("voice")
if v and v.character == "魔理沙" then
    obj.effect("単色化", "強さ", 100, "color", 0xffee55)
end

発射元の座標に合わせる

local src = obj.getobject("routersys")
if src then
    obj.x = src.x
    obj.y = src.y
end

発射元へ向かって移動する

local target = obj.getobject("routersys")
if target then
    local p = anim.ease_in_out(obj.t)
    obj.x = anim.lerp(obj.x, target.x, p)
    obj.y = anim.lerp(obj.y, target.y, p)
end

表示中のときだけ追従する

local target = obj.getobject("routersys")
if target and target.exist then
    obj.x = target.x
    obj.y = target.y
end

発射時の座標に固定する

弾の発射フレーム（弾アイテムの開始フレーム）は timelineframe - frame で求まります。 そのフレーム時点の発射元座標を取得すれば、発射元が動いても原点は発射位置に固定されます。

local fire = timelineframe - frame
local src = obj.getobject("routersys", fire)
if src then
    obj.x = src.x
    obj.y = src.y
end

ピクセル操作

obj.getpixel / obj.setpixel / obj.getpixeldata は画像を直接読み書きします。 座標・チャンネル・アルファの扱いといった詳細は ピクセル操作 を参照してください。 ここでは関数の概要だけ示します。

obj.rand — 整数の安定した乱数

obj.rand(a, b [, seed [, frame]]) は a ～ b の範囲の整数を返します （端点を含みます）。同じ seed と frame の組では常に同じ値になります。 seed の既定値は 0、frame の既定値は現在フレームです。

obj.load — 図形・テキスト・画像・動画・シーン・模様の読み込み

obj.load(種類, ...) は、対象の画像バッファを生成した内容で置き換えます。 読み込み後は obj.w / obj.h などの寸法も更新されます。

obj.brush — 模様のパラメータ指定付き描画

obj.brush(模様名 [, 幅, 高さ] [, パラメータ名, 値, ...]) は、YMM4 の模様（ブラシ）を パラメータ指定付きで描画してオブジェクトの画像を置き換えます。描画は obj.load("brush", ...) と同じで、 加えて obj.effect と同じ「名前と値の組」で模様のパラメータを変更できます。 AviUtl に存在しない YMM4 向けの独自拡張です。

obj.brush("縞模様", "Angle", 45, "Color1", 0xff3366)

obj.load("figure", ...) で指定できる図形名は次のとおりです。

obj.load("figure", "star", 0xFFCC00, 200, 0, 0)

obj.setfont — フォント設定

obj.setfont(name [, size [, type [, color]]]) は、続く obj.load("text", ...) で使う フォントを設定します。type はビットフラグで、ビット 0 が太字、ビット 1 が斜体です （太字+斜体は 3）。既定の大きさは 34、既定色は 0xFFFFFF です。

obj.setfont("Yu Gothic UI", 48, 1, 0xFFFFFF)
obj.load("text", "サンプル")

AviUtl 互換の描画・効果関数（上級）

次の関数は AviUtl のスクリプト制御に近い使い勝手で用意されています。 obj.effect は AviUtl／AviUtl2 のエフェクト名とパラメータ名で、対応する YMM4 の映像エフェクトを適用します。

合成モード

obj.setoption("blend", 番号) は obj.draw／obj.drawpoly の描画に合成モードを設定します。 番号は YMM4 のプロパティパネルにある「合成モード」のドロップダウンと並び順が同じで、0 から始まります。 範囲外の値や数値以外を指定したときは通常モードになります。

obj.setoption("blend", 3)
obj.draw()

描画先

obj.setoption("drawtarget", 先) は obj.draw／obj.drawpoly の描画先を切り替えます。 "framebuffer"（既定）ではフレームバッファへ合成します。 "tempbuffer" では作業用の tmp バッファへその場で合成します。 obj.setoption("drawtarget", "tempbuffer", w, h) の w, h は tmp バッファを初期化するサイズで、省略すると初期化しません。 tmp へ描いた結果は obj.copybuffer("obj", "tmp") で作業画像へ戻せます。

tempbuffer への合成は通常（ソースオーバー）で、blend は framebuffer への描画に適用されます。 描画先の切り替えは両エンジンで動きます。 MoonSharp では tempbuffer への合成を GPU で実行し、GPU を利用できない環境では CPU の合成へ自動的に切り替わります。 丸めの違いにより、合成の結果はエンジン間でごく僅かに異なることがあります。

obj.setoption("drawtarget", "tempbuffer", obj.w, obj.h)
obj.draw()
obj.setoption("drawtarget", "framebuffer")
obj.copybuffer("obj", "tmp")

ピクセルシェーダー

obj.pixelshader は、スクリプト内に AviUtl ExEdit2 と同じ記法で定義した HLSL のピクセルシェーダーを GPU で実行します。 シェーダーは --[[pixelshader@登録名: で始まる複数行コメントに記述し、登録名がエントリーポイントになります。

--[[pixelshader@ps:
Texture2D src : register(t0);
cbuffer constant0 : register(b0) { float strength; }
float4 ps(float4 pos : SV_Position) : SV_Target
{
    float4 c = src[uint2(floor(pos.xy))];
    return float4(c.rgb * strength, c.a);
}
]]
obj.pixelshader("ps", "object", "object", { obj.track0 / 100 })

ピクセルシェーダーの入力は次のどちらかのシグネチャを使用できます。 uv は描画範囲が 0.0～1.0 になるように設定されます。

float4 名前(float4 pos : SV_Position) : SV_Target
float4 名前(float4 pos : SV_Position, float2 uv : TEXCOORD) : SV_Target

obj.pixelshader は両エンジンで動作し、シェーダーの実行自体はどちらのエンジンでもホスト側の GPU で行われます。 YMM4 は背景を参照できないため、"framebuffer" の初期内容は透明なシーンサイズ領域へオブジェクトを合成した仮想の画像です。 HLSL のコンパイルエラーはエディターの診断へ表示されます。 GPU を利用できない環境では呼び出しはスキップされ、画像は変化しません。

画像加工（YMM4 独自拡張）

obj.fill・obj.getpixelregion・obj.putpixelregion・obj.convolve・obj.resize は、作業画像を直接加工する YMM4 独自の関数です。 色は obj.getpixel／obj.setpixel と同じ 0〜255 のストレート RGBA で扱い、いずれも従来エンジンと高速ランタイムの両方で動作します。

obj.getpixelregion(x, y, w, h) は矩形領域の画素を長さ w*h*4 の配列で返します。並びは画素ごとに r, g, b, a で、索引は (行*w+列)*4+1 から始まります。範囲外の画素は 0,0,0,0 です。 obj.putpixelregion は同じ並びの配列を書き戻し、画像の範囲外へはみ出した画素は書き込みません。

-- 左右反転
local w, h = obj.w, obj.h
local src = obj.getpixelregion(0, 0, w, h)
local dst = {}
for y = 0, h - 1 do
  for x = 0, w - 1 do
    local s = (y * w + (w - 1 - x)) * 4
    local d = (y * w + x) * 4
    for c = 1, 4 do dst[d + c] = src[s + c] end
  end
end
obj.putpixelregion(0, 0, w, h, dst)

obj.convolve(kernel, size [, divisor, offset]) は size×size の畳み込みを適用します。kernel は行優先で 1 始まりの係数配列、size は奇数です。divisor を省略するとカーネルの合計（合計が 0 のときは 1）で割ります。offset は除算後に各成分へ加算します。端の画素は最も近い画素で補い、r, g, b, a すべてに適用されます。

obj.convolve({ 1,1,1, 1,1,1, 1,1,1 }, 3)          -- 平均ぼかし
obj.convolve({ 0,-1,0, -1,5,-1, 0,-1,0 }, 3)      -- シャープ
obj.convolve({ -1,-1,-1, -1,8,-1, -1,-1,-1 }, 3, 1, 0)  -- 輪郭抽出

obj.resize(w, h [, filter]) は作業画像を指定サイズへ拡大縮小し、obj.w・obj.h・obj.cx などの寸法も更新します。filter は "nearest"（最近傍）か、省略で線形補間です。高速ランタイムでは結果が最大画像サイズを超える場合は変更しません。

obj.fill・obj.convolve・obj.resize は、処理量がしきい値以上で GPU の結果が CPU と一致すると確認できたとき、自動で GPU へ委譲します。呼び出しの直前（単独行でも同一行でも可）に [fast] を置くと、このしきい値を無視して強制的に GPU へ委譲します。GPU が使えない環境や GPU の結果が CPU と一致しない環境では、[fast] を付けても CPU へ自動的に戻ります。処理量が小さいときは、GPU への委譲自体の往復コストが CPU 実行を上回ることがあり、[fast] を付けるとかえって遅くなる場合があります。詳細は 拡張構文 を参照してください。

アンカーポイント

obj.setanchor(name, count [, option, ...]) は、プレビュー上にドラッグ可能なアンカーポイントを表示します。 ドラッグで調整した座標はプロジェクトへ保存され、name で指定した Lua 変数へ格納されます。 変数は pos={x0,y0,x1,y1,…} の並びで、"xyz" を指定すると {x0,y0,z0,x1,y1,z1,…} になります。 座標はオブジェクトの中心が原点です。個数は最大 32 個です。

戻り値は設置したアンカーポイントの数です。両エンジンで動きます。 name に "track" を指定した場合も対応し、個数 0 は 1 個として設置します。選択中のアンカーは「アンカー」グループの X / Y / Z スライダーで数値調整できます。

num = obj.track0
obj.setanchor("pos", num, "loop")
for i = 0, num - 1 do
  obj.draw(pos[i * 2 + 1], pos[i * 2 + 2])
end

音声データ

obj.getaudio(buf, file [, type, size]) は音声データを取得します。 buf に渡したテーブルの buf[1]～buf[n] へデータを格納し、取得したデータ数とサンプリングレートを返します。 buf に nil を渡すと、テーブルを 3 番目の戻り値として返します。 file には音声ファイルのパスを指定します。"audiobuffer" を指定すると、編集中のシーン全体の音声（タイムライン上の全アイテムを合成した音声）を取得します。 YMM4 独自の拡張として "itembuffer" も指定でき、このエフェクトを付けたアイテム自身の音声（音量・パン・フェード・音声エフェクト適用後）を取得します。

読み取り位置は、"audiobuffer" はタイムラインの現在の再生位置、それ以外はオブジェクトの現在の再生位置（obj.time）です。 "pcm" は現在位置から連続したサンプルを返し、"spectrum"／"fourier" は現在位置からの区間を解析して返します。 1 回で取得できるデータ数は最大 1024 個で、取得できた数が指定より少ないことがあります。 取得できない場合はデータ数 0 を返し、エラーにはなりません。両エンジンで動きます。 "itembuffer" は音声を持たないアイテム（画像や図形等）ではデータ数 0 になります。

local buf = {}
local n = obj.getaudio(buf, "audiobuffer", "spectrum", 32)
for i = 1, n do
  obj.draw((i - n / 2) * 8, -buf[i] / 200)
end

環境情報

obj.getinfo(name) は、name で指定した環境情報を返します。対応していない名前を指定したときは nil を返します。 "image_max" は幅と高さの2値を返し、"bpm" はテンポと拍子と基準時間の3値を返します。両エンジンで動きます。

if obj.getinfo("saving") == false then
  obj.drawpoly(-100,-100,0, 100,-100,0, 100,100,0, -100,100,0)
end

互換マップ

obj.effect は二段階で解決します。 まず互換マップを参照し、AviUtl／AviUtl2 の名前として宣言したエフェクトは、 パラメータ名の対応と値の変換を経て YMM4 のプロパティへ反映します。 互換マップに宣言が無い名前は、YMM4 のエフェクト名やキーワードでそのまま解決します。 たとえば ウェーブクリッピング のように、YMM4 やコミュニティのエフェクトを 名前で呼ぶ使い方もそのまま動きます。

互換マップでは、パラメータの値を AviUtl と同じ尺度で渡すと、 マップに定義した倍率とオフセットの変換を経て、YMM4 のプロパティへ反映します。 たとえば ぼかし の 範囲 は YMM4 の Blur へ 0.5 倍で対応し、 AviUtl と同じ見た目になります。 この互換マップは、YMM4 自身が AviUtl の .exo へ書き出す変換を逆向きにたどって作っているため、 往復しても結果が一致します。

対象のエンジンは指定子 --!aviutl または --!aviutl2 で切り替えます。 指定子を書かないときは --!aviutl として扱います。 各エントリは対応するエンジンを AviUtl・AviUtl2・両方のいずれかとして保持し、 対象に一致するエントリだけを解決します。

--!aviutl
obj.effect("ぼかし", "範囲", 20)
obj.effect("方向ブラー", "範囲", 16, "角度", 45)

現在マップが宣言している AviUtl のエフェクト名は次のとおりです。