README.md

ShinyEffectForUGUI

NOTE: This project has been integrated into UIEffect, so we are NOT continuing development in this repository.

Shiny effect of uGUI, which does not need mask or normal map.
Since useless draw calls are suppressed, performance is good!

<< Description | Demo | Download | Usage | Development Note | Change log >>

Description

ShinyEffectForUGUI applies shiny-effect to uGUI element (Image, RawImage, Text, etc...) WITHOUT Mask component .
This will suppress extra draw calls and improve performance.

• With-mask method

  • For example: ShineEffect from unity-ui-extensions
  • 3 GameObject: Graphic + Mask + ShineEffect (masked)
    • 
  • At least 3 draw calls(1:Stencil on, 2:Draw graphic, 3:Stensil off), FOR EACH ui elements with shiny effect
  • Artifacts on the edges!

• Proposal: Without-mask method

  • shader applies shiny effect
  • 1 draw dall
  • Will be batched as possible

Features

• No Mask component
• Easy to control in inspector
  
• Supports AnimationClip
• Will be batched as possible
• Play effect from script (v0.4.0)
  • ShinyEffectForUGUI.Play(duration, updateMode)
    
• Improve Visual quality (v0.4.0)
  
  • The effect does not use other images such as normal map.

Demo

WebGL Demo

Usage

1. Download ShinyEffectForUGUI.unitypackage from Releases.
2. Import the package into your Unity project. Select Import Package > Custom Package from the Assets menu.
3. Add ShinyEffectForUGUI component to UI element (Image, RawImage, Text, etc...) from Add Component in inspector.
4. Choose effect type and adjust values in inspector.
5. Enjoy!

Requirement

• Unity 5.5+ (included Unity 2017.x)
• No other SDK are required

Development Note

What's doing?

• Control effect parameters for uGUI element WITHOUT MaterialPropertyBlock
  • https://github.com/mob-sakai/UIEffect#how-to-control-effect-parameters-for-ugui-element-without-materialpropertyblock
• Directivity normalization
  • Likely Vector2.Product()
• Linear shiny effect

License

• MIT
• © UTJ/UCL

Author

mob-sakai

See Also

• GitHub page : https://github.com/mob-sakai/ShinyEffectForUGUI
• Releases : https://github.com/mob-sakai/ShinyEffectForUGUI/releases
• Issue tracker : https://github.com/mob-sakai/ShinyEffectForUGUI/issues
• Current project : https://github.com/mob-sakai/ShinyEffectForUGUI/projects/1
• Change log : https://github.com/mob-sakai/ShinyEffectForUGUI/blob/master/CHANGELOG.md