Sprite Shape Renderer
The Sprite Shape Renderer component renders the geometry that Unity generates along a Spline and controls how it visually appears in a SceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary for both 2D and 3D projects. Its inputs are derived from the Sprite Shape Profile.
Properties
| Property | Function |
|---|---|
| Color | Define the vertex color of the SpriteA 2D graphic objects. If you are used to working in 3D, Sprites are essentially just standard textures but there are special techniques for combining and managing sprite textures for efficiency and convenience during development. More info See in Glossary Shape geometry, which tints or recolors the Sprite Shape. Use the color picker to set the vertex. See the Color section below this table for examples. |
| Mask Interaction | Set how the Sprite RendererA component that lets you display images as Sprites for use in both 2D and 3D scenes. More info See in Glossary behaves when it interacts with a Sprite MaskA texture which defines which areas of an underlying image to reveal or hide. More info See in Glossary . See examples of the different options in the Mask Interaction section below. |
| None | The Sprite Shape Renderer does not interact with any Sprite Masks in the Scene. This is the default option. |
| Visible Inside Mask | The Sprite Shape is visible where the Sprite Mask overlays it, but not outside of it. |
| Visible Outside Mask | The Sprite Shape is visible outside of the Sprite Mask, but not inside it. The Sprite Mask hides the sections of the Sprite Shape it overlays. |
| Sorting Layer | Set the Sorting Layer of the Sprite Shape geometry, which controls its priority during renderingThe process of drawing graphics to the screen (or to a render texture). By default, the main camera in Unity renders its view to the screen. More info See in Glossary. Select an existing Sorting Layer from the drop-down box, or create a new Sorting Layer. |
| Order In Layer | Set the render priority of the Sprite Shape within its Sorting Layer. Lower numbered Sprite Shapes are rendered first, with higher numbered Sprite Shapes overlapping those below. |
Details
Color
The examples below show what happens when you change the RGB values on the Sprite Shape Renderer’s Color setting. To change a Sprite Shape’s opacity, change the value of the Alpha (A) channel, where lower values make the Sprite appear more transparent and higher values make the Sprite appear more opaque.
Fill Material and Edge Material
Use a Material’s Material and Shader settings to control how Unity renders Fill and Edge geometries. The default Material for a new Sprite Shape is ‘Sprites - Default’. Scene lighting does not affect this default Sprite Shape. To make the Sprite react to lighting, assign the Material ‘Default - Diffuse’ instead. To do this, click the small circle next to the Material field to bring up the Object Picker window, and select the ‘Default-Diffuse’ Material. Refer to Materials, Shaders & Textures for more information on these settings.
Mask Interaction
Mask Interaction controls how the Sprite Shape Renderer interacts with Sprite Masks. Select either Visible Inside Mask or Visible Outside Mask from the Mask Interaction drop-down menu. The examples below show the effect of either option:
