/Unity-SpriteAssist

Unity Sprite Mesh Extension

Primary LanguageC#

Unity-SpriteAssist

image

image

About

Unity-SpriteAssist is an Unity extension that assist Sprite's mesh creation more conveniently.

System Requirements

Unity 2019.4 or later versions

Features

  • Dynamic preview
  • Make a transparent, opaque, complex(transparent + opaque) mesh
  • Convert Sprite to MeshRenderer Prefab

Installation

Unity Package Manager

You can add https://github.com/sr4dev/Unity-SpriteAssist.git?path=Assets/SpriteAssist to Package Manager. image

Manual installation

Clone or download this repository and copy Assets/SpriteAssist folder to your Unity project.

How to use

  • Select a Sprite asset in the Project window.
  • Check the Enable SpriteAssist on the Inspector window.
  • Adjust Mode and parameters.

Mode

image

  • Transparent Mesh: Default Mode. Allow alpha pixel.
  • Opaque Mesh: Disallow alpha pixel. You can use the mesh for opaque shader.
  • Complex: Separate area by alpha.
    • Alpha pixel is converted to Transparent Mesh area.
    • Non-alpha pixel is converted to Opaque Mesh area.
    • To Use Complex mode must be created Mesh Prefab.
    • Complex mode dose not override original Sprite mesh.

Parameter

image

  • Detail: Density and accuracy of the mesh to the Sprite outline.
  • Alpha Tolerance: Threshold for transparency considered when generating the outline.
  • Detect Holes: Detect holes from outline.
  • Edge Smoothing: Smoothing sharp edges.
  • Non-zero Winding: Use Non-zero winding rule. Default Winding rule is even-odd.

Even-odd(left), Non-zero(right)

image

Wikipedia: Non-zero winding

Mesh Prefab

image

  • Prefab: Linked Prefab with Sprite.
  • Create/Remove: Create or remove a Prefab.
  • Default Transparent Shader
  • Default Opaque Shader

Warning!

userData

This extension uses AssetImporter.userData of Texture asset. If your project already uses userData, it will be overridden.

Unity Document: AssetImporter.userData

License

MIT License

Library