CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

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

• Add missing default labels in switch statements of CubismShader_OpenGLES2 and CubismRenderer_Vulkan.

Fixed

• Fix incorrect implementation of csmVector::Insert.
• Fix a bug where rendering results were not as expected when using Blend mode on semi-transparent objects.

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

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

• Add support for Blend mode and Offscreen drawing.
  • In 5-r.5-beta.1, the OpenGL renderer works only on Windows, macOS, iOS, and Android. The SDK does not function in other environments. Please check NOTICE.md.

Changed

• Rename CubismOffscreenSurface_OpenGLES2 class to CubismRenderTarget_OpenGLES2.
• Change the API called to retrieve the drawable render order from GetDrawableRenderOrder() to GetRenderOrder() in CubismCore.

5-r.4.1 - 2025-07-17

Fixed

• Fix app crashing when shader files could not be loaded.

5-r.4 - 2025-05-29

Added

• Add parameter repeat processing that connects the right and left ends of the parameter to create a loop, allowing the motion to repeat.
  • Add the variable _isOverriddenParameterRepeat to the CubismModel class for managing parameter repeat flags at the model level.
  • Add the variable _userParameterRepeatDataList to the CubismModel class for managing parameter repeat flags for each parameter.
• Add a flag to the arguments of the following methods to enable the function that verifies the consistency of motion3.json:
  • CubismUserModel.LoadMotion()
  • CubismMotion.Create()
  • CubismMotion.Parse()
• Add a GetPartParentPartIndices() function.

Changed

• Change shader code to be used separately.

Removed

• Remove the usage of _DEBUG.

5-r.3 - 2025-02-18

Added

• Add new motion loop processing that seamlessly connects the start and end points of the loop.
  • The _isLoop variable was moved from class CubismMotion to class ACubismMotion.
  • Add the setter for _isLoop, SetLoop(csmBool loop), to class ACubismMotion.
  • Add the getter for _isLoop, GetLoop(), to class ACubismMotion.
  • The _isLoopFadeIn variable was moved from class CubismMotion to class ACubismMotion.
  • Add the setter for _isLoopFadeIn, SetLoopFadeIn(csmBool loopFadeIn), to class ACubismMotion.
  • Add the getter for _isLoopFadeIn, GetLoopFadeIn(), to class ACubismMotion.
  • Add a variable _motionBehavior for version control to the CubismMotion class.

Deprecated

• Deprecate the following elements due to the change in the variable declaration location.
  • CubismMotion::IsLoop(csmBool loop)
  • CubismMotion::IsLoop()
  • CubismMotion::IsLoopFadeIn(csmBool loopFadeIn)
  • CubismMotion::IsLoopFadeIn()

5-r.2 - 2024-12-19

Added

• Add copy constructor to csmMap.
• Add functions to get CombinedParameters listed in cdi3.json.
• Add the functionality to call a function when motion playback starts.
• Add updates to the OpenGL rendering code for HarmonyOS compatibility.
• Add Linux support for the Vulkan renderer.
• Add an API to CubismMotionJson for verifying the consistency of motion3.json. by @pillowtrucker
• Add dedicated resource destruction functions for some platforms

Changed

• Change an expression "overwrite" to "override" for multiply color, screen color, and culling to adapt the actual behavior.
• Change to permit to overwrite motion fade by the value specified in .model3.json on CubismUserModel::LoadMotion().
• Change the threshold for enabling anisotropic filtering in all renderers.
• Change CubismJson to not use character masking.
• Resources in Vulkan have been changed to support multi-buffering.
• Change the ACubismMotion::UpdateFadeWeight() function to return an error code of -1 when the argument is NULL. by @Coloryr
• Change the access level of the private members in the CubismModelSettingJson class to protected.
• Change the value of pi used in the calculation of CubismBreath::UpdateParameters() to CubismMath.PI.

Deprecated

