SoftMaskForUGUI 使用教程

1. 项目介绍

SoftMaskForUGUI 是一个用于 Unity UI (uGUI) 的平滑遮罩组件。通过使用 SoftMask 而不是默认的 Mask，可以更好地表达 UI 元素的圆角边缘。该项目提供了丰富的功能，包括但不限于：

• 兼容现有的 Mask 组件。
• 可调整可见部分。
• 支持文本、图像和 RawImage 作为遮罩。
• 支持多层嵌套遮罩。
• 支持滚动视图。
• 支持反向遮罩。
• 支持覆盖、相机空间和世界空间。
• 包含软遮罩可用的 UI 着色器。
• 支持在自定义着色器中添加软遮罩功能。

2. 项目快速启动

安装

使用 UnityPackageManager (适用于 Unity 2018.3+)

编辑项目中 Packages 文件夹下的 manifest.json 文件，添加以下内容：

{
  "dependencies": {
    "com.coffee.softmask-for-ugui": "https://github.com/mob-sakai/SoftMaskForUGUI.git#0.8.1"
  }
}

使用 .unitypackage 文件 (适用于 Unity 2017.1+)

从 Releases 下载 *.unitypackage 文件，并导入到你的 Unity 项目中。

使用

1. 在 Unity 中创建一个新的 UI 元素（例如 Image）。
2. 删除默认的 Mask 组件，并添加 SoftMask 组件。
3. 在 SoftMask 组件下添加需要遮罩的子 UI 元素。
4. 调整 SoftMask 的参数，如 Softness 和 Desampling Rate。

// 示例代码：获取 SoftMask 组件并设置参数
var softMask = gameObject.GetComponent<SoftMask>();
softMask.softness = 0.5f;
softMask.desamplingRate = SoftMask.DownSamplingRate.x2;

3. 应用案例和最佳实践

案例1：圆角图像

使用 SoftMask 可以轻松创建带有圆角边缘的图像。通过调整 Softness 参数，可以控制圆角的平滑度。

案例2：嵌套遮罩

在复杂的 UI 设计中，可能需要多个嵌套的遮罩。SoftMask 支持多达 4 层的嵌套遮罩，可以实现复杂的视觉效果。

最佳实践

• 性能优化：通过调整 Desampling Rate 参数，可以在性能和视觉效果之间找到平衡。
• 自定义着色器：如果需要支持自定义着色器，可以在着色器中添加 SoftMask 支持，具体方法请参考项目文档。

4. 典型生态项目

TextMeshPro 支持

SoftMaskForUGUI 支持 TextMeshPro，可以通过导入额外的着色器来实现对 TextMeshPro 的支持。

ShaderGraph 支持

对于使用 ShaderGraph 的项目，SoftMaskForUGUI 提供了 ShaderGraph 的支持，可以通过导入示例来实现自定义着色器的软遮罩效果。

通过以上步骤，你可以快速上手并使用 SoftMaskForUGUI 来增强你的 Unity UI 项目。