diff --git a/doc/effects.rst b/doc/effects.rst index df42276225..ca067d5a8c 100644 --- a/doc/effects.rst +++ b/doc/effects.rst @@ -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. @@ -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 diff --git a/src/effects/icons/shadow.png b/src/effects/icons/shadow.png new file mode 100644 index 0000000000..d986e16f4c Binary files /dev/null and b/src/effects/icons/shadow.png differ diff --git a/src/effects/icons/shadow@2x.png b/src/effects/icons/shadow@2x.png new file mode 100644 index 0000000000..318a0895d1 Binary files /dev/null and b/src/effects/icons/shadow@2x.png differ