Merge pull request #39 from Live2D/develop

Update to Cubism 5 SDK for Native R1 beta1
Live2D · Aug 17, 2023 · bb8de3a · bb8de3a
2 parents bd14cff + 07b9e8d
commit bb8de3a
Show file tree

Hide file tree

Showing 168 changed files with 16,733 additions and 456 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -22,3 +22,6 @@ end_of_line = crlf
 
 [*.bat]
 charset = unset
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@
 !/Samples/**/thirdParty/scripts/*
 !/Samples/OpenGL/thirdParty/stb/*
 !/Samples/Metal/thirdParty/stb/*
+!/Samples/Vulkan/thirdParty/stb/*
 # Other files
 /build/
 .vs/

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,24 @@ 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.1-beta.1] - 2023-08-17
+
+### Added
+
+* Add Wankoromochi as a model bundled with SDK.
+* Add the sample for Vulkan API in Windows.
+
+### Changed
+
+* Update third-party libraries.
+* Offscreen drawing-related terminology has been unified with "OffscreenSurface".
+* Adjusted to automatically search and use models in the Resource folder.
+
+### Fixed
+
+* Fix a bug that premultiplied alpha not works correctly when `PREMULTIPLIED_ALPHA_ENABLE` is not defined in Metal.
+
+
 ## [4-r.7] - 2023-05-25
 
 ### Added
@@ -305,6 +323,7 @@ See [Core Changelog] for details.
 * What was `Package.json` is currently being changed to`cubism-info.yml`.
 
 
+[5-r.1-beta.1]: https://github.com/Live2D/CubismNativeSamples/compare/4-r.7...5-r.1-beta.1
 [4-r.7]: https://github.com/Live2D/CubismNativeSamples/compare/4-r.6.2...4-r.7
 [4-r.6.2]: https://github.com/Live2D/CubismNativeSamples/compare/4-r.6.1...4-r.6.2
 [4-r.6.1]: https://github.com/Live2D/CubismNativeSamples/compare/4-r.6...4-r.6.1

diff --git a/Core/CHANGELOG.md b/Core/CHANGELOG.md
@@ -4,6 +4,26 @@ 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/).
 
+
+## 2023-08-17
+
+### Added
+
+* Enhance Blend Shape features.
+  * Please see [here](https://docs.live2d.com/en/cubism-editor-manual/blend-shape/).
+
+### Changed
+
+* Upgrade Core version to 05.00.0000.
+
+
+## 2023-05-09
+
+### Changed
+
+* Change the GCC version of the library for Linux from 6.5.0 to 8.3.0.
+
+
 ## 2023-03-16
 
 ### Fixed

diff --git a/Framework b/Framework
diff --git a/LICENSE.md b/LICENSE.md
@@ -55,6 +55,7 @@ Samples/Resources/Mao
 Samples/Resources/Mark
 Samples/Resources/Natori
 Samples/Resources/Rice
+Samples/Resources/Wanko
 ```
 
 If you use these models, you must agree to the terms of a contract set [here](https://docs.live2d.com/cubism-editor-manual/sample-model/) for each model.

diff --git a/NOTICE.ja.md b/NOTICE.ja.md
@@ -4,6 +4,12 @@
 
 # お知らせ
 
+## [注意事項] iOSにおけるMetalとOpenGLの描画差異について (2023-08-17)
+
+以前から発生していたMetalとOpenGLの描画差異について、macOSでの描画差異はCubism 5 SDK for Native R1 Beta1 (5-r.1-beta.1)にて解消いたしました。
+iOSでの描画差異は今後のアップデートにて対応する予定です。
+
+
 ## [注意事項] Cocos2d-xセットアップのエラーについて (2022-03-15)
 
 Cocos2d-xサンプルプロジェクトのセットアップ時に実行するsetup-cocos2dバッチにおいてエラーが発生いたします。

diff --git a/NOTICE.md b/NOTICE.md
@@ -4,6 +4,12 @@
 
 # Notices
 
+## [Caution] Differences between Metal and OpenGL rendering on iOS (2023-08-17)
+
+The rendering differences between Metal and OpenGL that have been occurring for some time have been resolved in Cubism 5 SDK for Native R1 Beta1 (5-r.1-beta.1) for macOS.
+The rendering difference on iOS will be addressed in a future update.
+
+
 ## [Caution] About Cocos2d-x setup error (2022-03-15)
 
 An error occurs in the setup-cocos2d batch that is executed when setting up the Cocos2d-x sample project.

diff --git a/README.ja.md b/README.ja.md
@@ -6,7 +6,7 @@
 
 # Cubism Native Samples
 
-Live2D Cubism 4 Editor で出力したモデルを表示するアプリケーションのサンプル実装です。
+Live2D Cubism Editor で出力したモデルを表示するアプリケーションのサンプル実装です。
 
 Cubism Native Framework および Live2D Cubism Core と組み合わせて使用します。
 
@@ -21,6 +21,13 @@ Cubism Native Framework および Live2D Cubism Core と組み合わせて使用
 本 SDK を使用する前に [お知らせ](NOTICE.ja.md)をご確認ください。
 
 
+## Cubism 5新機能や過去バージョンとの互換性について
+
+本 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/)をご確認ください。
+
+
 ## ディレクトリ構成
 
 ```
@@ -33,6 +40,7 @@ Cubism Native Framework および Live2D Cubism Core と組み合わせて使用
    ├─ D3D11         # DirectX 11 のサンプルプロジェクトが含まれるディレクトリ
    ├─ Metal         # Metal のサンプルプロジェクトが含まれるディレクトリ
    ├─ OpenGL        # OpenGL のサンプルプロジェクトが含まれるディレクトリ
+   ├─ Vulkan        # Vulkan のサンプルプロジェクトが含まれるディレクトリ
    └─ Resources     # モデルのファイルや画像などのリソースが含まれるディレクトリ
 ```
 
@@ -99,21 +107,21 @@ Demo
 
 | 開発ツール | バージョン |
 | --- | --- |
-| Android Studio | Flamingo 2022.2.1 Patch 1 |
-| CMake | 3.26.3 |
+| Android Studio | Giraffe 2022.3.1 |
+| CMake | 3.27.1 |
 | Visual Studio 2013 | Update 5 |
 | Visual Studio 2015 | Update 3 |
-| Visual Studio 2017 | 15.9.54 |
-| Visual Studio 2019 | 16.11.26 |
-| Visual Studio 2022 | 17.5.5 |
-| XCode | 14.3 |
+| Visual Studio 2017 | 15.9.56 |
+| Visual Studio 2019 | 16.11.29 |
+| Visual Studio 2022 | 17.7.0 |
+| XCode | 14.3.1 |
 
 ### Android
 
 | Android SDK tools | バージョン |
 | --- | --- |
 | Android NDK | 25.2.9519653 |
-| Android SDK | 33.0.2 |
+| Android SDK | 34.0.0 |
 | CMake | 3.22.1 |
 
 ### Linux
@@ -125,7 +133,7 @@ Demo
 | Red Hat | CentOS Stream 8 *1 | `centos:latest` | 8.5.0 |
 | Red Hat | CentOS Stream 9 | - | 11.3.1 |
 | Debian | Ubuntu 18.04 | `ubuntu:18.04` | 7.5.0 |
-| Debian | Ubuntu 22.04.2 | `ubuntu:22.04.2` | 11.3.0 |
+| Debian | Ubuntu 22.04.3 | `ubuntu:22.04.3` | 11.3.0 |
 
 *1 CentOS 8はサポートしておりません
 
@@ -143,8 +151,8 @@ Demo
 
 | プラットフォーム | バージョン |
 | --- | --- |
-| iOS / iPadOS | 16.4.1 |
-| macOS | 13.3 |
+| iOS / iPadOS | 16.6 |
+| macOS | 13.5 |
 | Windows 10 | 22H2 |
 | Windows 11 | 22H2 |
 
@@ -162,7 +170,7 @@ Demo
 | Red Hat | Amazon Linux | 2 |
 | Red Hat | CentOS Stream | 8 |
 | Red Hat | CentOS Stream | 9 |
-| Debian | Ubuntu | 22.04.2 |
+| Debian | Ubuntu | 22.04.3 |
 
 ## プロジェクトへの貢献
 

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 # Cubism Native Samples
 
-This is a sample implementation of an application that displays models output by Live2D Cubism 4 Editor.
+This is a sample implementation of an application that displays models output by Live2D Cubism Editor.
 
 It is used in conjunction with Cubism Native Framework and Live2D Cubism Core.
 
@@ -21,6 +21,13 @@ Please check the [license](LICENSE.md) before using this SDK.
 Please check the [notices](NOTICE.md) before using this SDK.
 
 
+## Compatibility with Cubism 5 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/).
+
+
 ## Directory structure
 
 ```
@@ -33,6 +40,7 @@ Please check the [notices](NOTICE.md) before using this SDK.
    ├─ D3D11         # Directory containing the DirectX 11 sample project
    ├─ Metal         # Directory containing the Metal sample project
    ├─ OpenGL        # Directory containing the OpenGL sample project
+   ├─ Vulkan        # Directory containing the Vulkan sample project
    └─ Resources     # Directory containing resources such as model files and images
 ```
 
@@ -98,21 +106,21 @@ Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repositor
 
 | Development Tool | Version |
 | --- | --- |
-| Android Studio | Flamingo 2022.2.1 Patch 1 |
-| CMake | 3.26.3 |
+| Android Studio | Giraffe 2022.3.1 |
+| CMake | 3.27.1 |
 | Visual Studio 2013 | Update 5 |
 | Visual Studio 2015 | Update 3 |
-| Visual Studio 2017 | 15.9.54 |
-| Visual Studio 2019 | 16.11.26 |
-| Visual Studio 2022 | 17.5.5 |
-| XCode | 14.3 |
+| Visual Studio 2017 | 15.9.56 |
+| Visual Studio 2019 | 16.11.29 |
+| Visual Studio 2022 | 17.7.0 |
+| XCode | 14.3.1 |
 
 ### Android
 
 | Android SDK tools | Version |
 | --- | --- |
 | Android NDK | 25.2.9519653 |
-| Android SDK | 33.0.2 |
+| Android SDK | 34.0.0 |
 | CMake | 3.22.1 |
 
 ### Linux
@@ -124,7 +132,7 @@ Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repositor
 | Red Hat | CentOS Stream 8 *1 | `centos:latest` | 8.5.0 |
 | Red Hat | CentOS Stream 9 | - | 11.3.1 |
 | Debian | Ubuntu 18.04 | `ubuntu:18.04` | 7.5.0 |
-| Debian | Ubuntu 22.04.1 | `ubuntu:22.04.1` | 11.3.0 |
+| Debian | Ubuntu 22.04.3 | `ubuntu:22.04.3` | 11.3.0 |
 
 *1 CentOS 8 is not supported
 
@@ -142,8 +150,8 @@ Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repositor
 
 | Platform | Version |
 | --- | --- |
-| iOS / iPadOS | 16.4.1 |
-| macOS | 13.3 |
+| iOS / iPadOS | 16.6 |
+| macOS | 13.5 |
 | Windows 10 | 22H2 |
 | Windows 11 | 22H2 |
 
@@ -161,7 +169,7 @@ Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repositor
 | Red Hat | Amazon Linux | 2 |
 | Red Hat | CentOS Stream | 8 |
 | Red Hat | CentOS Stream | 9 |
-| Debian | Ubuntu | 22.04.1 |
+| Debian | Ubuntu | 22.04.3 |
 
 ## Contributing
 

diff --git a/Samples/Cocos2d-x/Demo/CMakeLists.txt b/Samples/Cocos2d-x/Demo/CMakeLists.txt
@@ -68,6 +68,7 @@ list(APPEND GAME_SOURCE
   ${CLASSES_PATH}/LAppView.cpp
   ${CLASSES_PATH}/SampleScene.cpp
   ${CLASSES_PATH}/TouchManager.cpp
+  ${CLASSES_PATH}/LAppLive2DManagerInternal.cpp
 )
 
 list(APPEND GAME_HEADER
@@ -82,6 +83,7 @@ list(APPEND GAME_HEADER
   ${CLASSES_PATH}/LAppView.hpp
   ${CLASSES_PATH}/SampleScene.h
   ${CLASSES_PATH}/TouchManager.h
+  ${CLASSES_PATH}/LAppLive2DManagerInternal.h
 )
 
 # Add Cubism Core as static library.
@@ -248,6 +250,7 @@ if(APPLE)
   set_target_properties(${APP_NAME} PROPERTIES RESOURCE "${APP_UI_RES}")
   if(MACOSX)
     set_xcode_property(${APP_NAME} INFOPLIST_FILE "${COCOS2DX_ROOT_PATH}/templates/cpp-template-default/proj.ios_mac/mac/Info.plist")
+    target_compile_definitions(${APP_NAME} PRIVATE CSM_TARGET_MACOSX)
     target_compile_definitions(Framework PUBLIC CSM_TARGET_MAC_GL)
     set(COCOS_GLFW3 ${COCOS2DX_ROOT_PATH}/external/glfw3)
     target_include_directories(Framework PUBLIC ${COCOS_GLFW3}/include/Mac)
@@ -262,6 +265,7 @@ if(APPLE)
     set_xcode_property(${APP_NAME} TARGETED_DEVICE_FAMILY "1,2")
     set_xcode_property(${APP_NAME} ONLY_ACTIVE_ARCH "NO")
     set_xcode_property(${APP_NAME} ARCHS "arm64")
+    target_compile_definitions(${APP_NAME} PRIVATE CSM_TARGET_IOS)
     target_compile_definitions(Framework PUBLIC CSM_TARGET_IPHONE_ES2)
     target_include_directories(Framework PUBLIC ${COCOS2DX_ROOT_PATH}/cocos)
   endif()

diff --git a/Samples/Cocos2d-x/Demo/Classes/LAppDefine.cpp b/Samples/Cocos2d-x/Demo/Classes/LAppDefine.cpp
@@ -31,18 +31,6 @@ namespace LAppDefine {
     const csmChar* BackImageName = "back_class_normal.png";
 
     // モデル定義------------------------------------------
-    // モデルを配置したディレクトリ名の配列
-    // ディレクトリ名とmodel3.jsonの名前を一致させておくこと
-    const csmChar* ModelDir[] = {
-        "Haru",
-        "Hiyori",
-        "Mark",
-        "Natori",
-        "Rice",
-        "Mao"
-    };
-    const csmInt32 ModelDirSize = sizeof(ModelDir) / sizeof(const csmChar*);
-
     // 外部定義ファイル(json)と合わせる
     const csmChar* MotionGroupIdle = "Idle"; // アイドリング
     const csmChar* MotionGroupTapBody = "TapBody"; // 体をタップしたとき

diff --git a/Samples/Cocos2d-x/Demo/Classes/LAppDefine.hpp b/Samples/Cocos2d-x/Demo/Classes/LAppDefine.hpp
@@ -34,9 +34,6 @@ namespace LAppDefine {
     extern const csmChar* BackImageName;           ///< 背景画像ファイル
 
     // モデル定義--------------------------------------------
-    extern const csmChar* ModelDir[];               ///< モデルを配置したディレクトリ名の配列. ディレクトリ名とmodel3.jsonの名前を一致させておく.
-    extern const csmInt32 ModelDirSize;             ///< モデルディレクトリ配列のサイズ
-
     // 外部定義ファイル(json)と合わせる
     extern const csmChar* MotionGroupIdle;         ///< アイドリング時に再生するモーションのリスト
     extern const csmChar* MotionGroupTapBody;      ///< 体をタップした時に再生するモーションのリスト