走査線エフェクトフィルター スプライトに走査線のエフェクトを表示するフィルターです – SAN_ShaderFilterScanLine.js

■概要
スプライトに走査線のエフェクトを表示するフィルターです。
このプラグインはシェーダーフィルターシステムのサブプラグインです。

■前提のコアプラグイン
このプラグインは前提のコアプラグインとして
併せて配布される「SAN_ShaderFilter.js」を使用します。
あらかじめ導入してください。

■シェーダーコードファイル
このプラグインはシェーダーコードファイルとして
「SAN_ScanLineFrag.txt」を使用します。
「glsl」フォルダにあらかじめ配置してください。

■基本的な仕組み
基本的な仕組みはコアプラグインのヘルプを参照してください。

■パラメータの作成
次のスクリプトコマンドでパラメーターを作成します。
例：
new GLSLScanLineFilterParam({
speed: 1.0, エフェクトスピード
fadeFrame: 60, フェードフレームカウント
fadeState: 'fadedOut' フェード状態
});

それぞれの項目は順不同かつ省略可能です。
また設定値ごと省略することもできます。
例：
new GLSLScanLineFilterParam();

・エフェクトスピード：speed
エフェクトのスピードです。
数値が0.0に近づくほど遅くなります。
マイナスの値も設定できます。
省略可能です。省略した場合は 1.0 が設定されます。

・フェードフレームカウント：fadeFrame
フェードイン、フェードアウトに要するフレーム数です。
省略可能です。省略した場合は 60 が設定されます。

・フェード状態：fadeState
フェードの状態を表します。
'fadingIn'（フェードイン中）、'fadedIn'（フェードイン完了）、
'fadingOut'（フェードアウト中）、'fadedOut'（フェードアウト完了）の
4つの状態を取り得ます。
'fadingIn' を設定した場合は即座にフェードインを開始します。
省略可能です。省略した場合は 'fadedOut' が設定されます。

■パラメーターの登録
次のスクリプトコマンドでパラメーターマップへパラメーターを登録します。
例：
$gamePlayer.glslFilterParamMap().set(
'playerScanLine', フィルターID
new GLSLScanLineFilterParam() フィルターパラメーター
);

その他のパラメーターマップの操作はコアプラグインのヘルプを参照してください。

■パラメーターの操作
・エフェクトのフェードイン：fadeIn()
例：
$gamePlayer.glslFilterParamMap().get(
'playerScanLine' フィルターID
).fadeIn();

・エフェクトのフェードアウト：fadeOut()
例：
$gamePlayer.glslFilterParamMap().get(
'playerScanLine' フィルターID
).fadeOut();

・エフェクトの即時表示：show()
例：
$gamePlayer.glslFilterParamMap().get(
'playerScanLine' フィルターID
).show();

・エフェクトの即時非表示：hide()
例：
$gamePlayer.glslFilterParamMap().get(
'playerScanLine' フィルターID
).hide();

■利用規約
MITライセンスのもと、商用利用、改変、再配布が可能です。
ただし冒頭のコメントは削除や改変をしないでください。
これを利用したことによるいかなる損害にも作者は責任を負いません。
サポートは期待しないでください＞＜。