mirror of
https://github.com/mob-sakai/UIEffect.git
synced 2026-11-19 17:22:37 +08:00
docs: update
This commit is contained in:
@@ -18,7 +18,7 @@ MonoBehaviour:
|
||||
m_EnabledInEditor: 1
|
||||
m_AlwaysIncludeAssembly: 1
|
||||
m_InstantiateOnLoad: 1
|
||||
m_Prefab: {fileID: 7211429669315726685, guid: 78a484d8074c74e9c80786d1e55962c8,
|
||||
m_Prefab: {fileID: 4567906826058368312, guid: 7cebff2d255b9433cbe23b243c193329,
|
||||
type: 3}
|
||||
m_Interval: 0.5
|
||||
m_Anchor: 0
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"com.coffee.development": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/Development",
|
||||
"com.coffee.minimal-resource": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/MinimalResource",
|
||||
"com.coffee.nano-monitor": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
|
||||
"com.unity.ide.rider": "3.0.34",
|
||||
"com.unity.test-framework": "1.1.33",
|
||||
|
||||
@@ -7,6 +7,13 @@
|
||||
"dependencies": {},
|
||||
"hash": "5d0bd14be288153555f975240608e7ee1576b091"
|
||||
},
|
||||
"com.coffee.minimal-resource": {
|
||||
"version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/MinimalResource",
|
||||
"depth": 0,
|
||||
"source": "git",
|
||||
"dependencies": {},
|
||||
"hash": "52987fb6e66e7fc48498d8d164c3c8808de4de6b"
|
||||
},
|
||||
"com.coffee.nano-monitor": {
|
||||
"version": "https://github.com/mob-sakai/Coffee.Internal.git?path=Packages/NanoMonitor",
|
||||
"depth": 0,
|
||||
|
||||
+77
-17
@@ -19,8 +19,8 @@
|
||||
|
||||
## 📝 Description <!-- omit in toc -->
|
||||
|
||||
**_"Decorate your uGUI, simply and powerfully."_**
|
||||
UIEffect is an open-source package that allows you to intuitively apply rich UI effects directly from the Inspector or via code.
|
||||
**_"Decorate your UI, simply and powerfully."_**
|
||||
UIEffect is an open-source package that allows you to intuitively apply rich Unity UI effects directly from the Inspector or via code.
|
||||
Combine various filters, such as grayscale, blur, and dissolve, to decorate your UI with a unique visual style!
|
||||
|
||||

|
||||
@@ -56,7 +56,7 @@ Combine various filters, such as grayscale, blur, and dissolve, to decorate your
|
||||
|
||||
## 📌 Key Features
|
||||
|
||||

|
||||

|
||||
|
||||
- **UIEffect is out-of-the-box!**: Easily apply effects by adjusting parameters directly in the inspector.
|
||||
- **Rich effect combinations**: Decorate your UI with a variety of effects, such as grayscale, blur, and dissolve, by combining multiple filters and parameters.
|
||||
@@ -73,7 +73,7 @@ Combine various filters, such as grayscale, blur, and dissolve, to decorate your
|
||||
|
||||
## 🎮 Demo
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[WebGL Demo](https://mob-sakai.github.io/UIEffect/)
|
||||
@@ -86,7 +86,7 @@ _This package requires **Unity 2020.3 or later**._
|
||||
|
||||
### Install via OpenUPM
|
||||
|
||||
- This package is available on [OpenUPM](https://openupm.com) package registry.
|
||||
- This package is available on [OpenUPM](https://openupm.com/packages/com.coffee.ui-effect/) package registry.
|
||||
- This is the preferred method of installation, as you can easily receive updates as they're released.
|
||||
- If you have [openupm-cli](https://github.com/openupm/openupm-cli) installed, then run the following command in your project's directory:
|
||||
```
|
||||
@@ -183,71 +183,131 @@ If upgrading from UIEffect v4 to v5, note the following breaking changes:
|
||||
|
||||
### Component: UIEffect
|
||||
|
||||

|
||||

|
||||
|
||||
The `UIEffect` component applies visual effects to UI elements, allowing various effects to be achieved by combining multiple filters.
|
||||
|
||||
#### Tone Filter
|
||||
|
||||
- **Tone Filter**: `None`, `Grayscale`, `Sepia`, `Nega`, `Retro`, `Posterize`
|
||||
- **Tone Intensity**: 0.0 (no effect) - 1.0 (full effect).
|
||||
|
||||
#### Color Filter
|
||||
|
||||
- **Color Filter**: `None`, `Multiply`, `Additive`, `Subtractive`, `Replace`, `Multiply Luminance`, `Multiply Additive`, `Hsv Modifier`, `Contrast`
|
||||
- **Color Intensity**: 0.0 (no effect) - 1.0 (full effect).
|
||||
- **Color Glow**: Set the color to glow.
|
||||
|
||||
#### Sampling Filter
|
||||
|
||||
- **Sampling Filter**: `None`, `Blur Fast`, `Blur Medium`, `Blur Detail`, `Pixelation`, `Rgb Shift`, `Edge Luminescence`, `Edge Alpha`
|
||||
- **Sampling Intensity**: 0.0 (no effect) - 1.0 (full effect).
|
||||
- **Sampling Scale**: The referencing scale during sampling.
|
||||
- Larger values are suitable for high-resolution textures.
|
||||
|
||||
#### Transition Filter
|
||||
|
||||
- **Transition Filter**: `None`, `Fade`, `Cutoff`, `Dissolve`, `Shiny`, `Mask`, `Melt`, `Burn`
|
||||
- **Transition Rate**: 0.0 (no effect) - 1.0 (full effect).
|
||||
- **Transition Tex**: The texture used for the transition filter.- **Transition Width**: The width where the transition color is applied.
|
||||
- **Transition Softness**: The softness of the boundary for the transition color.
|
||||
- **Transition Color Filter/Transition Color**: Specifies the transition color.
|
||||
- **Transition Color Filter**: Specifies the transition color.
|
||||
- **Transition Color**: The color of the transition.
|
||||
- **Transition Color Glow**: Set the transition color to glow.
|
||||
|
||||
#### Target Mode
|
||||
|
||||
- **Target Mode**: `None`, `Hue`, `Luminance`
|
||||
- Restricts the effect application area based on hue or luminance.
|
||||
- **Target Range**: The range of target hue or luminance.
|
||||
- **Target Softness**: The softness of the target boundary.
|
||||
- **Blend Type**: `Alpha Blend`, `Multiply`, `Additive`, `Soft Additive`, `Multiply Additive`, `Custom (SrcBlend, DstBlend)`
|
||||
|
||||
#### Blend Type
|
||||
|
||||
- **Blend Type**: `Alpha Blend`, `Multiply`, `Additive`, `Soft Additive`, `Multiply Additive`, `Custom`
|
||||
- `Custom` blend type can be set using the `SrcBlend` and `DstBlend` properties.
|
||||
|
||||
#### Shadow Mode
|
||||
|
||||
- **Shadow Mode**: `None`, `Shadow`, `Shadow3`, `Outline`, `Outline8`, `Mirror`
|
||||
- **Shadow Distance**: Distance of the shadow or outline.
|
||||
- **Shadow Iteration**: Number of times the shadow or outline is applied.
|
||||
- **Shadow Color Filter**: Specifies the shadow color.
|
||||
- **Shadow Color**: The color of the shadow.
|
||||
- **Shadow Color Glow**: Set the shadow color to glow.
|
||||
- **Shadow Fade**: Alpha value of the shadow or outline.
|
||||
- **Shadow Effect On Origin**: Applies effects to meshes other than shadows.
|
||||
- **Shadow Blur Intensity**: Intensity of the shadow or outline blur.
|
||||
- **Mirror Reflection**: Distance of the mirrored image.
|
||||
- **Mirror Offset**: Offset for the mirrored image.
|
||||
- **Mirror Scale**: Scale of the mirrored image.
|
||||
|
||||
#### Gradation Mode
|
||||
|
||||
- **Gradation Mode**: `None`, `Horizontal Gradient`, `Horizontal`, `Vertical Gradient`, `Vertical`, `Radial Fast`, `Radial Detail`, `Diagonal To Right Bottom`, `Diagonal To Right Top`, `Diagonal To Left Bottom`, `Angle`, `Angle Gradient`
|
||||
- **Gradation Gradient**: The gradient of the gradation.
|
||||
- **Gradation Color 1**: The first color of the gradation.
|
||||
- **Gradation Color 2**: The second color of the gradation.
|
||||
- **Gradation Offset**: The offset of the gradation range.
|
||||
- **Gradation Scale**: The scale of the gradation range.
|
||||
- **Gradation Rotation**: The rotation of the gradation range.
|
||||
|
||||
> [!TIP]
|
||||
> `Horizontal Gradient` and `Vertical Gradient` divide the mesh horizontally or vertically and apply a gradient.
|
||||
> This is very fast but only supports Full Rect.
|
||||
> `Angle Gradient` divides the mesh at the specified angle and applies a gradient.
|
||||
> It can be applied to meshes other than Full Rect because it applies the gradient according to the original mesh shape.
|
||||
|
||||
#### Others
|
||||
|
||||
- **Allow To Modify Mesh Shape**: If enabled, the mesh shape can be modified.
|
||||
|
||||
<br><br>
|
||||
|
||||
### Component: UIEffectTweener
|
||||
|
||||

|
||||

|
||||
|
||||
The `UIEffectTweener` component animates the effect, enabling easy control over effect animations without the need for an `AnimationClip`.
|
||||
|
||||
- **Culling Mask**: `Tone`, `Color`, `Sampling`, `Transition`
|
||||
- **Direction**: `Forward (0.0 -> 1.0)`, `Backward (1.0 -> 0.0)`
|
||||
- **Direction**: `Forward (0.0 -> 1.0)`, `Reverse (1.0 -> 0.0)`
|
||||
- **Curve**: The curve of the animation.
|
||||
- **Delay**: The delay time before starting the animation.
|
||||
- **Duration**: The duration of the animation.
|
||||
- **Interval**: The interval time between the animation.
|
||||
- **Curve**: The curve of the animation.
|
||||
- **Restart On Enable**: Play the animation automatically when the component is enabled.
|
||||
- **Play On Enable**: `None`, `Forward`, `Reverse`, `Keep Direction`
|
||||
- Play the animation automatically when the component is enabled.
|
||||
- If `None` is selected, the animation will not play automatically. You can play it using the `Play`, `PlayForward` or `PlayReverse` method.
|
||||
- **Wrap Mode**: `Once`, `Loop`, `PingPongOnce`, `PingPongLoop`
|
||||
- **Update Mode**: `Normal`, `UnscaledTime`, `Manual`
|
||||
- **On Complete**: A event that is triggered when the animation is completed.
|
||||
|
||||
You can preview the animation using the seek bar and play button.
|
||||
|
||||
<br><br>
|
||||
|
||||
### Component: UIEffectReplica
|
||||
|
||||

|
||||

|
||||
|
||||
The `UIEffectReplica` component applies visual effects to UI elements by replicating the settings of another `UIEffect` component. This allows the same effect to be applied across multiple UI elements simultaneously.
|
||||
|
||||
- **Target**: The target `UIEffect` component to replicate.
|
||||
- **Use Target Transform**: Use the target's transform for some effects.
|
||||
- **Use Target Transform**: Use the target's transform for some effects.
|
||||
- **Sampling Scale**: Override the sampling scale.
|
||||

|
||||
|
||||
<br><br>
|
||||
|
||||
### Usage with TextMeshPro
|
||||
|
||||

|
||||
To use UIEffect with TextMeshPro, you need to import additional resources.
|
||||
When a shader included in the samples is requested, an import dialog will automatically appear.
|
||||
Click the `Import` button.
|
||||
|
||||
UIEffect supports TextMeshProUGUI elements. To use UIEffect with TextMeshPro, follow these steps:
|
||||

|
||||
|
||||
Alternatively, you can manually import the resources by following these steps:
|
||||
|
||||
1. First, you must import [TMP Essential Resources](https://docs.unity3d.com/Packages/com.unity.textmeshpro@3.0/manual/index.html#installation) before using.
|
||||

|
||||
|
||||
Binary file not shown.
@@ -0,0 +1,33 @@
|
||||
fileFormatVersion: 2
|
||||
guid: a9c99c9c4ae6f4d4aa041ad31432e922
|
||||
PluginImporter:
|
||||
externalObjects: {}
|
||||
serializedVersion: 2
|
||||
iconMap: {}
|
||||
executionOrder: {}
|
||||
defineConstraints: []
|
||||
isPreloaded: 0
|
||||
isOverridable: 1
|
||||
isExplicitlyReferenced: 0
|
||||
validateReferences: 1
|
||||
platformData:
|
||||
- first:
|
||||
Any:
|
||||
second:
|
||||
enabled: 1
|
||||
settings: {}
|
||||
- first:
|
||||
Editor: Editor
|
||||
second:
|
||||
enabled: 0
|
||||
settings:
|
||||
DefaultValueInitialized: true
|
||||
- first:
|
||||
Windows Store Apps: WindowsStoreApps
|
||||
second:
|
||||
enabled: 0
|
||||
settings:
|
||||
CPU: AnyCPU
|
||||
userData:
|
||||
assetBundleName:
|
||||
assetBundleVariant:
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"MonoBehaviour": {
|
||||
"m_Enabled": true,
|
||||
"m_EditorHideFlags": 0,
|
||||
"m_Name": "",
|
||||
"m_EditorClassIdentifier": "",
|
||||
"m_OutputDllPaths": [
|
||||
"Packages/com.coffee.ui-effect/Runtime/Coffee.UIEffect.R.dll"
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user