Merge pull request #67 from Live2D/develop

Update to Cubism 5 SDK for Native R5

Author: itoh-at-live2d-com

CHANGELOG.md

@@ -5,6 +5,66 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 
+## [5-r.5] - 2026-04-02
+
+### Added
+
+* Add the `SetRenderViewport` method to `CubismRenderer_Metal` to set the viewport when drawing the model.
+* Add functionality to change motion calculation order.
+* Add `cubismlook` class that implements the target tracking feature.
+  * The target tracking feature can now specify parameter IDs through the `Framework`.
+
+### Changed
+
+* Change Vulkan renderer to use `CubismDeviceInfo_Vulkan` instead of singletons for pipeline and offscreen manager.
+  * Rename `InitializeConstantSettings` to `SetConstantSettings` in Vulkan renderer.
+* Change the access level of the private members in the `CubismMoc` and `CubismModel` classes to protected.
+* Change multiply and screen color functions to separate class with renamed methods.
+* Change shader generation from draw loop to Initialize() in OpenGL, D3D9, D3D11 and Metal.
+* Change to unify sampler settings across all graphics APIs, except for OpenGL ES on Android and iOS.
+
+### Fixed
+
+* Fix a validation error on Vulkan.
+* Fix unnecessary multiply color and screen color settings in mask drawing.
+* Fix a memory leak in `CubismRenderer_D3D11::ReleaseCommandBuffer()` where `_indexBuffers` and `_vertexBuffers` were not freed due to a copy-paste bug.
+* Fix a memory leak in `CubismRenderer_Vulkan::CreatePipelines()` where `PipelineResource` objects allocated for Add/Mult blend modes were overwritten and leaked.
+* Fix missing null checks after loading shader source files in OpenGL, D3D9 and D3D11 renderers.
+* Fix a resource leak in `CubismShader_D3D11::GenerateShaders()` where Copy and SetupMask shaders were loaded twice, causing the first set of COM objects to leak.
+* Fix redundant matrix transpose in D3D11 renderer.
+* Improve the viewport save and restore process on OpenGL.
+
+### Removed
+
+* Remove unnecessary shader processing in D3D11 and D3D9.
+* Remove deprecated functions from CubismModel:
+ * `GetDrawableTextureIndices(csmInt32 drawableIndex)` (use `GetDrawableTextureIndex(csmInt32 drawableIndex)` instead)
+ * `GetDrawableBlendMode(csmInt32 drawableIndex)` (use `GetDrawableBlendModeType(csmInt32 drawableIndex)` instead)
+ * `SetOverwriteFlagForModelCullings(csmBool value)` (use `SetOverrideFlagForModelCullings(csmBool value)` instead)
+ * `GetOverwriteFlagForModelCullings()` (use `GetOverwriteFlagForModelCullings()` instead)
+ * `SetOverwriteFlagForDrawableCullings(csmUint32 drawableIndex, csmBool value)` (use `SetOverrideFlagForDrawableCullings(csmUint32 drawableIndex, csmBool value)` instead)
+ * `GetOverwriteFlagForDrawableCullings(csmInt32 drawableIndex)` (use `GetOverrideFlagForDrawableCullings(csmInt32 drawableIndex)` instead)
+* Remove deprecated functions from CubismExpressionMotion:
+ * `GetFadeWeight()` (use `CubismExpressionMotionManager.GetFadeWeight(csmInt32 index)` instead)
+* Remove deprecated fields from CubismExpressionMotion:
+ * `_fadeWeight` (priority is not used in expression motion playback)
+* Remove deprecated functions from CubismExpressionMotionManager:
+ * `GetCurrentPriority()` (priority is not used in expression motion playback)
+ * `SetReservePriority(csmInt32 priority)` (priority is not used in expression motion playback)
+ * `GetReservePriority()` (priority is not used in expression motion playback)
+ * `StartMotionPriority(ACubismMotion* motion, csmBool autoDelete, csmInt32 priority)` (use `CubismMotionQueueManager::StartMotion(ACubismMotion* motion, csmBool autoDelete)` instead)
+* Remove deprecated fields from CubismExpressionMotionManager:
+ * `_currentPriority` (priority is not used in expression motion playback)
+ * `_reservePriority` (priority is not used in expression motion playback)
+* Remove deprecated functions from CubismMotion:
+ * `IsLoop(csmBool loop)` (use `ACubismMotion.SetLoop(csmBool loop)` instead)
+ * `IsLoop()` (use `ACubismMotion.GetLoop()` instead)
+ * `IsLoopFadeIn(csmBool loopFadeIn)` (use `ACubismMotion.SetLoopFadeIn(csmBool loopFadeIn)` instead)
+ * `IsLoopFadeIn()` (use `ACubismMotion.GetLoopFadeIn()` instead)
+* Remove deprecated functions from CubismMotionQueueManager:
+ * `StartMotion(ACubismMotion* motion, csmBool autoDelete, csmFloat32 userTimeSeconds)` (use `StartMotion(ACubismMotion* motion, csmBool autoDelete)` instead)
+
+
 ## [5-r.5-beta.3.1] - 2026-02-19
 
 ### Added
@@ -546,6 +606,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix invalid expressions of `CubismCdiJson`.
 
 
+[5-r.5]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.5-beta.3.1...5-r.5
 [5-r.5-beta.3.1]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.5-beta.3...5-r.5-beta.3.1
 [5-r.5-beta.3]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.5-beta.2...5-r.5-beta.3
 [5-r.5-beta.2]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.5-beta.1...5-r.5-beta.2

src/Effect/CMakeLists.txt

@@ -4,6 +4,8 @@ target_sources(${LIB_NAME}
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismBreath.hpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismEyeBlink.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismEyeBlink.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/CubismLook.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/CubismLook.hpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismPose.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismPose.hpp
 )

