diff --git a/README.md b/README.md index b9c7217..46a0c39 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ Particle Effect For UGUI (UI Particle) === -**:warning: NOTE: Do not use [the obsolete tags and branches](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/108) to reference the package. They will be removed in near future. :warning:** - This plugin provide a component to render particle effect for uGUI in Unity 2018.2 or later. The particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas. @@ -30,26 +28,35 @@ This plugin uses new APIs `MeshBake/MashTrailBake` (added with Unity 2018.2) to You can mask and sort particles for uGUI without Camera, RenderTexture, Canvas. Compares this "Baking mesh" approach with the conventional approach: -(This scene is included in the package.) +[Performance test results](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/193#issuecomment-1160028374) |Approach|Good|Bad|Screenshot| |-|-|-|-| -|Baking mesh
**\(UIParticle\)**|Rendered as is.
Maskable.
Sortable.
Less objects.|**Requires Unity 2018.2 or later.**
Requires UI shaders to use Mask.|| +|Baking mesh
**\(UIParticle\)**|Rendered as is.
Maskable.
Sortable.
Less objects.|[Not support `TEXCOORD*.zw` components for custom vertex stream](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191#issuecomment-1043409186)|| |Do nothing|Rendered as is.|**Looks like a glitch.**
Not maskable.
Not sortable.|| |Convert particle to UIVertex
[\(UIParticleSystem\)](https://forum.unity.com/threads/free-script-particle-systems-in-ui-screen-space-overlay.406862/)|Maskable.
Sortable.
Less objects.|**Adjustment is difficult.**
Requires UI shaders.
Difficult to adjust scale.
Force hierarchy scalling.
Simulation results are incorrect.
Trail, rotation of transform, time scaling are not supported.
Generate heavy GC every frame.|| |Use Canvas to sort|Rendered as is.
Sortable.|**You must to manage sorting orders.**
Not maskable.
More batches.|| |Use RenderTexture|Maskable.
Sortable.|**Requires Camera and RenderTexture.**
Difficult to adjust position and size.
Quality depends on the RenderTexture's setting.|| +|Approach|FPS on Editor|FPS on iPhone6|FPS on Xperia XZ| +|--|--|--|--| +|Particle System|43|57|22| +|UIParticleSystem|4|3|0 (unmeasurable)| +|Sorting By Canvas|43|44|18| +|UIParticle|17|12|4| +|UIParticle with MeshSharing|44|45|30| + +

#### Features * Easy to use: the package is out-of-the-box -* Sort particle effects with UI +* Sort particle effects and UI by sibling index * No Camera, RenderTexture or Canvas are required -* Masking with Mask or RectMask2D +* Masking by Mask or RectMask2D * Support Trail module -* Change alpha with CanvasGroup -* No heavy allocation every frame +* Support CanvasGroup alpha +* No allocations * Support overlay, camera space and world space * Support changing material property with AnimationClip (AnimatableProperty) ![](https://user-images.githubusercontent.com/12690315/53286323-2d94a980-37b0-11e9-8afb-c4a207805ff2.gif)