文档

Unity Engine


User Manual

Script Reference

Unity Engine


Set 3D GameObjects to interact with Sprite masks

Use Sprite masks with 3D GameObjects.
阅读时间1 分钟最后更新于 1 个月前

To allow a 3D GameObject to interact with Sprite masks, set the Mask Interaction property of the mesh renderer.

Prerequisites

Your project must be a 2D URP Project for the
Mesh Renderer

?

component to show the additional 2D > Mask Interaction property setting.

Enable Sprite mask interaction

To enable Sprite mask interaction in a Mesh Renderer or Skinned Mesh Renderer component of a 3D GameObject, follow these steps:
  1. Select the 3D GameObject.
  2. In the
    Inspector

    ?

    window, in the Mesh Renderer or Skinned Mesh Renderer component, go to the 2D > Mask Interaction section.
  3. Select either Visible Inside Mask or Visible Outside Mask to have the mesh renderer interact with a Sprite mask. Refer to the following table for the effect of each option.

Mask Interaction dropdown

Option

Description

NoneRenders without interacting with Sprite masks.
Visible Inside MaskRenders only the parts of the mesh that overlap the Sprite mask.
Visible Outside MaskRenders only the parts of the mesh that don't overlap the Sprite mask.

Examples

The following are examples of the visual effect that each option has when Unity renders the meshes with Sprite masks.

This shows two 3D cubes - one red and the other blue - are rendered on top one another when you select None and there is no sprite mask interaction. The Sprite mask is displayed as an orange circle outline.

This shows the result of selecting Visible Inside Mask. Only the area of the blue cube that overlaps the Sprite mask is rendered and visible.

This shows the result of selecting Visible Outside Mask. Only the part of the blue cube that doesn't overlap the Sprite mask is rendered and visible. A bit of the red cube is visible through blue cube where it isn't rendered.

Additional resources