Update to Cubism 5 SDK for Native R5 beta2

Author: wada-at-live2d-com

CHANGELOG.md

@@ -5,6 +5,33 @@ 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-beta.2] - 2025-10-30
+
+### Added
+
+* Add support for Blend modes and Offscreen rendering.
+  * In `5-r.5-beta.2`, the D3D9, D3D11 and Metal renderers have also been added.
+* Add `GetMocVersionFromBuffer()`function.
+  * Support for retrieving MOC version from unsupported new MOC3 files.
+
+### Changed
+
+* Rename CubismOffscreenSurface_D3D9 class to CubismRenderTarget_D3D9.
+* Rename CubismOffscreenSurface_D3D11 class to CubismRenderTarget_D3D11.
+* Rename CubismOffscreenSurface_Metal class to CubismRenderTarget_Metal.
+* Change to the implementation now enables support for multiple devices instead of a single one.
+  * In Metal, the `CubismRenderingInstanceSingleton_Metal` class has been removed.
+
+### Fixed
+
+* Fix by removing unnecessary comments and unused structs.
+* Fix the application crashing when shader files could not be loaded.
+* Fix warnings occurs during build on OpenGL-Android.
+* Fix D3D11 anisotropic filtering not working correctly.
+* Fix to correct pixel alignment for all shaders on D3D9.
+* Fix incorrect mask type selection on OpenGL, selecting `MaskTypeMaskedInvertedPremultipliedAlpha` instead of `MaskTypeMaskedPremultipliedAlpha`.
+
+
 ## [5-r.5-beta.1] - 2025-08-26
 
 ### Added
@@ -490,6 +517,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix invalid expressions of `CubismCdiJson`.
 
 
+[5-r.5-beta.2]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.5-beta.1...5-r.5-beta.2
 [5-r.5-beta.1]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.4.1...5-r.5-beta.1
 [5-r.4.1]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.4...5-r.4.1
 [5-r.4]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.3...5-r.4

NOTICE.ja.md

@@ -4,19 +4,17 @@
 
 # お知らせ
 
-## [制限事項] Cubism 5 SDK for Native R5 beta1 の動作環境について (2025-08-26)
+## [制限事項] Cubism 5 SDK for Native R5 beta2 の動作環境について (2025-10-30 更新)
 
-Cubism 5 SDK for Native R5 beta1 は、以下のプラットフォームにてビルド動作確認をしております。
+Cubism 5 SDK for Native R5 beta2 について、Vulkan環境は**ビルドができません**ので、あらかじめご了承ください。
+Vulkan環境は今後のアップデートにてCubism 5.3新機能も含め対応を予定しています。 
+その他の環境については対応しております。
 
-- OpenGL
-  - Windows
-  - macOS
-  - iOS
-  - Android
-
-それ以外の環境では**ビルドができません**ので、あらかじめご了承ください。
-ビルド未対応のレンダラ及びプラットフォームの動作については Cubism 5 SDK for Native R5 beta2 以降の対応を予定しています。 
+## [注意事項] Cubism 5 SDK for Native R5 beta2 Metal環境のパフォーマンスについて (2025-10-30)
 
+Cubism 5 SDK for Native R5 beta2 Metal環境にてモデルを描画した際、iOS 26、iPadOS 26 及び macOS 26 環境においてパフォーマンスが劣化する場合がございます。
+本件はコマンドエンコーダー（ `MTLRenderCommandEncoder` 及び `MTLBlitCommandEncoder` ）のオーバーヘッドによるものと考えておりますが、
+今後のアップデートにてFrameworkの改修や、最新のMetalバージョンへ移行することも含めて調査し、対応を検討してまいります。
 
 ---
 

NOTICE.md

@@ -4,19 +4,17 @@
 
 # Notices
 
-## [Restrictions] Operating Environment for Cubism 5 SDK for Native R5 beta1 (2025-08-26)
+## [Restrictions] Operating Environment for Cubism 5 SDK for Native R5 beta2 (Updated 2025-10-30)
 
-Cubism 5 SDK for Native R5 beta1 has been tested for build operation on the following platforms:
+Please be aware that the Cubism 5 SDK for Native R5 beta2 does not support builds in Vulkan environments. 
+Support for Vulkan, including new features of Cubism 5.3, is planned for future updates. 
+Other environments are supported.
 
-- OpenGL
-  - Windows
-  - macOS
-  - iOS
-  - Android
-
-Please note that **building is not supported** on other environments. 
-We plan to support the functionality of unsupported renderers and platforms in Cubism 5 SDK for Native R5 beta2 and later.
+## [Cautions] Performance of Cubism 5 SDK for Native R5 beta2 in Metal Environments (2025-10-30)
 
+When rendering models in the Metal environment of Cubism 5 SDK for Native R5 beta2, performance may degrade in iOS 26, iPadOS 26, and macOS 26 environments.
+This issue is believed to be caused by overhead from the command encoders (`MTLRenderCommandEncoder` and `MTLBlitCommandEncoder`).
+We will investigate and consider addressing this issue in future updates, including modifications to the Framework and migration to the latest Metal version.
 
 ---
 

src/Effect/CubismEyeBlink.cpp

@@ -52,7 +52,7 @@ CubismEyeBlink::~CubismEyeBlink()
 
 csmFloat32 CubismEyeBlink::DetermineNextBlinkingTiming() const
 {
-    const csmFloat32 r = static_cast<csmFloat32>(rand()) / RAND_MAX;
+    const csmFloat32 r = static_cast<csmFloat32>(rand()) / static_cast<csmFloat32>(RAND_MAX);
 
     return _userTimeSeconds + (r * (2.0f * _blinkingIntervalSeconds - 1.0f));
 }

