Skip to content

Commit 6b5b66e

Browse files
committed
docs: update readme
1 parent ae177a8 commit 6b5b66e

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

Packages/src/README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Combine various filters, such as grayscale, blur, and dissolve, to decorate your
4848
- [Gradation Mode](#gradation-mode)
4949
- [Edge Mode](#edge-mode)
5050
- [Detail Filter](#detail-filter)
51+
- [Flip](#flip)
5152
- [Others](#others)
5253
- [Component: UIEffectTweener](#component-uieffecttweener)
5354
- [Component: UIEffectReplica](#component-uieffectreplica)
@@ -200,7 +201,10 @@ If upgrading from UIEffect v4 to v5, note the following breaking changes:
200201
3. Adjust the effect filters and parameters in the inspector.
201202
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744308178360.gif)
202203

203-
4. Enjoy!
204+
4. From the top menu, you can load/append preset.
205+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744800851739.gif)
206+
207+
5. Enjoy!
204208

205209
<br><br>
206210

@@ -354,11 +358,12 @@ The `UIEffect` component applies visual effects to UI elements, allowing various
354358

355359
#### Detail Filter
356360

357-
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/uieffect5.7.0-inspector-detail.png)
361+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744762332942.png)
358362

359-
- **Detail Filter**: `None`, `Masking`, `Multiply`, `Additive`, `Replace`, `MuliplyAdditive`
360-
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/uieffect5.7.0-sample-detail.png)
363+
- **Detail Filter**: `None`, `Masking`, `Multiply`, `Additive`, `Subtractive`, `Replace`, `MuliplyAdditive`
364+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744826180386.png)
361365
- **Detail Intensity**: 0.0 (no effect) - 1.0 (full effect).
366+
- **Detail Color**: The color of the detail.
362367
- **Detail Threshold** (`Masking` only): The minimum and maximum alpha values used for masking. The larger the gap
363368
between these values, the stronger the softness effect.
364369
- **Detail Tex**: The texture used for the transition filter.
@@ -368,22 +373,29 @@ The `UIEffect` component applies visual effects to UI elements, allowing various
368373

369374
<br>
370375

371-
#### Others
376+
#### Flip
372377

373-
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/uieffect5.7.0-inspector-others.png)
378+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744762521061.png)
374379

375-
- **Sampling Scale**: The referencing scale during sampling.
376-
- Larger values are suitable for high-resolution textures.
377-
- **Allow To Modify Mesh Shape**: If enabled, the mesh shape can be modified.
378-
- **Custom Root**: Use the custom transform for some effects.
379-
- **Flip**:
380+
- **Flip**: Combine the following flags.
380381
- `Nothing`
381382
- `Horizontal`
382383
- `Vertical`
383384
- `Effect`: Flip with the effect.
384385
- `Shadow`: Flip with the shadow.
385386
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/uieffect5.7.0-sample-flip.png)
386387

388+
<br>
389+
390+
#### Others
391+
392+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744762623263.png)
393+
394+
- **Sampling Scale**: The referencing scale during sampling.
395+
- Larger values are suitable for high-resolution textures.
396+
- **Allow To Modify Mesh Shape**: If enabled, the mesh shape can be modified.
397+
- **Custom Root**: Use the custom transform for some effects.
398+
387399
> [!TIP]
388400
> `Transition Filter`, `Gradation Filter`, and `Detail Filter` usually refer to their own `RectTransform` when applying effects.
389401
> For example, if the mesh shape exceeds the `RectTransform` boundaries, the effect may not be applied correctly.
@@ -548,16 +560,23 @@ UIEffectProjectSettings.shaderVariantCollection.WarmUp();
548560

549561
### Project Settings
550562

551-
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744305055425.png)
563+
![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744799623192.png)
552564

553565
You can adjust the project-wide settings for UIEffect. (`Edit > Project Settings > UI > UIEffect`)
554566

555567
#### Settings
556568

557-
- **Transform Sensitivity**: `Low`, `Medium`, `High`
558-
- Set the sensitivity of the transformation when `Use Target Transform` is enabled in `UIEffectReplica` component.
559569
- **Runtime Presets**: A list of presets that can be loaded at runtime. Load them using `UIEffect.LoadPreset(presetName)` method.
560570

571+
> [!IMPORTANT]
572+
> - The legacy prefab-based preset system is deprecated as of v5.8.0.
573+
> - If your project contains legacy presets, you can convert them to the new system.
574+
> - **Convert All Legacy Presets**: Creates new presets based on the legacy ones.
575+
> If the legacy presets are used as runtime presets, they will be replaced with the new ones.
576+
> You can load the new preset via the `UIEffect.LoadPreset` method.
577+
> - **Delete All Legacy Presets**: Deletes all legacy presets. If any legacy presets are assigned to `UIEffectReplica.target`, those targets will also be removed.
578+
> ![](https://github.com/mob-sakai/mob-sakai/releases/download/docs/1744792792701.png)
579+
561580
#### Editor
562581

563582
- **Use HDR Color Picker**: If enabled, the HDR color picker will be used in the inspector.

0 commit comments

Comments
 (0)