Update to Cubism 5 SDK for Native R5 beta3

Author: wada-at-live2d-com

CHANGELOG.md

@@ -4,6 +4,22 @@ 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.3] - 2026-01-29
+
+### Added
+
+* Add the classes `CubismOffscreenRenderTarget_XXX` and `CubismOffscreenManager_XXX`, as well as the interfaces `ICubismOffscreenRenderTarget` and `ICubismOffscreenManager`, in order to reuse `CubismRenderTarget_XXX` for Offscreen rendering.
+* Add support for Blend mode and Offscreen drawing in Vulkan.
+
+### Fixed
+
+* Fix an issue that caused performance degradation on Metal.
+* Fix clipping mask pre-processing by consolidating functions.
+* Fix unused macros in OpenGL.
+* Fix incomplete OpenGL shader issue.
+* Fix incorrect UV coordinates when using masks with D3D9 and D3D11.
+* Fix typos in `CubismFramework.hpp`.
+
 
 ## [5-r.5-beta.2] - 2025-10-30
 
@@ -517,6 +533,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.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
 [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

NOTICE.ja.md

@@ -4,17 +4,6 @@
 
 # お知らせ
 
-## [制限事項] Cubism 5 SDK for Native R5 beta2 の動作環境について (2025-10-30 更新)
-
-Cubism 5 SDK for Native R5 beta2 について、Vulkan環境は**ビルドができません**ので、あらかじめご了承ください。
-Vulkan環境は今後のアップデートにてCubism 5.3新機能も含め対応を予定しています。 
-その他の環境については対応しております。
-
-## [注意事項] 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,17 +4,6 @@
 
 # Notices
 
-## [Restrictions] Operating Environment for Cubism 5 SDK for Native R5 beta2 (Updated 2025-10-30)
-
-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.
-
-## [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.
 
 ---
 

README.ja.md

@@ -15,11 +15,11 @@ Live2D Cubism Editor で出力したモデルをアプリケーションで利
 本フレームワークを使用する前に、[ライセンス](LICENSE.md)をご確認ください。
 
 
-## Cubism 5新機能や過去バージョンとの互換性について
+## Cubism 5.3新機能や過去バージョンとの互換性について
 
-本 SDK はCubism 5に対応した製品です。  
-Cubism 5 Editorに搭載された新機能のSDK対応については [こちら](https://docs.live2d.com/cubism-sdk-manual/cubism-5-new-functions/)をご確認ください。  
-過去バージョンのCubism SDKとの互換性については [こちら](https://docs.live2d.com/cubism-sdk-manual/compatibility-with-cubism-5/)をご確認ください。
+本 SDK はCubism 5.3に対応した製品です。  
+Cubism 5.3 Editorに搭載された新機能のSDK対応については [こちら](https://docs.live2d.com/cubism-sdk-manual/cubism-5-3-new-functions/)をご確認ください。  
+過去バージョンのCubism SDKとの互換性については [こちら](https://docs.live2d.com/cubism-sdk-manual/compatibility-with-cubism-5-3/)をご確認ください。
 
 
 ## コンポーネント

README.md

@@ -20,11 +20,11 @@ Comments of the source codes are being translated into English.
 Please [Go Here](./TRANSLATION.md) for the status.
 
 
-## Compatibility with Cubism 5 new features and previous Cubism SDK versions
+## Compatibility with Cubism 5.3 new features and previous Cubism SDK versions
 
-This SDK is compatible with Cubism 5.  
-For SDK compatibility with new features in Cubism 5 Editor, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/cubism-5-new-functions/).  
-For compatibility with previous versions of Cubism SDK, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/compatibility-with-cubism-5/).
+This SDK is compatible with Cubism 5.3.  
+For SDK compatibility with new features in Cubism 5.3 Editor, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/cubism-5-3-new-functions/).  
+For compatibility with previous versions of Cubism SDK, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/compatibility-with-cubism-5-3/).
 
 
 ## Components

src/CubismFramework.hpp

@@ -44,7 +44,7 @@ class CubismAllocationAlignedTag
 { };
 
 static CubismAllocationTag GlobalTag;
-static CubismAllocationAlignedTag GloabalAlignedTag;
+static CubismAllocationAlignedTag GlobalAlignedTag;
 
 }}}
 
@@ -107,9 +107,9 @@ void CsmDelete(T* address)
 #define CSM_DELETE_SELF(type, obj)       do { if (!obj){ break; } obj->~type(); operator delete(obj, Live2D::Cubism::Framework::GlobalTag); } while(0)
 #define CSM_DELETE(obj)                  CsmDelete(obj)
 #define CSM_MALLOC(size)                 Live2D::Cubism::Framework::CubismFramework::Allocate(size)
-#define CSM_MALLOC_ALLIGNED(size, align) Live2D::Cubism::Framework::CubismFramework::AllocateAligned(size, align)
+#define CSM_MALLOC_ALIGNED(size, align) Live2D::Cubism::Framework::CubismFramework::AllocateAligned(size, align)
 #define CSM_FREE(ptr)                    Live2D::Cubism::Framework::CubismFramework::Deallocate(ptr)
