Class: Effect

Effect()

エフェクトを操作するためのオブジェクト

Constructor

new Effect()

Source:
Example
function start(){
  let effect = scene.effect.model //モデルエフェクトを操作
  if(effect.shaderIds.length == 0){
    let layer = effect.add("Aberration") //特殊効果を追加
    console.log(layer.parameterIds) //操作できるエフェクトパラメータ
  }
}
function update(){
  let effect = scene.effect.model
  let sin = Math.sin(Date.now()/1000)
  effect.brightness = sin //明るさを変更
  effect.layer("Aberration")?.setParameter("radian",sin) //特殊効果のパラメータを変更 
}

Members

availableShaderIds :Array.<string>

このインスタンスの示すターゲットに追加可能な特殊効果（シェーダー）のID一覧
Type:
  • Array.<string>
Since:
  • nizima LIVE 2.3.0
Source:

background :Effect

背景のエフェクト。ルートのエフェクトからのみ呼び出し可能
Type:
Source:

blendColor :Color

色調補正 / カラー
Type:
Source:

blendMode :string

色調補正 / ブレンドモード 注意：各モードの名前は2.0時点 "Mix"|"Multiply"|"BurninColor"|"BurninLinear"|"Screen"|"Add"|"Overlay"|"SoftLight"|"Colorize"
Type:
  • string
Source:

brightness :number

色調補正 / 明るさ -1~1
Type:
  • number
Source:

colorCollectionEnabled :boolean

色調補正の有効状態 関連する値を編集すると自動で有効になる
Type:
  • boolean
Source:

contrast :number

色調補正 / コントラスト -1~1
Type:
  • number
Source:

model :Effect

モデルのエフェクト。ルートのエフェクトからのみ呼び出し可能
Type:
Source:

saturation :number

色調補正 / 彩度 0~2
Type:
  • number
Source:

shaderEffectEnabled :boolean

特殊効果の有効状態
Type:
  • boolean
Source:

shaderIds

現在の特殊効果
Source:

Methods

add(shaderId) → {EffectLayer}

特殊効果を追加する ID は availableShaderIds を参照
Parameters:
Name Type Description
shaderId string
Source:
Returns:
追加された特殊効果
Type
EffectLayer

layer(index) → {EffectLayer}

レイヤーを取得する
Parameters:
Name Type Description
index number
Source:
Returns:
Type
EffectLayer

layer(shaderId) → {EffectLayer}

IDからレイヤーを取得する。複数ある場合は先に見つかった方のみ返す
Parameters:
Name Type Description
shaderId string
Source:
Returns:
Type
EffectLayer

remove(index)

特殊効果を削除する
Parameters:
Name Type Description
index number
Source: