diff --git a/README.md b/README.md
index a643211..14a1bdc 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
UIEffect
===
-UIEffect contains visual effect components for uGUI element in Unity.
+UIEffect provide visual effect components for uGUI element in Unity.
[](https://github.com/mob-sakai/UIEffect/releases)
[](https://github.com/mob-sakai/UIEffect/releases)
@@ -9,9 +9,7 @@ UIEffect contains visual effect components for uGUI element in Unity.
[](https://github.com/mob-sakai/UIEffect/blob/master/LICENSE.txt)
[](http://makeapullrequest.com)
-
-
-<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/UIEffect/releases) | [Usage](#usage) | [Development Note](#development-note) >>
+<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/UIEffect/releases) | [Usage](#usage) | [Example of using](#example-of-using) | [Development Note](#development-note) >>
### What's new? [See changelog ](https://github.com/mob-sakai/UIEffect/blob/develop/CHANGELOG.md)
### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/UIEffect/subscription)
@@ -33,21 +31,21 @@ AnimationClip is supported as a matter of course!
| Component | Features | Screenshot |
|-|-|-|
-|**UIEffect**|Combine some visual effects.
**ToneMode:** Grayscale, Sepia, Nega, Pixelation
**ColorMode:** Multiply, Fill, Additive, Subtract
**BlurMode:** Fast, Medium, Detail
**AdvancedBlur:** Enable more beautiful blurring|
|
-|**UICaptured EffectImage**|Capture a screenshot of a specific frame with effect, and display it.
This effect is non-realtime, light-weight, less-camera, but be effective enough.
**Tone Mode:** Grayscale, Sepia, Nega, Pixelation
**Color Mode:** Multiply, Fill, Additive, Subtract
**Blur Mode:** Fast, Medium, Detail
**Quality Mode:** Fast, Medium, Detail, Custom
**Capture On Enable:** When the component is enable, capture screen automatically.
**Blur iterations:** Number of blur iterations.
**Reduction/Downsampling Rate:** None, x1, x2, x4, x8
**Fit size to screen:** Fit RectTransform to the screen.|
|
-|**UIShiny**|Apply shinning effect to a graphic.
The effect does not require Mask component or normal map.
**Parameters:** Location, Width, Rotation, Softness, Brightness, Gloss|
|
-|**UIDissolve**|Apply dissolve effect to a graphic.
**ColorMode:** Overwrite, Additive, Subtract
**Parameters:** Location, Width, Rotation, Softness, Color|
|
-|**UIHsvModifier**|Modify HSV for graphic.
**Target:** Color, Range
**Adjustment:** Hue, Saturation, Value|
|
-|**UITransition Effect**|Apply transition effect with a single channel texture.
**EffectMode:** Cutoff, Fade|
|
+|**UIEffect**|Combine some visual effects.
**Effect Mode:** Grayscale, Sepia, Nega, Pixelation
**Color Mode:** Multiply, Fill, Additive, Subtract
**Blur Mode:** Fast, Medium, Detail
**Advanced Blur:** Enable more beautiful blurring.|
|
+|**UICaptured EffectImage**|Capture a screenshot of a specific frame with effect, and display it.
This effect is non-realtime, light-weight, less-camera, but be effective enough.
**Effect Mode:** Grayscale, Sepia, Nega, Pixelation
**Color Mode:** Multiply, Fill, Additive, Subtract
**Blur Mode:** Fast, Medium, Detail
**Quality Mode:** Fast, Medium, Detail, Custom
**Capture On Enable:** When the component is enable, capture screen automatically.
**Blur iterations:** Number of blur iterations.
**Reduction/Downsampling Rate:** None, x1, x2, x4, x8
**Fit size to screen:** Fit RectTransform to the screen on captured.
**Immediate Capturing:**
*NOTE: This component can be used with UIEffect, UITransition etc.*
*NOTE: Immediate capturing does not support LWRP, WebGL and Unity 5.x for iOS/Mac.*|
|
+|**UIShiny**|Apply shining effect to a graphic.
The effect does not require Mask component or normal map.
**Parameters:** Effect factor, Width, Rotation, Softness, Brightness, Gloss
**Effect Player:** To play shining, enable `Play` in inspector or call `Play()` from script.|
|
+|**UIDissolve**|Apply dissolve effect to a graphic.
**Color Mode for edge:** Multiply, Fill, Additive, Subtract
**Parameters:** Effect factor, Width, Rotation, Softness, Edge color
**Options:** Effect area, Keep effect aspect ratio
**Effect Player:** To play dissolving, call `Play()` from script.|
|
+|**UIHsvModifier**|Modify HSV for graphic.
**Target:** Color, Range
**Adjustment:** Hue, Saturation, Value|
|
+|**UITransition Effect**|Apply transition effect with a single channel texture.
**Effect Mode:** Cutoff, Fade, Dissolve
**Options:** Effect area, Keep effect aspect ratio, transition texture
**Pass Ray On Hidden:** Disable the graphic's raycastTarget on hidden.
**Effect Player:** To show/hide transition, call `Show()/Hide()` from script.|
|
##### The following effects can be used with the above components.
| Component | Features | Screenshot |
|-|-|-|
-|**UIShadow**|Add shadow/outline to a graphic.
The performance is better than the default Shadow/Outline component.
**ShadowStyle:** Shadow, Shadow3, Outline, Outline8|
|
-|**UIGradient**|Change vertex color as gradient with angle and offset.
**Direction:** Horizontal, Vertical, Angle, Diagonal
**Options:** Offset, Color space|
|
-|**UIFlip**|Flip a graphic.
**Direction:** Horizontal, Vertical, Both|
|
+|**UIShadow**|Add shadow/outline to a graphic.
The performance is better than the default Shadow/Outline component.
**ShadowStyle:** Shadow, Shadow3, Outline, Outline8|
|
+|**UIGradient**|Change vertex color as gradient with angle and offset.
**Direction:** Horizontal, Vertical, Angle, Diagonal
**Options:** Offset, Color space|
|
+|**UIFlip**|Flip a graphic.
**Direction:** Horizontal, Vertical, Both|
|
@@ -69,10 +67,15 @@ AnimationClip is supported as a matter of course!
## Usage
1. Download UIEffect.unitypackage from [Releases](https://github.com/mob-sakai/UIEffect/releases).
-2. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
-3. In Unity5.6+, enable `TexCoord1` channel of canvas. See also [Development Note](##note-unity-56).
-4. Add any effect component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector.
-5. Enjoy!
+2. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
+
+3. In Unity5.6+, enable `TexCoord1` channel of canvas. See also [Development Note](##note-unity-56).
+
+4. Add any effect component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector or `Component > UI > UIEffect > ...` menu.
+
+6. Adjust the parameters of the effect as you like, in inspector.
+
+7. Enjoy!
##### Requirement
@@ -86,17 +89,17 @@ AnimationClip is supported as a matter of course!
## Example of using
-| Title | Description | Screenshot |
+| Case | Description | Screenshot |
|-|-|-|
-|Lock/unlock contents|Use UIEffect for grayscale.
Indicate to user that the content is unavailable.||
-|Silhouette|Use UIEffect for filling color.||
-|Soft shadow(outer glow)|Use UIEffect and UIShadow for blurring shadow.
To blur only shadow, set `Blur Factor` to 0.||
-|Colored shadow|Use UIEffect and UIShadow for filling colored shadow.
To fill color only shadow, set `Color Factor` to 0.||
-|Blurred dynamic text|Use UIEffect for blurring.
To blur dynamic font cleanly, enable `Advanced Blur` option.||
-|Text with outline & shadow|Use two UIShadow for outline and shadow.
There is less overdraw than default Outline/Shadow `(Default: 1 x 5 x 2 = 10 draw calls, UIShadow: 4 + 1 = 5 draw calls)`.||
-|Shinning button|Use UIShiny for shinning button.
Shine the button and indicate to user that you can press the button.
Enable `Play On Enable` and `Loop` option to shine it without any AnimationClip.||
-|Blurring the background of a menu|Use UIEffectCapturedImage to blur the background of a menu.
UIEffectCapturedImage applies an effect to the screen of the previous frame, without adding a camera or layer.
It's not a real-time post effect, so it's good performance and works well on mobile.||
-|Screen transition|Use UITransitionEffect to create screen transition.
You can change transition texture (single channel texture).||
+|Lock/unlock contents|Use UIEffect to apply grayscale.
Indicate to user that the content is unavailable.||
+|Silhouette|Use UIEffect for filling color.||
+|Soft shadow/
Outer glow|Use UIEffect and UIShadow to blur the shadow.
To blur only shadow, set `Blur Factor` in UIEffect to 0.||
+|Colored shadow|Use UIEffect and UIShadow to fill shadow with color.
To fill only shadow, set `Color Factor` in UIEffect to 0.||
+|Blurred dynamic font|Use UIEffect to blur text.
To blur dynamic font cleanly, enable `Advanced Blur` option.||
+|Text with outline & shadow|Use two UIShadows to add outline and shadow.
There is less overdraw than default Outline/Shadow `(Default: 1 x 5 x 2 = 10 overdraws, UIShadow: 1 + 4 + 1 = 6 overdraws)`.||
+|Shining button|Use UIShiny for shining button.
Shine the button and indicate to user that you can press the button.
Enable `Play` and `Loop` option to shine it without any AnimationClip.||
+|Blurring the background of a menu|Use UIEffectCapturedImage to blur the background of a menu.
UIEffectCapturedImage applies an effect to the screen of the previous frame, without adding a camera or layer.
It's not a real-time post effect, so it's good performance and works well on mobile.||
+|Screen transition|Use UITransitionEffect to add screen transition.
You can change transition texture (single channel texture).
Enable `Pass Ray On Hidden` option and use `Show()/Hide()` method to play transition without AnimationClip.||