Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Lottie Exporter] Add documentation for shade layer #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/projects/lottie/layers/shade_layer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Shade Layer
===========

+------------------+--------------------------------------------------------------------+
| Property in .sif | Path to property in Lottie |
+------------------+--------------------------------------------------------------------+
| Z_depth | Only one shade layer is supported in Lottie per layer |
+------------------+--------------------------------------------------------------------+
| Amount | “ef” -> Opacity -> properties/[value.json OR valueKeyframed.json] |
+------------------+--------------------------------------------------------------------+
| Blend Method | Not Supported |
+------------------+--------------------------------------------------------------------+
| Color | "ef" -> Shadow Color ->effects/fill.json -> effects/color.json |
+------------------+--------------------------------------------------------------------+
| Origin | “ef” -> Distance -> properties/[value.json OR valueKeyframed.json] |
+------------------+--------------------------------------------------------------------+
| Size | “ef” -> Softness -> properties/[value.json OR valueKeyframed.json] |
+------------------+--------------------------------------------------------------------+
| Type | Only Gaussian Blur is supported in Lottie |
+------------------+--------------------------------------------------------------------+
| Invert | Not Supported in Lottie |
+------------------+--------------------------------------------------------------------+

Important points
----------------

- For all types of shade layer, they are defaulted to Gaussian Blur, since this is the only blur type supported by Lottie.
- Shade in lottie is not supported for outlines.
24 changes: 24 additions & 0 deletions docs/projects/lottie/supported.rst
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,30 @@ Blur Layer
| Type | |tick| | |tick| |
+--------------+---------+-----------------+

Shade Layer
-----------

+--------------+---------------------+-----------------+
| Property | Value | Type(Animation) |
+==============+=====================+=================+
| Z_depth | |tick| | |cross| |
+--------------+---------------------+-----------------+
| Amount | |tick| | |tick| |
+--------------+---------------------+-----------------+
| Blend Method | |cross| | |minus| |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does shade layer not support blend methods at all? I don't remember this actually.
Can someone test the lottie exporter to check this ^__^

+--------------+---------------------+-----------------+
| Color | |tick| | |tick| |
+--------------+---------------------+-----------------+
| Origin | |tick| | |tick| |
+--------------+---------------------+-----------------+
| Size | |tick| | |tick| |
+--------------+---------------------+-----------------+
| Type | Partially Supported | |cross| |
+--------------+---------------------+-----------------+
| Invert | |cross| | |cross| |
+--------------+---------------------+-----------------+


Blend Methods
-------------
- The blend methods supported are: Composite, Difference, Multiply, Hard light, Luminance, Saturation, Hue, Color, Darken, Brighten, Overlay, Screen.
Expand Down