Update Readme

This commit is contained in:
Takashi Sakai
2017-08-17 12:34:17 +09:00
parent dc20b8ca91
commit cfa3a10e3d
4 changed files with 93 additions and 135 deletions
+90
View File
@@ -0,0 +1,90 @@
UIEffect
===
Easy to use effects for uGUI. Supports following effects.
* Grayscale tone
* Sepia tone
* Nega tone
* Pixelation
* Cutoff (alpha-based)
* Mono tone (alpha-based)
* Color setting
* Color additive
* Color subtract
* Blur fast
* Blur detail
![demo](https://user-images.githubusercontent.com/12690315/29394440-3479d624-8345-11e7-8b1d-68d35e4a20de.gif)
## Requirement
* Unity 5.3+ *(included Unity 2017.x)*
* No other SDK are required
## Usage
1. Download [UIEffect.unitypackage](https://github.com/mob-sakai/UIEffect/raw/master/UIEffect.unitypackage) and install to your project.
1. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
1. Add `UIEffect` component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector.
1. Choose effect type and adjust values in inspector.
![image](https://user-images.githubusercontent.com/12690315/28405920-56fa5d96-6d69-11e7-9aaa-832cfecc72c6.png)
1. Enjoy!
## Note: Unity 5.6+
In Unity 5.6+, Canvas supports **Additional Shader Channels**.
Please enable `TexCoord1` to use UIEffect.
![image](https://user-images.githubusercontent.com/12690315/28405830-f4f261e8-6d68-11e7-9faf-7e5442062f59.png)
## Demo
[WebGL Demo](https://developer.cloud.unity3d.com/share/W1fv8sYS9f/)
## Release Notes
### ver.1.1.0
* Feature: Add Pixelaration effect.
* Feature: Add Cutoff/Mono effect for patterned alpha images. It can be used for masks and transitions!
### ver.1.0.0
* Feature: Shader supports pre-processer macros (for example UNITY_VERTEX_OUTPUT_STEREO) for Unity 5.3.x, 5.4.x and 5.5.x.
* Feature: Supports changing value from animation.
* Feature: Supports Tone effect.
* grayscale
* sepia
* nega
* Feature: Supports Color effect.
* set
* add
* sub
* Feature: Supports Blur effect.
* fast
* detail
* Fix: Color effect will not be properly when it was rotated.
* Performance: Shader supports multi-compile for performance.
* Performance: Cache same effect materials to reduce draw calls.
* Improve: Supports mobile devices.
* Improve: Simplify component & inspector.
## License
MIT
## Author
[mob-sakai](https://github.com/mob-sakai)
@@ -1,8 +1,8 @@
fileFormatVersion: 2
guid: 2073fb2b473bd410290c57f17e417e80
timeCreated: 1487921217
guid: ddc08462bf3e14c82929e462ff7823e7
timeCreated: 1502939317
licenseType: Pro
TextScriptImporter:
DefaultImporter:
userData:
assetBundleName:
assetBundleVariant:
-66
View File
@@ -1,66 +0,0 @@
UIEffect
===
Composite Effect for uGUI.
![](http://mob-sakai.github.io/UIEffect/images/demo.gif)
![](http://mob-sakai.github.io/UIEffect/images/inspector.png)
## Requirement
* Unity 5.3+
* No other SDK are required.
## Usage
1. Download the package from [releases](https://github.com/mob-sakai/UIEffect/releases).
1. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
1. Add `UIEffect` component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector.
1. Enjoy!
## Demo
[WebGL Demo](https://mob-sakai.github.io/UIEffect/demo/)
[WebGL Performance Test](https://mob-sakai.github.io/UIEffect/performance_test/)
## Release Notes
### ver.1.0.0
* Feature: Shader supports pre-processer macros (for example UNITY_VERTEX_OUTPUT_STEREO) for Unity 5.3.x, 5.4.x and 5.5.x.
* Feature: Supports changing value from animation (for Unity 5.4+).
* Feature: Supports Tone effect.
* grayscale
* sepia
* nega
* Feature: Supports Color effect.
* set
* add
* sub
* Feature: Supports Blur effect.
* fast
* detail
* Fix: Color effect will not be properly when it was rotated.
* Performance: Shader supports multi-compile for performance.
* Performance: Cache same effect materials to reduce draw calls.
* Improve: Supports mobile devices.
* Improve: Simplify component & inspector.
## License
MIT
## Author
[mob-sakai](https://github.com/mob-sakai)
-66
View File
@@ -1,66 +0,0 @@
UIEffect
===
Composite Effect for uGUI.
![](http://mob-sakai.github.io/UIEffect/images/demo.gif)
![](http://mob-sakai.github.io/UIEffect/images/inspector.png)
## Requirement
* Unity 5.3+
* No other SDK are required.
## Usage
1. Download the package from [releases](https://github.com/mob-sakai/UIEffect/releases).
1. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
1. Add `UIEffect` component to UI element (Image, RawImage, Text, etc...) from `Add Component` in inspector.
1. Enjoy!
## Demo
[WebGL Demo](https://mob-sakai.github.io/UIEffect/demo/)
[WebGL Performance Test](https://mob-sakai.github.io/UIEffect/performance_test/)
## Release Notes
### ver.1.0.0
* Feature: Shader supports pre-processer macros (for example UNITY_VERTEX_OUTPUT_STEREO) for Unity 5.3.x, 5.4.x and 5.5.x.
* Feature: Supports changing value from animation (for Unity 5.4+).
* Feature: Supports Tone effect.
* grayscale
* sepia
* nega
* Feature: Supports Color effect.
* set
* add
* sub
* Feature: Supports Blur effect.
* fast
* detail
* Fix: Color effect will not be properly when it was rotated.
* Performance: Shader supports multi-compile for performance.
* Performance: Cache same effect materials to reduce draw calls.
* Improve: Supports mobile devices.
* Improve: Simplify component & inspector.
## License
MIT
## Author
[mob-sakai](https://github.com/mob-sakai)