-#define CSM_FREE_ALLIGNED(ptr)           Live2D::Cubism::Framework::CubismFramework::DeallocateAligned(ptr)
+#define CSM_FREE_ALIGNED(ptr)           Live2D::Cubism::Framework::CubismFramework::DeallocateAligned(ptr)
 
 #endif
 

src/Model/CubismMoc.cpp

@@ -14,7 +14,7 @@ CubismMoc* CubismMoc::Create(const csmByte* mocBytes, csmSizeInt size, csmBool s
 {
     CubismMoc* cubismMoc = NULL;
 
-    void* alignedBuffer = CSM_MALLOC_ALLIGNED(size, Core::csmAlignofMoc);
+    void* alignedBuffer = CSM_MALLOC_ALIGNED(size, Core::csmAlignofMoc);
     memcpy(alignedBuffer, mocBytes, size);
 
     if (shouldCheckMocConsistency)
@@ -23,7 +23,7 @@ CubismMoc* CubismMoc::Create(const csmByte* mocBytes, csmSizeInt size, csmBool s
         csmBool consistency = HasMocConsistency(alignedBuffer, size);
         if (!consistency)
         {
-            CSM_FREE_ALLIGNED(alignedBuffer);
+            CSM_FREE_ALIGNED(alignedBuffer);
 
             // 整合性が確認できなければ処理しない
             CubismLogError("Inconsistent MOC3.");
@@ -58,14 +58,14 @@ CubismMoc::~CubismMoc()
 {
     CSM_ASSERT(_modelCount == 0);
 
-    CSM_FREE_ALLIGNED(_moc);
+    CSM_FREE_ALIGNED(_moc);
 }
 
 CubismModel* CubismMoc::CreateModel()
 {
     CubismModel*     cubismModel = NULL;
     const csmUint32  modelSize = Core::csmGetSizeofModel(_moc);
-    void*            modelMemory = CSM_MALLOC_ALLIGNED(modelSize, Core::csmAlignofModel);
+    void*            modelMemory = CSM_MALLOC_ALIGNED(modelSize, Core::csmAlignofModel);
 
     Core::csmModel* model = Core::csmInitializeModelInPlace(_moc, modelMemory, modelSize);
 
@@ -103,15 +103,15 @@ Core::csmMocVersion CubismMoc::GetMocVersionFromBuffer(const csmByte* mocBytes,
         CubismLogError("Invalid mocBytes or size.");
         return 0;
     }
-    void* alignedBuffer = CSM_MALLOC_ALLIGNED(size, Core::csmAlignofMoc);
+    void* alignedBuffer = CSM_MALLOC_ALIGNED(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);
+    CSM_FREE_ALIGNED(alignedBuffer);
     return version;
 }
 
@@ -123,12 +123,12 @@ csmBool CubismMoc::HasMocConsistency(void* address, const csmUint32 size)
 
 csmBool CubismMoc::HasMocConsistencyFromUnrevivedMoc(const csmByte* mocBytes, csmSizeInt size)
 {
-    void* alignedBuffer = CSM_MALLOC_ALLIGNED(size, Core::csmAlignofMoc);
+    void* alignedBuffer = CSM_MALLOC_ALIGNED(size, Core::csmAlignofMoc);
     memcpy(alignedBuffer, mocBytes, size);
 
     csmBool consistency = CubismMoc::HasMocConsistency(alignedBuffer, size);
 
-    CSM_FREE_ALLIGNED(alignedBuffer);
+    CSM_FREE_ALIGNED(alignedBuffer);
 
     return consistency;
 }

src/Model/CubismModel.cpp

@@ -34,7 +34,7 @@ CubismModel::CubismModel(Core::csmModel* model)
 
 CubismModel::~CubismModel()
 {
-    CSM_FREE_ALLIGNED(_model);
+    CSM_FREE_ALIGNED(_model);
 }
 
 csmFloat32 CubismModel::GetParameterValue(CubismIdHandle parameterId)

src/Model/CubismModel.hpp

@@ -312,7 +312,7 @@ class CubismModel
          * Constructor.
          *
          * @param objectIndex index of the object
-         * @param type type of the object (Drawable, Parts, or Alias)
+         * @param type type of the object (Drawable or Parts)
          */
         CubismModelObjectInfo(csmUint32 objectIndex, ObjectType type)
             : ObjectIndex(objectIndex)
@@ -327,7 +327,7 @@ class CubismModel
         {
         }
 
-        ObjectType ObjectType;  ///< Type of the object (Drawable, Parts, or Alias)
+        ObjectType ObjectType;  ///< Type of the object (Drawable or Parts)
         csmUint32 ObjectIndex;  ///< Index of the object
     };
 

src/Rendering/CMakeLists.txt

@@ -6,7 +6,8 @@ target_sources(${LIB_NAME}
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismClippingManager.tpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismRenderer.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CubismRenderer.hpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/CubismRenderTarget.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ICubismOffscreenManager.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ICubismOffscreenRenderTarget.hpp
 )
 
 # Add specified rendering directory.