• Deprecate the following elements because a priority value is not actually used during expression motion playback:

  • CubismExpressionMotionManager::_currentPriority
  • CubismExpressionMotionManager::_reservePriority
  • CubismExpressionMotionManager::StartMotionPriority()
  • CubismExpressionMotionManager::GetCurrentPriority()
  • CubismExpressionMotionManager::GetReservePriority()
  • CubismExpressionMotionManager::SetReservePriority()

  Please use the CubismMotionQueueManager::StartMotion() instead of CubismExpressionMotionManager::StartMotionPriority().

Fixed

• Fix an issue where already registered keys could be added on csmMap.appendKey().
• Fix JSON parser to work even when locale is set.
• Fix memory leak in Vulkan.
• Fix the Anisotropy processing of Vulkan to match the Sample.
• Fix D3D11 anisotropic filtering to allow filtering with the specified settings.
• Fix anisotropic filtering in D3D9.
  • Improved the rendering quality by setting the appropriate filter settings.
  • Anisotropic filtering is now properly processed.
• Fix a bug that caused an error when playing CubismExpresionMotion with CubismMotionQueueManager::StartMotion().
• Fix a potential problem with division by 0 when a pose fade time is set to 0 seconds.
• Fix an issue where calling += on csmString would throw an exception if the character count exceeded 64.

Removed

• Remove the Cocos2d-x renderer.

5-r.1 - 2024-03-26

Added

• Add function ModF() to compute floating-point remainder in CubismMath class.

Changed

• Change the Reset() function of CubismPose class to public.
• Change some processes in the renderer to be handled as functions.
• Change to output log if the argument MotionQueueEntry is NULL in the UpdateFadeWeight() function of the ACubismMotion class.

Deprecated

• Deprecate the _fadeWeight variable and the GetFadeWeight() function of the CubismExpressionMotion class.
  • The _fadeWeight variable of the CubismExpressionMotion class can cause problems.
  • Please use the GetFadeWeight() function of the CubismExpressionMotionManager class with one argument from now on.
• The StartMotion() function of the CubismMotionQueueManager class with the unnecessary third argument userTimeSeconds is deprecated.
  • Please use the StartMotion() function with two arguments from now on.

Fixed

• Fix a typo in SetParameterValue().
• Fix an issue that the override keyword is not specified for some functions of classes inheriting from CubismRenderer.
• Fix operator overloading in the CubismId class from being private to public.
• Fix a bug that caused incorrect weight values when expression motions were shared by multiple models.
  • Change the way fadeWeight is managed for expression motions.
• Fix shader build error when running nmake in Vulkan.

Removed

• Remove CubismSetupMaskedShaderUniforms, CubismNormalShaderUniforms, CubismMaskedShaderUniforms and CubismFragMaskedShaderUniforms from Metal and merged them into CubismMaskedShaderUniforms.

5-r.1-beta.4 - 2024-01-25

Fixed

• Fix memory leak in DX11.
• Fix an issue where models with a specific number of masks could not be drawn correctly.
• Fix to check for null when reading json.
• Fix an issue that caused some graphics drivers to not render correctly in Vulkan.
• Fix errors related to semaphore waiting stages.
• Fix errors that occurs when building with x86 in vulkan.

5-r.1-beta.3 - 2023-10-12

Added

• Add clamp() to CubismMath.

5-r.1-beta.2 - 2023-09-28

Added

• Add a function to the ACubismMotion class that sets arbitrary data in the callback. by @MizunagiKB
• Add a comment for clarity for the function whose usage is not intuitive.

Changed

• Change getter functions to get some datas without GetIdManager in CubismModel.

Fixed

• Fix a typo in a variable related to the bezier handle restriction state.

5-r.1-beta.1 - 2023-08-17

Added

• Add the function to get the ID of a given parameter.(CubismModel::GetParameterId)
• Add the CubismExpressionMotionManager class.
• Add a Renderer for Vulkan API in Windows.

Changed