src/Effect/CubismLook.cpp

@@ -0,0 +1,44 @@
+/**
+ * Copyright(c) Live2D Inc. All rights reserved.
+ *
+ * Use of this source code is governed by the Live2D Open Software license
+ * that can be found at https://www.live2d.com/eula/live2d-open-software-license-agreement_en.html.
+ */
+
+#include "CubismLook.hpp"
+
+namespace Live2D { namespace Cubism { namespace Framework {
+
+CubismLook* CubismLook::Create()
+{
+    return CSM_NEW CubismLook();
+}
+
+void CubismLook::Delete(CubismLook* instance)
+{
+    CSM_DELETE_SELF(CubismLook, instance);
+}
+
+void CubismLook::SetParameters(const csmVector<LookParameterData>& lookParameters)
+{
+    _lookParameters = lookParameters;
+}
+
+const csmVector<CubismLook::LookParameterData>& CubismLook::GetParameters() const
+{
+    return _lookParameters;
+}
+
+void CubismLook::UpdateParameters(CubismModel* model, const csmFloat32 dragX, const csmFloat32 dragY) const
+{
+    const csmFloat32 dragXY = dragX * dragY;
+
+    for (csmUint32 i = 0; i < _lookParameters.GetSize(); ++i)
+    {
+        const LookParameterData& data = _lookParameters[i];
+
+        model->AddParameterValue(data.ParameterId, data.FactorX * dragX + data.FactorY * dragY + data.FactorXY * dragXY);
+    }
+}
+
+}}}

src/Effect/CubismLook.hpp

@@ -0,0 +1,108 @@
+/**
+ * Copyright(c) Live2D Inc. All rights reserved.
+ *
+ * Use of this source code is governed by the Live2D Open Software license
+ * that can be found at https://www.live2d.com/eula/live2d-open-software-license-agreement_en.html.
+ */
+
+#pragma once
+
+#include <climits>
+#include "CubismFramework.hpp"
+#include "Model/CubismModel.hpp"
+
+namespace Live2D { namespace Cubism { namespace Framework {
+
+/**
+ * Parameter Following Feature by Target.<br>
+ * Provides parameter following functionality for drag input.
+ */
+class CubismLook
+{
+public:
+    /**
+     * Data attached to the parameters of look.
+     */
+    struct LookParameterData
+    {
+        /**
+         * Constructor
+         */
+        LookParameterData()
+            : ParameterId(nullptr)
+            , FactorX(0.0f)
+            , FactorY(0.0f)
+            , FactorXY(0.0f)
+        {
+        }
+
+        /**
+         * Constructor<br>
+         * Sets the data.
+         *
+         * @param parameterId ID of the breath parameter to attach.
+         * @param factorX Coefficient for drag input along the X-axis.
+         * @param factorY Coefficient for drag input along the Y-axis.
+         * @param factorXY Coefficient for the combined X-Y (cross) drag input.
+         */
+        LookParameterData(CubismIdHandle parameterId, const csmFloat32 factorX = 0.0f, const csmFloat32 factorY = 0.0f, const csmFloat32 factorXY = 0.0f)
+            : ParameterId(parameterId)
+            , FactorX(factorX)
+            , FactorY(factorY)
+            , FactorXY(factorXY)
+        {
+        }
+
+        CubismIdHandle ParameterId;
+        csmFloat32 FactorX;
+        csmFloat32 FactorY;
+        csmFloat32 FactorXY;
+    };
+
+    /**
+     * Makes an instance of CubismLook.
+     *
+     * @return Maked instance of CubismLook
+     */
+    static CubismLook* Create();
+
+    /**
+     * Destroys an instance of CubismLook.
+     *
+     * @param instance Instance of CubismLook to destroy
+     */
+    static void Delete(CubismLook* instance);
+
+    /**
+     * Attaches the parameters of look.
+     *
+     * @param lookParameters Collection of look parameters to attach
+     */
+    void SetParameters(const csmVector<LookParameterData>& lookParameters);
+
+    /**
+     * Returns parameters attached to look.
+     *
+     * @return Attached collection of look parameters
+     */
+    const csmVector<LookParameterData>& GetParameters() const;
+
+    /**
+     * Updates the parameters of the model.
+     *
+     * @param model Model to update
+     * @param dragX X coordinate of the target
+     * @param dragY Y coordinate of the target
+     *
+     * @note Execute after making an instance with #Create() and binding parameters with #setParameters().
+     */
+    void UpdateParameters(CubismModel* model, const csmFloat32 dragX, const csmFloat32 dragY) const;
+
+private:
+    CubismLook() = default;
+    ~CubismLook() = default;
+
+    csmVector<LookParameterData> _lookParameters;
+};
+
+}}}

src/Model/CMakeLists.txt

@@ -4,6 +4,8 @@ target_sources(${LIB_NAME}
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismMoc.hpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismModel.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismModel.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/CubismModelMultiplyAndScreenColor.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/CubismModelMultiplyAndScreenColor.hpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismModelUserData.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismModelUserData.hpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismModelUserDataJson.cpp

src/Model/CubismMoc.hpp

@@ -95,7 +95,17 @@ class CubismMoc
      */
     static csmBool HasMocConsistencyFromUnrevivedMoc(const csmByte* mocBytes, csmSizeInt size);
 
-private:
+    /**
+     * Delete copy constructor.
+     */
+    CubismMoc(const CubismMoc&) = delete;
+
+    /**
+     * Delete copy assignment operator.
+     */
+    CubismMoc& operator=(const CubismMoc&) = delete;
+
+protected:
     CubismMoc(Core::csmMoc* moc);
 
     virtual ~CubismMoc();