その他/設定可能なキー一覧/PluginFrameBuffer1 - uLilithフェイス作成方法wiki

PluginFrameBufferのキー（１）

Category = PluginFrameBufferのフィールドのキー一覧です。
（どのプラグインでも共通して設定されるキーの一覧）

• キー名が赤字と青字のキーは必須のキーです。
  （青字のキーは他のキーの設定状況などによっては省略することも可能です）
• キー名が緑字のキーは、作成するアイテムの種類によっては必須になるキーです。
  （該当するアイテム以外を作成する場合は省略してもかまいません）
• キー名の左の欄に*があるキーは、
  ModifyItemコマンドで後から設定を変更することができます。

カテゴリの設定

	キー名	値	内容
	Category	PluginFrameBuffer	カテゴリをPluginFrameBufferに指定

サブカテゴリの設定

☆このキーが必須かどうかは使用するプラグインによって異なります。

	キー名	値	内容
	SubCategory	【※】	サブカテゴリの設定

※使用するプラグインによって異なる

アイテムを表示するタイミング・アイテムの機能の設定

	キー名	値	内容	初期値
	Type	【※1】	１：uLilithの再生モードなどの状態に応じた     アイテムを表示するタイミング ２：アイテムの機能     （スライダアイテムかWindowResizerアイテム） のどちらか１つ
	ViewType	【※2】	ファイルの再生状態に応じた アイテムを表示するタイミング	AlwaysVisible
*	ActiveType	【※2】	uLilithのアクティブ状態に応じた アイテムを表示するタイミング	ActiveAndInactive

※1 SpectrumAnalyzer以外。Type一覧表（１）・Type一覧表（２）を参照。
※2 Type一覧表（１）を参照。

アイテムの表示サイズの指定

	キー名	値	内容	初期値
*	Width	数値	アイテムの表示サイズ（幅）
*	Height	数値	アイテムの表示サイズ（高さ）

アイテムの画像表示サイズの指定

☆スライダアイテムを作成する場合、
   これらのキーでつまみ部分の幅・高さを決めるのでこの２つのキーは必須になります。

	キー名	値	内容	初期値
*	FrameBufferWidth	数値	プラグインが実際に生成する画像の幅 スライダアイテムの場合はつまみ部分の幅	Widthの数値
*	FrameBufferHeight	数値	プラグインが実際に生成する画像の高さ スライダアイテムの場合はつまみ部分の高さ	Heightの数値

アイテムの表示位置指定

☆通常は『PosX・PosYキー両方とも』
   ウィンドウの特定位置（四隅・四辺の中央など）からの相対位置にする場合は
   『TopLeftAnchorキー』が、それぞれ必須キーになります。
   （PosX・PosYは省略してもエラーにはなりませんが
     TopLeftAnchorキーが未設定のときにPosX・PosYも省略すると
     PosX・PosYがどちらも0扱いとなり、アイテムがフェイス左上端に配置されてしまうので
     基本的にはPosX・PosYを省略せずに記述するようにしてください。
     なお、OriginItemキー設定時で
     基準アイテムと同じ位置に配置する場合は省略してもかまいません。）

	キー名	値	内容	初期値
*	PosX	数値	アイテムの左上端位置のX座標	0
*	PosY	数値	アイテムの左上端位置のY座標	0
	OriginItem	基準になるアイテムの フィールド名【※1】	アイテムの表示位置が キーの値に指定した フィールド名のアイテムの表示位置からの 相対位置になる【※2】
*	TopLeftAnchor	【※3】	アイテムの表示領域の左上座標を 指定した原点からの相対座標に固定する 【※4】	None
*	BottomRightAnchor	【※3】	アイテムの表示領域の右下座標を 指定した原点からの相対座標に固定し、 ウィンドウサイズの大きさに応じて 表示サイズを自動調整する【※5】	None
	Priority	数値	アイテムの表示の優先度	0

※1 iniファイル（定義ファイル）内で、
     このキーを記述するフィールドの前に記述されているフィールド名のみが対象。
     （このキーを記述するフィールドの後にあるフィールド名や
       iniファイル内に存在しないフィールド名はエラーになります。）
※2 OriginItemキーを記述した場合、
     アイテムの左上端位置のX座標は、
     「OriginItemで指定したアイテムのPosX＋このアイテムのPosX」に、
     Y座標は「OriginItemで指定したアイテムのPosY＋このアイテムのPosY」になります。
     PosX・PosYキーの数値にマイナスの数値を指定することで、
     OriginItemで指定したアイテムよりも上や左に配置することもできます。
     PosX・PosYキーの数値がどちらも0の場合（または、キーを省略した場合）は
     OriginItemで指定したアイテムと同じ位置に配置されます。