• Unify Offscreen drawing-related terminology with OffscreenSurface.
• Change comment guidelines for headers in the Framework directory.

Fixed

• Fix a bug that caused cocos2d-x culling to not be performed correctly.
• Fix the structure of the class in renderer.
• Separate the high precision mask process from the clipping mask setup process.
• Separate shader class from CubismRenderer files for Cocos2d-x, Metal, OpenGL.
• Fix Metal rendering results on macOS to be similar to OpenGL.
  • If you want to apply the previous Metal rendering results, change mipFilter in MTLSamplerDescriptor from MTLSamplerMipFilterLinear to MTLSamplerMipFilterNotMipmapped.
• Fix a bug that the value applied by multiply was not appropriate during expression transitions.

Removed

• Remove several arguments of DrawMesh function.

4-r.7 - 2023-05-25

Added

• Add some function for checking consistency of MOC3.
  • Add the function of checking consistency on reviving a MOC3. (CubismMoc::Create)
  • Add the function of checking consistency from unrevived MOC3. (CubismMoc::HasMocConsistencyFromUnrevivedMoc)
• Add some functions to change Multiply and Screen colors on a per part basis.

Changed

• Change access specifier for CubismExpressionMotion.
• Change to get opacity according to the current time of the motion.

4-r.6.2 - 2023-03-16

Fixed

• Fix a bug that caused double and triple buffering to be disabled on DirectX systems due to multiple render textures in 4-r.6.
• Fix the condition of splitting the mask buffer according to the number of masks used to be in accordance with the specification.
• Fix some problems related to Cubism Core.
  • See CHANGELOG.md in Core.

4-r.6.1 - 2023-03-10

Added

• Add function to validate MOC3 files.

4-r.6 - 2023-02-21

Added

• Add API to allow users to configure culling.
• The number of render textures used can now be increased arbitrarily.
  • The maximum number of masks when using multiple render textures has been increased to "number of render textures * 32".

Fixed

• Fix a bug that models with culling were not rendered correctly in Metal.
• Fix a bug that caused some masks to be rendered incorrectly when using 17 or more masks in DirectX systems.

Removed

• Remove unnecessary variable modelToWorldF in renderer.

4-r.5.1 - 2022-09-15

Fixed

• Fix a bug that caused a crash if an empty array existed in json.

4-r.5 - 2022-09-08

Added

• Add immediate stabilization of physics.
• Add the multilingual supported documents.

Fixed

• Fix a memory leak that occurred when defining a Vector with size 0.

4-r.5-beta.5 - 2022-08-04

Fixed

• Fix a bug in which processing was interrupted when an invalid vertex was specified in the middle of a physics operation.
• Fix physics system input to be split by the physics setting time.
• Fix a tiny memory leak in Cubism physics.

4-r.5-beta.4.1 - 2022-07-08

Fixed

• Fix Core API called in GetDrawableParentPartIndex function.

4-r.5-beta.4 - 2022-07-07

Added

• Add a function to get the latest .moc3 Version and the .moc3 Version of the loaded model.
• Add a function to get the type of parameters of the model.
• Add a function to get the parent part of the model's Drawable.

Changed

• Disable ARC in Metal renderer.

Fixed

• Fix dangling pointer in GetRenderPassDescriptor function for Metal.

4-r.5-beta.3 - 2022-06-16

Fixed

• GetDrawableTextureIndices function in CubismModel has been renamed to GetDrawableTextureIndex because the name was not correct.
  • GetDrawableTextureIndices function is marked as deprecated.
• Fix physics system behaviour when exists Physics Fps Setting in .physics3.json.
• Fix force close problem when invalid physics3.json is read.
• Fixed memory leak in Cocos2d-x.

4-r.5-beta.2 - 2022-06-02

Fixed

• Fixed a bug that caused Multiply Color / Screen Color of different objects to be applied.
  • See CHANGELOG.md in Core.
  • No modifications to Samples and Framework.

4-r.5-beta.1 - 2022-05-19

Added