src/Model/CubismMoc.cpp

@@ -96,6 +96,25 @@ Core::csmMocVersion CubismMoc::GetMocVersion()
     return _mocVersion;
 }
 
+Core::csmMocVersion CubismMoc::GetMocVersionFromBuffer(const csmByte* mocBytes, csmSizeInt size)
+{
+    if (mocBytes == nullptr || size == 0)
+    {
+        CubismLogError("Invalid mocBytes or size.");
+        return 0;
+    }
+    void* alignedBuffer = CSM_MALLOC_ALLIGNED(size, Core::csmAlignofMoc);
+    if (alignedBuffer == nullptr)
+    {
+        CubismLogError("Failed to allocate aligned memory.");
+        return 0;
+    }
+    memcpy(alignedBuffer, mocBytes, size);
+    const Core::csmMocVersion version = Core::csmGetMocVersion(alignedBuffer, size);
+    CSM_FREE_ALLIGNED(alignedBuffer);
+    return version;
+}
+
 csmBool CubismMoc::HasMocConsistency(void* address, const csmUint32 size)
 {
     csmInt32 isConsistent = Core::csmHasMocConsistency(address, size);

src/Model/CubismMoc.hpp

@@ -65,6 +65,16 @@ class CubismMoc
      */
     Core::csmMocVersion GetMocVersion();
 
+    /**
+     * Returns the version of the unload MOC file.
+     *
+     * @param mocBytes Buffer containing the loaded MOC file
+     * @param size Size of the buffer in bytes
+     *
+     * @return Version
+     */
+    static Core::csmMocVersion GetMocVersionFromBuffer(const csmByte* mocBytes, csmSizeInt size);
+
     /**
      * Checks the consistency of the MOC file.
      *

src/Model/CubismModel.cpp

@@ -762,10 +762,7 @@ const csmInt32* CubismModel::GetOffscreenOwnerIndices() const
 const CubismIdHandle CubismModel::GetOffscreenOwnerId(csmUint32 offscreenIndex) const
 {
     const csmUint32 ownerIndex = GetOffscreenOwnerIndices()[offscreenIndex];
-
-     return  CubismFramework::GetIdManager()->GetId(Core::csmGetPartIds(_model)[ownerIndex]);
-
-    return NULL;
+    return CubismFramework::GetIdManager()->GetId(Core::csmGetPartIds(_model)[ownerIndex]);
 }
 
 csmInt32 CubismModel::GetDrawableCount() const

src/Model/CubismUserModel.cpp

@@ -279,6 +279,11 @@ CubismModel* CubismUserModel::GetModel() const
     return _model;
 }
 
+Core::csmMocVersion CubismUserModel::GetMocVersionFromBuffer(const csmByte* buffer, csmSizeInt size)
+{
+    return CubismMoc::GetMocVersionFromBuffer(buffer, size);
+}
+
 void CubismUserModel::CreateRenderer(csmUint32 width, csmUint32 height, csmInt32 maskBufferCount)
 {
     if (_renderer)

src/Model/CubismUserModel.hpp

@@ -192,6 +192,16 @@ class CubismUserModel
      */
     CubismModel*            GetModel() const;
 
+    /**
+     * Returns the version of the unload MOC file.
+     *
+     * @param buffer Buffer where the MOC3 file is loaded
+     * @param size Number of bytes in the buffer
+     *
+     * @return Version
+     */
+    static Core::csmMocVersion GetMocVersionFromBuffer(const csmByte* buffer, csmSizeInt size);
+
     /**
      * Returns the renderer.
      *

src/Rendering/CubismRenderer.hpp

@@ -20,7 +20,7 @@ class CubismModel;
 namespace Live2D { namespace Cubism { namespace Framework { namespace Rendering {
 
 /**
- * @brief   モデル描画を処理するレンダラ<br>
+ * @brief   モデル描画を処理するレンダラ
  *           サブクラスに環境依存の描画命令を記述する
  */
 class CubismRenderer
@@ -45,6 +45,7 @@ class CubismRenderer
         CubismBlendMode_Additive = 1,        ///< 加算
         CubismBlendMode_Multiplicative = 2,  ///< 乗算
         CubismBlendMode_Mask = 3,            ///< マスク
+        CubismBlendMode_Copy = 4,            ///< コピー
     };
 
     /**
@@ -88,43 +89,6 @@ class CubismRenderer
 
     };
 
-    /**
-    * @brief エイリアスの描画対象のソート結果を管理するための構造体
-    */
-    struct CubismDrawableSortItem
-    {
-        /**
-         * @brief   コンストラクタ
-         */
-        CubismDrawableSortItem()
-            : ObjectIndex(0)
-            , ObjectType(0)
-            , RenderOrder(0)
-        {
-        }
-
-        /**
-         * @brief   コンストラクタ
-         */
-        CubismDrawableSortItem(csmInt32 objectIndex, csmInt32 objectType, csmInt32 renderOrder)
-            : ObjectIndex(objectIndex)
-            , ObjectType(objectType)
-            , RenderOrder(renderOrder)
-        {
-        }
-
-        /**
-         * @brief   デストラクタ
-         */
-        virtual ~CubismDrawableSortItem()
-        {
-        }
-
-        csmInt32 ObjectIndex;
-        csmInt32 ObjectType;
-        csmInt32 RenderOrder;
-    };
-
     /**
      * @brief   レンダラのインスタンスを生成して取得する
      *