diff --git a/Packages/src/CHANGELOG.md b/Packages/src/CHANGELOG.md index 864885c..09a57d8 100644 --- a/Packages/src/CHANGELOG.md +++ b/Packages/src/CHANGELOG.md @@ -1,3 +1,58 @@ +# [3.0.0](https://github.com/mob-sakai/SoftMaskForUGUI/compare/v2.3.0...v3.0.0) (2024-09-05) + + +### Bug Fixes + +* `MaskingShape.maskingMethod = Subtract` is not working correctly ([cc77830](https://github.com/mob-sakai/SoftMaskForUGUI/commit/cc77830cc479326f1b8e4585a3c6452455bfe2d9)) +* `Stereo Enabled` option in preferences does not work ([388a73f](https://github.com/mob-sakai/SoftMaskForUGUI/commit/388a73f5bd65f75f73d81b58d8be08cb756b7428)) +* fix a major performance regression where if you had a lot of softmaskable components (even if the parent canvas was in-active) it would eat over 20ms doing a certain editor-only function ([2d793c4](https://github.com/mob-sakai/SoftMaskForUGUI/commit/2d793c42636f378b7acf6f6808ca86971b12c0cf)) +* fix broken anchor on README.md ([1e53068](https://github.com/mob-sakai/SoftMaskForUGUI/commit/1e5306820a55a576797d6e994a4d27e5f2793009)) +* fix null exception ([23b0b2c](https://github.com/mob-sakai/SoftMaskForUGUI/commit/23b0b2c72ab33680c9791a2fbd148e4819bb1a42)) +* fix soft-maskable shaders for TextMeshPro v2.0/v2.1/v2.2/v3.0 ([83eacec](https://github.com/mob-sakai/SoftMaskForUGUI/commit/83eaceccbd2580de632213c6b19c587d0d35cbdb)) +* fix upgrading asset system (v1 to v2) ([3cdcc86](https://github.com/mob-sakai/SoftMaskForUGUI/commit/3cdcc86fcfc87c4daa28f8d045c4610ecdcc2e2a)) +* flashing when SoftnessRange is changed in inspector ([12f81cf](https://github.com/mob-sakai/SoftMaskForUGUI/commit/12f81cf9845142e0cb651c70862b9b938c1549c4)) +* if no `Canvas` in the parents of the `SoftMask`, error occurred ([710d2cf](https://github.com/mob-sakai/SoftMaskForUGUI/commit/710d2cfb70778a52b77eb3e345065f952385f928)), closes [#182](https://github.com/mob-sakai/SoftMaskForUGUI/issues/182) +* in linear color mode, `TextMeshProUGUI` appeared darker ([780beb1](https://github.com/mob-sakai/SoftMaskForUGUI/commit/780beb119862a905a18f3ad468f4a5b479b596be)), closes [#187](https://github.com/mob-sakai/SoftMaskForUGUI/issues/187) +* nested `MaskingShape` is not working correctly ([560f6a3](https://github.com/mob-sakai/SoftMaskForUGUI/commit/560f6a3e421ea2d22d5e25466435fb57f7d262e3)), closes [#189](https://github.com/mob-sakai/SoftMaskForUGUI/issues/189) +* placing a SoftMaskable object outside of a SoftMask makes the object invisible ([096aa69](https://github.com/mob-sakai/SoftMaskForUGUI/commit/096aa6922bdb4500b79d1ccb7ff4c969c4881726)), closes [#180](https://github.com/mob-sakai/SoftMaskForUGUI/issues/180) +* ShaderGraph support is not included ([7df8b2b](https://github.com/mob-sakai/SoftMaskForUGUI/commit/7df8b2b6a8d68f437c934be10ea385e13259d194)) +* shaders for SoftMask are not automatically included ([0c22da7](https://github.com/mob-sakai/SoftMaskForUGUI/commit/0c22da789e854b2fcb509f9addc6c6a633d5c9cc)), closes [#177](https://github.com/mob-sakai/SoftMaskForUGUI/issues/177) [#178](https://github.com/mob-sakai/SoftMaskForUGUI/issues/178) +* soft mask buffer is fliped on UNITY_UV_STARTS_AT_TOP devices ([b44edc3](https://github.com/mob-sakai/SoftMaskForUGUI/commit/b44edc35005e658527853e1833b2c34dc34938bd)), closes [#179](https://github.com/mob-sakai/SoftMaskForUGUI/issues/179) +* soft mask is upside down on some devices ([e16a161](https://github.com/mob-sakai/SoftMaskForUGUI/commit/e16a161ef7c66da11648ced5030e37aeae2258ff)), closes [#185](https://github.com/mob-sakai/SoftMaskForUGUI/issues/185) +* soft mask is upside down on some devices (refactor) ([c9db361](https://github.com/mob-sakai/SoftMaskForUGUI/commit/c9db3613a2414a113889338d0e79066a7abda7ed)) +* soft masked image flickers or disappears when resizing canvas in editor ([767bb5b](https://github.com/mob-sakai/SoftMaskForUGUI/commit/767bb5b80f8e445d744c6b405f9a4a61f52b3318)), closes [#184](https://github.com/mob-sakai/SoftMaskForUGUI/issues/184) +* softmask-buffer is cleared when TMPSubMeshUI is activated via EditorGUI ([5d86379](https://github.com/mob-sakai/SoftMaskForUGUI/commit/5d8637926153e127be0ca0aa84e9d9ed68f16cd1)), closes [#180](https://github.com/mob-sakai/SoftMaskForUGUI/issues/180) +* stencil masking does not working correctly when `SoftMask` component is placed under `Mask` component ([b66fe86](https://github.com/mob-sakai/SoftMaskForUGUI/commit/b66fe862a99dd72654654b305f33b50baf2b3e1d)), closes [#183](https://github.com/mob-sakai/SoftMaskForUGUI/issues/183) +* support 'Apply display rotation during rendering' for Vulkan (experimental) ([fe586dc](https://github.com/mob-sakai/SoftMaskForUGUI/commit/fe586dc7d9cc0b643b17de5c2c2be36ce098fa3b)), closes [#171](https://github.com/mob-sakai/SoftMaskForUGUI/issues/171) +* when `UseStencilOutsideScreen = true`, objects inside `SoftMask` are not batched in the editor ([8b93959](https://github.com/mob-sakai/SoftMaskForUGUI/commit/8b93959d195c0f6209db385c449c664240dde3d2)), closes [#188](https://github.com/mob-sakai/SoftMaskForUGUI/issues/188) +* when changing resolution, display, or screen orientation, soft-masking do not work properly ([dee7271](https://github.com/mob-sakai/SoftMaskForUGUI/commit/dee7271d940d83c79260a0d3daa0e049670951a3)) + + +### Features + +* 'SoftMask.partOfParent' is now obsolete. Please use 'MaskingShape' component instead. ([380cd32](https://github.com/mob-sakai/SoftMaskForUGUI/commit/380cd322077c023dcf156af6bd301385ab7d2279)) +* (editor) use stencil outside screen in scene view for development ([611d92f](https://github.com/mob-sakai/SoftMaskForUGUI/commit/611d92f9df61c6f67456b470f48a7e20c7b963db)) +* add 'AntiAliasing' masking mode. This mode suppresses stencil-derived mask aliasing without using RenderTexture. ([fe532c6](https://github.com/mob-sakai/SoftMaskForUGUI/commit/fe532c6b2e2911f8f9a709551835b760435c6aed)) +* add 'Hide Generated Components' option in project settings ([0fc9aeb](https://github.com/mob-sakai/SoftMaskForUGUI/commit/0fc9aeb138f6d80ab10ea8d9fa270cb130972437)) +* add 'SoftMask.softMaskingRange' option ([1acb954](https://github.com/mob-sakai/SoftMaskForUGUI/commit/1acb9543c256ae0df73d055120cd13165ef43e56)) +* add a help box to the auto-generated object inspector ([5560355](https://github.com/mob-sakai/SoftMaskForUGUI/commit/556035501b1a1ff8aa05fea09b76e1bb5634b554)), closes [#175](https://github.com/mob-sakai/SoftMaskForUGUI/issues/175) +* add asset modify system to migrate from v1 to v2 ([d0e9194](https://github.com/mob-sakai/SoftMaskForUGUI/commit/d0e91944b132830e07da74e149e44b7039f3d4ba)) +* add explicit dependencies ([403e834](https://github.com/mob-sakai/SoftMaskForUGUI/commit/403e834b8222dea6235729b60fca57eb866a4eec)) +* add project settings for SoftMask ([50e9e0e](https://github.com/mob-sakai/SoftMaskForUGUI/commit/50e9e0ee0e3165413ce407f12e6e191ece5dd80e)) +* add soft-maskable shaders for TextMeshPro v3.2/v4.0 ([679acc4](https://github.com/mob-sakai/SoftMaskForUGUI/commit/679acc4138a85a1939a7abbbf22249df3e1210cc)) +* add stereo mode to shader ([48b2be1](https://github.com/mob-sakai/SoftMaskForUGUI/commit/48b2be12b714da3ab3c0af9ca187091f0d239cf8)) +* exclude unused shader variants from the build (option) ([0630a3c](https://github.com/mob-sakai/SoftMaskForUGUI/commit/0630a3cf5b4655c41723e92f74f5101988528ff1)) +* revive `SoftMask.alpha` ([b062edf](https://github.com/mob-sakai/SoftMaskForUGUI/commit/b062edf79c786f46718c59bcb8163bfe6cbc8473)), closes [#172](https://github.com/mob-sakai/SoftMaskForUGUI/issues/172) +* ShaderGraph support ([f21f2ff](https://github.com/mob-sakai/SoftMaskForUGUI/commit/f21f2ffaccf64a115aa72841aef6e37ecec8062c)), closes [#190](https://github.com/mob-sakai/SoftMaskForUGUI/issues/190) +* softmask buffers are now baked considering `Graphic.color.a` ([484adaa](https://github.com/mob-sakai/SoftMaskForUGUI/commit/484adaa20f6e53744ac8be4583d92a362c4f3c66)) +* support for shaders with `(SoftMaskable)` in the name except at the end ([cd25357](https://github.com/mob-sakai/SoftMaskForUGUI/commit/cd25357cf8db763028e5da84025feb22086a3844)) +* support uGUI 2.0.0 ([c480cef](https://github.com/mob-sakai/SoftMaskForUGUI/commit/c480cefd62a8f3949fdb0688e6bd62528539bd94)) + + +### BREAKING CHANGES + +* The implementation way of the 'SoftMaskable' shader has been changed. Please refer to the "Migrating from v1 to v2" section in the Readme for details. + # [2.3.0](https://github.com/mob-sakai/SoftMaskForUGUI/compare/v2.2.4...v2.3.0) (2024-09-05) diff --git a/Packages/src/package.json b/Packages/src/package.json index fa7c80b..4abcbce 100644 --- a/Packages/src/package.json +++ b/Packages/src/package.json @@ -2,7 +2,7 @@ "name": "com.coffee.softmask-for-ugui", "displayName": "UI Soft Mask", "description": "UI Soft Mask is a smooth masking component for Unity UI (uGUI) elements.\nBy using SoftMask instead of the default Mask component, you can beautifully represent the rounded edges of UI elements.", - "version": "2.3.0", + "version": "3.0.0", "unity": "2017.1", "license": "MIT", "repository": {