Releases: mob-sakai/SoftMaskForUGUI
3.1.1
3.1.0
3.0.1
3.0.0
3.0.0 (2024-12-01)
Bug Fixes
- fix anti-aliasing issues (e68ee7b)
Features
- add 'SOFTMASKABLE' shader feature to improve shader build (eec3212)
- asset upgrade system 'SOFTMASKABLE' shader feature (d36f932)
- MaskingShape components always use stencil mask (6c6ac59), closes #203 #209
- strip shaders using ShaderVariantCollection instead of 'Always Include Shaders' (5f4c435), closes #211
- update asset upgrade system to unregister always included shaders (906bdb6)
BREAKING CHANGES
- SoftMaskable shaders now require the
SOFTMASKABLEshader feature.
Please upgrade assets fromProject Settings > UI > Soft Maskor refer to the 'README > Usage with Your Custom Shaders' section to manually update your shaders.
🎮 Demo
⚙ Installation
This package requires Unity 2019.4 or later.
Install via OpenUPM
openupm add com.softmask-for-ugui
# or, for a specific version
openupm add com.softmask-for-ugui@3.0.0Install via UPM
"com.coffee.softmask-for-ugui": "https://github.com/mob-sakai/SoftMaskForUGUI.git?path=Packages/src",Import Additional Resources
Additional resources can be imported to extend functionality.
🔄 Upgrade All Assets For V3
If you are currently using SoftMaskForUGUI v1.x/v2.x, the following breaking changes are included when upgrading to v3:
-
(From v1) API changes: Some APIs are obsolete.
SoftMask.alpha: UseGraphic.color.ainstead.SoftMask.softness: UseSoftMask.softnessRangeinstead.SoftMask.partOfParent: UseMaskingShapecomponent instead.SoftMask.ignoreParent: Removed.SoftMask.ignoreSelfGraphic: Removed.SoftMask.ignoreSelfStencil: Removed.SoftMaskable.useStencil: Removed.SoftMaskable.raycastFilter: UseSoftMask.alphaHitTestinstead.SoftMaskable.maskInteraction: If you want to use as inverse mask, useMaskingShapecomponent and
MaskingMethod=Subtract.
-
(From v1)
SoftMaskablecomponent:SoftMaskablecomponent is no longer required to be added explicitly.- It will be added automatically at runtime as needed.
-
(From v1)
SoftMaskableshader:SoftMask()function has been updated with additional arguments.// Before color.a *= SoftMask(IN.vertex, IN.worldPosition); // After color.a *= SoftMask(IN.vertex, IN.worldPosition, color.a);
-
(From v2)
SoftMaskableshader:SOFTMASKABLEshader feature is now required.#pragma shader_feature_local _ SOFTMASKABLE
-
If you are installing via git URL, add
?path=Packages/src.// v1/v2 "com.coffee.softmask-for-ugui": "https://github.com/mob-sakai/SoftMaskForUGUI.git", // v3 "com.coffee.softmask-for-ugui": "https://github.com/mob-sakai/SoftMaskForUGUI.git?path=Packages/src",
-
Hidden/UI/SoftMask,Hidden/UI/TerminalMaskingShapeandSoftMaskableshader variants used at runtime must be
registered in the Project Settings.- In v2, the SoftMaskable shaders were included in the "Always Included Shaders", but in v3, they must be registered
automatically or manually. - You can strip unnecessary shader variants to reduce build time and file size.
- If
SoftMaskdoes not display correctly in the player, open/play the scenes or prefabs in the editor. The shader
variants will be automatically registered.
- In v2, the SoftMaskable shaders were included in the "Always Included Shaders", but in v3, they must be registered
To apply these changes automatically, please follow the steps below:
-
Click
Edit > Project Settingsto open the Project Settings window and selectUI > SoftMaskcategory. -
Click
Upgrade All Assets For V3to upgrade the assets.
⚠️ If you selectDry Run, you can check the changes before upgrading.
🚀 Usage
Getting Started
-
Add a
SoftMaskcomponent instead ofMaskcomponent.
Or, convert an existingMaskcomponent toSoftMaskcomponent from the context menu (Convert To SoftMask).
-
Adjust the soft mask parameters in the inspector.
-
(Optional) By placing the
MaskingShapecomponent underSoftMask, you can add or remove the masking region.
-
Enjoy!