※3 〔原点〕, 〔相対X座標〕, 〔相対Y座標〕の３つを半角スペースとカンマで区切って指定します。
     原点はTopLeft（左上端）・TopCenter（上端中央）・TopRight（右上端）・
    CenterLeft（左端中央）・Center（中央）・CenterRight（右端中央）・
    BottomLeft（左下端）・BottomCenter（下端中央）・BottomRight（右下端）・
    None（自動補正を行わない）のうちどれか１つ。
     相対X座標と相対Y座標はピクセル単位だけでなく、
     ウィンドウの幅や高さに対する割合でも設定が可能です。
     割合で指定する場合は数値の後に半角で%を記述してください。
     （%表記の場合、10.0%というふうに小数表記も可能です）
※4 このキーはPosX・PosYキーの代わりに設定します。
     また、OriginItemキーの設定は無視されます。
※5 このキーはTopLeftAnchorキーとともに設定します。
     アイテムの表示サイズはウィンドウサイズに応じて自動的に調整されますが、
     初期サイズとしてのWidth・Heightキーは設定しておいてください。

マウスオーバー／クリックへの反応の設定

	キー名	値	内容	初期値
*	TipHint	文字列	マウスカーソルがアイテムの表示位置に 一定時間置かれたときに表示されるチップヒントの内容
*	Enable	TrueかFalse	True：クリックに反応するようになる           Commandキーが設定されている            アイテムの場合、            クリック時にそのコマンドが実行される	False

アイテムの初期表示状態の設定

	キー名	値	内容	初期値
*	IsHided	TrueかFalse	True：初期状態でアイテムを非表示にする【※】	False

※HideItemコマンドで非表示にしたのと同じ状態です。
   後からShowItem・SwitchShowItemコマンドで表示させることはできます。

アイテムの透明度・表示範囲の設定

	キー名	値	内容	初期値
*	ConstAlpha	数値（整数） （0～255か-1）	アイテムの定数α(不透明度)を指定【※】	-1

※「0」で完全透明、「255」で不透明になります。
   ただし、不透明扱いにするのならキーを省略（-1に設定）するほうが高速に描画されるので
   透明度を調整する必要が無い場合は、キーを省略してください。

アイテムの表示エリアの差分描画の設定

	キー名	値	内容	初期値
	DisablePartialUpdate	TrueかFalse	True：差分描画が行われなくなる	False

コマンドの設定

☆Typeキーの設定でスライダアイテム・WindowResizerアイテムにした場合は
   コマンドの設定は無効になります。

	キー名	値	内容	初期値
*	Command	コマンド名	クリック時に実行するコマンド名
*	CommandParamType	【※1】	コマンドのパラメータの種類 （パラメータが必要なコマンドのみ）
*	CommandParam	【※2】	コマンドのパラメータの内容 （パラメータが必要なコマンドのみ）
	CommandTargetWindow	ウィンドウ名【※3】	コマンドを実行する対象のウィンドウ （別のウィンドウに対して実行する場合のみ。 省略した場合は Commandキーを記述したウィンドウ自身が 対象になる）
	CommandTargetPlugin	プラグイン名	コマンドを実行する対象のプラグイン名 （プラグインに対して実行する場合のみ）
*	CommandCount	数値	実行するコマンドの数 （複数のコマンドを設定する場合のみ【※4】）
	UseAsyncCommand	TrueかFalse	True：コマンドを非同期実行するようにする	False

※1 Int・String・Double・Bool・RandomInt・RandomString のうちどれか１つ
     （コマンドによって使用できる種類が異なる）
※2 文字列や数値など、コマンドによって異なる
※3 CreateSubFace・ToggleSubFaceコマンドで開くときにパラメータで指定した「ウィンドウ名」。
     サブウィンドウに記述したコマンドで、メインウィンドウを対象とする場合は
     「uLilith::MainWindow」と指定する。
※4 １つのアイテムに複数のコマンドを設定する場合、
     CommandCountキーを設定した上で
     Command・CommandParamType・CommandParam・
     CommandTargetWindow・CommandTargetPluginの全てのキーの末尾に
     （スペースは入れずに）連番をつける必要があります。
     例：「Command2」「CommandParamType2」など
     コマンドはキー末尾につけた連番の番号の順に実行されます。