Compatibility with the Cubism 5 SDK R5 official version
Updated: 04/02/2026
Summary
This section describes the following points about compatibility with the Cubism 5 SDK R5 official version.
- What notes or changes are needed for compatibility with the existing SDK?
About the Names
- R5 beta SDK refers to the SDK prior to the Cubism 5 SDK R5 official version.
- R5 official SDK refers to the Cubism 5 SDK R5 official version or later.
Fixes affecting compatibility
- Reordering function for the calculation order of models and reordering
- Class structure change for multiply and screen colors and API name change
Reordering function for the calculation order of models and reordering
A function has been implemented in for Native and for Web to facilitate changing the order of model calculations.
With this modification, the function to update model parameters was transferred from Sample to Framework.
In transferring to Framework, a CubismLook class was created and the function for updating parameters via drag operations was modified to set and retrieve input values and target parameters to update parameters.
Specific modifications are explained in the section “Reordering function for the calculation order of models.”
In addition, the processing order in for Unity was different from that of the Original Workflow series SDKs for Native and for Web, so the calculation order has been changed to be the same as that of the Original Workflow series SDKs.
With this modification, the results of parameter updates involving physics operations differ from those in the R5 beta SDK.
Please see below for instructions on how to restore the calculation order when the results of updating parameters in the R5 beta SDK are desirable.
- Access CubismUnityComponents on GitHub.
- Check Assets/Live2D/Cubism/Framework/CubismUpdateExecutionOrder.cs in the Cubism 5 SDK for Unity R5 beta 3 or earlier.
- Replace each constant in the official R5 version of CubismUpdateExecutionOrder.cs.
Class structure change for multiply and screen colors and API name change
For for Native and for Web, functions related to multiply and screen color overwriting were transferred from the CubismModel class to the CubismModelMultiplyAndScreenColor class.
This modification improves readability.
API names that were not consistent among for Native, for Web, and for Unity have been unified.
Please refer to the table below for the API name changes for for Native and for Web.
(Note: API names related to MultiplyColor only)
| Classification | R5 beta SDK (before changes) | R5 official SDK (after changes) |
| Color | SetMultiplyColor() | SetDrawableMultiplyColor() |
| GetMultiplyColor() | SetDrawableMultiplyColor() | |
| SetPartMultiplyColor() | SetPartMultiplyColor() | |
| GetPartMultiplyColor() | GetPartMultiplyColor() | |
| SetMultiplyColorOffscreen() | SetOffscreenMultiplyColor() | |
| GetMultiplyColorOffscreen() | GetOffscreenMultiplyColor() | |
| Overwrite flag | SetOverrideFlagForModelMultiplyColors() | SetMultiplyColorEnabled() |
| GetOverrideFlagForModelMultiplyColors() | GetMultiplyColorEnabled() | |
| SetOverrideColorForPartMultiplyColors() | SetPartMultiplyColorEnabled() | |
| GetOverrideColorForPartMultiplyColors() | GetPartMultiplyColorEnabled() | |
| SetOverrideFlagForDrawableMultiplyColors() | SetDrawableMultiplyColorEnabled() | |
| GetOverrideFlagForDrawableMultiplyColors() | GetDrawableMultiplyColorEnabled() | |
| SetOverrideFlagForOffscreenMultiplyColors() | SetOffscreenMultiplyColorEnabled() | |
| GetOverrideFlagForOffscreenMultiplyColors() | GetOffscreenMultiplyColorEnabled() |
Please refer to the table below for the API name changes for for Unity.
| Classification | R5 beta SDK (before changes) | R5 official SDK (after changes) |
| Color | CubismRenderer.MultiplyColor | CubismRenderer.MultiplyColor |
| CubismPartColorsEditor.MultiplyColor | CubismPartColorsEditor.MultiplyColor | |
| Overwrite flag | CubismRenderController.OverrideFlagForModelMultiplyColors | CubismRenderController.MultiplyColorEnabled |
| CubismPartColorsEditor.OverrideColorForPartMultiplyColors | CubismPartColorsEditor.PartMultiplyColorEnabled | |
| CubismRenderer.OverrideFlagForDrawObjectMultiplyColors | CubismRenderer.DrawObjectMultiplyColorEnabled |
Specific modifications and details on how to call the overwrite process after the modification are explained in “[Native] Multiply color/Screen color,” “[Web] Multiply color/Screen color,” and “[Unity] Multiply color/Screen color.”