Cubism 5 SDK R5 正式版の互換性について
最終更新： 2026年4月2日
概要
ここでは、Cubism 5 SDK R5 正式版の互換性について以下の内容の説明をします。
- 既存のSDKとの互換性についてどのような注意点や変更点があるか。
名称について
- R5 ベータ版 SDKは、Cubism 5 SDK R5 正式版より前のSDKを指します。
- R5 正式版 SDKは、Cubism 5 SDK R5 正式版以降のSDKを指します。
互換性に影響のある修正
- モデルの計算順序の並び替え機能及び順序変更
- 乗算色・スクリーン色のクラス構造変更及びAPI名変更
モデルの計算順序の並び替え機能及び順序変更
for Native 及び for Web にて、モデルの計算順序を変更しやすくする機能を実装しました。
この修正により、モデルのパラメータ更新に関わる機能をSampleからFrameworkに移管しました。
Drag操作によるパラメータ更新機能についてはFrameworkに移管するにあたり、CubismLookクラスを作成し、入力値及び対象パラメータを設定や取得、パラメータを更新できるように変更しました。
具体的な修正内容「モデルの計算順序の並び替え機能」で説明しています。
またfor Unity にて、for Native や for Web のOriginal Workflow系SDKと処理順序が異なっていたため計算順序をOriginal Workflow系SDKと同様になるよう変更しました。
この修正により、物理演算が関わるパラメータ更新結果がR5 ベータ版 SDKと異なります。
R5 ベータ版 SDK のパラメータ更新結果が望ましい場合の修正方法は以下をご確認ください。
- GitHubの CubismUnityComponents にアクセスする。
- Cubism 5 SDK for Unity R5 beta3以前の Assets/Live2D/Cubism/Framework/CubismUpdateExecutionOrder.cs を確認する。
- R5正式版 CubismUpdateExecutionOrder.cs の各定数を置き換える。
乗算色・スクリーン色のクラス構造変更及びAPI名変更
for Native 及び for Web にて、CubismModel クラスから乗算色・スクリーン色の上書きに関する機能を CubismModelMultiplyAndScreenColor クラスに移管しました。
この修正により可読性が向上しました。
また for Native 及び for Web、 for Unity にて統一性のなかったAPI名を変更しました。
for Native 及び for WebのAPI名の変更については以下の表をご参照ください。
（※MultiplyColor関連のAPI名のみ）
| 区分 | R5 ベータ版 SDK（変更前） | R5 正式版 SDK（変更後） |
| 色 | SetMultiplyColor() | SetDrawableMultiplyColor() |
| GetMultiplyColor() | SetDrawableMultiplyColor() | |
| SetPartMultiplyColor() | SetPartMultiplyColor() | |
| GetPartMultiplyColor() | GetPartMultiplyColor() | |
| SetMultiplyColorOffscreen() | SetOffscreenMultiplyColor() | |
| GetMultiplyColorOffscreen() | GetOffscreenMultiplyColor() | |
| 上書きフラグ | SetOverrideFlagForModelMultiplyColors() | SetMultiplyColorEnabled() |
| GetOverrideFlagForModelMultiplyColors() | GetMultiplyColorEnabled() | |
| SetOverrideColorForPartMultiplyColors() | SetPartMultiplyColorEnabled() | |
| GetOverrideColorForPartMultiplyColors() | GetPartMultiplyColorEnabled() | |
| SetOverrideFlagForDrawableMultiplyColors() | SetDrawableMultiplyColorEnabled() | |
| GetOverrideFlagForDrawableMultiplyColors() | GetDrawableMultiplyColorEnabled() | |
| SetOverrideFlagForOffscreenMultiplyColors() | SetOffscreenMultiplyColorEnabled() | |
| GetOverrideFlagForOffscreenMultiplyColors() | GetOffscreenMultiplyColorEnabled() |
for Unity のAPI名の変更については以下の表をご参照ください。
| 区分 | R5 ベータ版 SDK（変更前） | R5 正式版 SDK（変更後） |
| 色 | CubismRenderer.MultiplyColor | CubismRenderer.MultiplyColor |
| CubismPartColorsEditor.MultiplyColor | CubismPartColorsEditor.MultiplyColor | |
| 上書きフラグ | CubismRenderController.OverrideFlagForModelMultiplyColors | CubismRenderController.MultiplyColorEnabled |
| CubismPartColorsEditor.OverrideColorForPartMultiplyColors | CubismPartColorsEditor.PartMultiplyColorEnabled | |
| CubismRenderer.OverrideFlagForDrawObjectMultiplyColors | CubismRenderer.DrawObjectMultiplyColorEnabled |
具体的な修正内容と修正後の上書き処理の呼び出し方法は「【Native】乗算色・スクリーン色」「【Web】乗算色・スクリーン色」「【Unity】乗算色・スクリーン色」で説明しています。