Skip to content

Add shadow effect icons and document #5734

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

Open
wants to merge 4 commits into
base: develop
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
25 changes: 25 additions & 0 deletions doc/effects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ the name and short description of each effect.
Object Detector Detect objects in video.
Outline Add outline around any image or text.
Pixelate Increase or decrease visible pixels.
Shadow Drop shadow under any image or text.
Sharpen Boost edge contrast to make video details look crisper.
Shift Shift image in different directions.
Spherical Projection Flatten or project 360° videos.
Expand Down Expand Up @@ -773,6 +774,30 @@ to evoke a retro, digital, or abstract aesthetic.
top ``(float, 0 to 1)`` The curve to adjust the top margin size
========================== ============

Shadow
""""""
The Shadow effect drops shadow under text or images within a video frame. It works by creating a solid color layer based
on the image's alpha channel, blurring it to create a soft shadow and then, the original image will be placed on top of
the newly created shadow layer. Users can adjust the shadow offset (both vertically and horizontally), blur radius (affecting
the softness of the shadow's edge) as well as its color components (red, green, blue) and transparency (alpha). This effect
helps you create various type of interesting effect. Please note that this shadow effect applied is not a physically accurate
depiction of light and shadow, but rather a visual technique used to create the perception of depth and form.

.. table::
:widths: 26 80

========================== ============
Property Name Description
========================== ============
x_offset ``(int, -4000 to 4000)`` The curve to adjust vertical shadow offset
y_offset ``(int, -4000 to 4000)`` The curve to adjust horizontal shadow offset
blur_radius ``(int, 0 to 100)`` The curve to adjust blur radius of the shadow's edge
red ``(int, 0 to 255)`` The red color component of the shadow.
green ``(int, 0 to 255)`` The green color component of the shadow.
blue ``(int, 0 to 255)`` The blue color component of the shadow.
alpha ``(int, 0 to 255)`` The transparency (alpha) value for the shadow.
========================== ============

Sharpen
"""""""
The Sharpen effect enhances perceived detail by first blurring the frame slightly and then adding a scaled
Expand Down
Binary file added src/effects/icons/shadow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/effects/icons/shadow@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.