• Add processing related to Multiply Color / Screen Color added in Cubism 4.2.
• Add a function to reset the physics states.

Fixed

• Fix GetTextureDirectory() to return the directory name of the 0th texture path.

4-r.4 - 2021-12-09

Added

• Add the rendering options on Metal:

  • USE_RENDER_TARGET
  • USE_MODEL_RENDER_TARGET

• Add anisotropic filtering to Metal.

• Add a macro to toggle the precision of floating point numbers in OpenGL fragment shaders.

• Add a function to check .cdi3.json exists from .model3.json.

• Add CubismJsonHolder, a common class used to instantiate and check the validity of CubismJson.

  • Each Json parser will now warn if an class of CubismJson is invalid.

Changed

• Change each Json parser inherits a common class CubismJsonHolder.

Fixed

• Fix renderer for Cocos2d-x v4.0.
  • RenderTexture was empty when using USE_MODEL_RENDER_TARGET.
• Fix motions with different fade times from switching properly.
• Fix a bug that motions currently played do not fade out when play a motion.

4-r.4-beta.1 - 2021-10-07

Added

• Add a function to parse the opacity from .motion3.json.
• Add a Renderer for Metal API in iOS.
  • There are some restrictions, see NOTICE.md.

Fixed

• Fix return correct error values for out-of-index arguments in cubismjson by @cocor-au-lait.
• Fix a warning when SegmentType could not be obtained when loading motion.
• Fix renderer for Cocos2d-x v4.0.
  • Rendering didn't work when using USE_RENDER_TARGET and high precision masking.

4-r.3 - 2021-06-10

4-r.3-beta.1 - 2021-05-13

Added

• Add a Renderer for Cocos2d-x v4.0.
• Implement a function to get the correct value when the time axis of the Bezier handle cannot be linear.
• Add an argument to the function SetClippingMaskBufferSize to set the height and width of the clipping mask buffer.

Changed

• Improve the quality of Clipping Mask on high precision masking.

4-r.2 - 2021-02-17

Added

• Implement anisotropic filtering for DirectX-based Renderer.
• Implement get pixel size and PixelsPerUnit of the model

Changed

• Check pointer before use to avoid crash by @Xrysnow

Fixed

• Fix Physics input reflect flag on evaluate.
• Fix renderer for OpenGL.
  • Add delete mask buffer when renderer instance is destroyed.
• Fix delay in starting fade-out for expressions.
• Fix memory bug causing segmentation fault when reallocating memory by @adrianiainlam
• Fix reference size of model matrix.
• Fix memory leaking the color buffer on destroyed CubismOffscreenFrame_OpenGLES2.
• Fix argument name typo at CubismEyeBlink::SetBlinkingInterval().

4-r.1 - 2020-01-30

Added

• Add the callback function called on finished motion playback.

Changed

• Include header files in CMake.
• <GL/glew> is not included on macOS if CSM_TARGET_COCOS is defined.

Fixed

• Fix rendering not working properly on Android devices with Tegra.

Deprecated

• Use target_include_directories instead of using FRAMEWORK_XXX_INCLUDE_PATH variable in application CMake.
• Use target_compile_definitions instead of using FRAMEWORK_DEFINITIOINS variable in application CMake.
• Specify FRAMEWORK_SOURCE variable also in OpenGL application CMake.

4-beta.2 - 2019-11-14

Added

• Add the includes to Framework for Linux build.

Changed

• Refactoring CMakeLists.txt

Fixed

• Fix renderer for DirectX 9 / 11.
  • Add missing implementation: Check the dynamic flags.

4-beta.1 - 2019-09-04

Added

• Support new Inverted Masking features.
• Add .editorconfig and .gitattributes to manage file formats.
• Add .gitignore.
• Add CHANGELOG.md.

Changed

• Convert all file formats according to .editorconfig.

Fixed

• Fix typo of CubismCdiJson.
• Fix invalid expressions of CubismCdiJson.