Revision control
++ // Copyright (C) 2020 The Qt Company Ltd.
++ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
++ // Qt-Security score:significant reason:default
++
++ import QtQuick
++ import Qt5Compat.GraphicalEffects.private
++
++ /*!
++ \qmltype RectangularGlow
++ \inqmlmodule Qt5Compat.GraphicalEffects
++ \since QtGraphicalEffects 1.0
++ \inherits QtQuick::Item
++ \ingroup qtgraphicaleffects-glow
++ \brief Generates a blurred and colorized rectangle, which gives
++ the impression that the source is glowing.
++
++ This effect is intended to have good performance. The shape of the glow is
++ limited to a rectangle with a custom corner radius. For situations where
++ custom shapes are required, consider \l[QML]{Glow} effect.
++
++ \table
++ \header
++ \li Effect applied
++ \row
++ \li \image RectangularGlow_applied.png {White rectangular glow effect}
++ \endtable
++
++ \section1 Example
++
++ The following example shows how to apply the effect.
++ \snippet RectangularGlow-example.qml example
++ */
++ Item {
++ id: rootItem
++
++ /*!
++ This property defines how many pixels outside the item area are reached
++ by the glow.
++
++ The value ranges from 0.0 (no glow) to inf (infinite glow). By default,
++ the property is set to \c 0.0.
++
++ \table
++ \header
++ \li Output examples with different glowRadius values
++ \li
++ \li
++ \row
++ \li \image RectangularGlow_glowRadius1.png {Glow with radius 10}
++ \li \image RectangularGlow_glowRadius2.png {Glow with radius 20}
++ \li \image RectangularGlow_glowRadius3.png {Glow with radius 40}
++ \row
++ \li \b { glowRadius: 10 }
++ \li \b { glowRadius: 20 }
++ \li \b { glowRadius: 40 }
++ \row
++ \li \l spread: 0
++ \li \l spread: 0
++ \li \l spread: 0
++ \row
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \row
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \endtable
++
++ */
++ property real glowRadius: 0.0
++
++ /*!
++ This property defines how large part of the glow color is strengthened
++ near the source edges.
++
++ The value ranges from 0.0 (no strength increase) to 1.0 (maximum
++ strength increase). By default, the property is set to \c 0.0.
++
++ \table
++ \header
++ \li Output examples with different spread values
++ \li
++ \li
++ \row
++ \li \image RectangularGlow_spread1.png {Glow with spread 0.0}
++ \li \image RectangularGlow_spread2.png {Glow with spread 0.5}
++ \li \image RectangularGlow_spread3.png {Glow with spread 1.0}
++ \row
++ \li \b { spread: 0.0 }
++ \li \b { spread: 0.5 }
++ \li \b { spread: 1.0 }
++ \row
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \row
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \row
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \endtable
++ */
++ property real spread: 0.0
++
++ /*!
++ This property defines the RGBA color value which is used for the glow.
++
++ By default, the property is set to \c "white".
++
++ \table
++ \header
++ \li Output examples with different color values
++ \li
++ \li
++ \row
++ \li \image RectangularGlow_color1.png {White glow}
++ \li \image RectangularGlow_color2.png {Green glow}
++ \li \image RectangularGlow_color3.png {Blue glow}
++ \row
++ \li \b { color: #ffffff }
++ \li \b { color: #55ff55 }
++ \li \b { color: #5555ff }
++ \row
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \row
++ \li \l spread: 0
++ \li \l spread: 0
++ \li \l spread: 0
++ \row
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \li \l cornerRadius: 25
++ \endtable
++ */
++ property color color: "white"
++
++ /*!
++ This property defines the corner radius that is used to draw a glow with
++ rounded corners.
++
++ The value ranges from 0.0 to half of the effective width or height of
++ the glow, whichever is smaller. This can be calculated with: \c{
++ min(width, height) / 2.0 + glowRadius}
++
++ By default, the property is bound to glowRadius property. The glow
++ behaves as if the rectangle was blurred when adjusting the glowRadius
++ property.
++
++ \table
++ \header
++ \li Output examples with different cornerRadius values
++ \li
++ \li
++ \row
++ \li \image RectangularGlow_cornerRadius1.png {Glow with corner radius 0}
++ \li \image RectangularGlow_cornerRadius2.png {Glow with corner radius 25}
++ \li \image RectangularGlow_cornerRadius3.png {Glow with corner radius 50}
++ \row
++ \li \b { cornerRadius: 0 }
++ \li \b { cornerRadius: 25 }
++ \li \b { cornerRadius: 50 }
++ \row
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \li \l glowRadius: 20
++ \row
++ \li \l spread: 0
++ \li \l spread: 0
++ \li \l spread: 0
++ \row
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \li \l color: #ffffff
++ \endtable
++ */
++ property real cornerRadius: glowRadius
++
++ /*!
++ This property allows the effect output pixels to be cached in order to
++ improve the rendering performance.
++
++ Every time the source or effect properties are changed, the pixels in
++ the cache must be updated. Memory consumption is increased, because an
++ extra buffer of memory is required for storing the effect output.
++
++ It is recommended to disable the cache when the source or the effect
++ properties are animated.
++
++ By default, the property is set to \c false.
++ */
++ property bool cached: false
++
++ ShaderEffectSource {
++ id: cacheItem
++ anchors.fill: shaderItem
++ visible: rootItem.cached
++ smooth: true
++ sourceItem: shaderItem
++ live: true
++ hideSource: visible
++ }
++
++ ShaderEffect {
++ id: shaderItem
++
++ x: (parent.width - width) / 2.0
++ y: (parent.height - height) / 2.0
++ width: parent.width + rootItem.glowRadius * 2 + cornerRadius * 2
++ height: parent.height + rootItem.glowRadius * 2 + cornerRadius * 2
++
++ function clampedCornerRadius() {
++ var maxCornerRadius = Math.min(rootItem.width, rootItem.height) / 2 + glowRadius;
++ return Math.max(0, Math.min(rootItem.cornerRadius, maxCornerRadius))
++ }
++
++ property color color: rootItem.color
++ property real inverseSpread: 1.0 - rootItem.spread
++ property real relativeSizeX: ((inverseSpread * inverseSpread) * rootItem.glowRadius + cornerRadius * 2.0) / width
++ property real relativeSizeY: relativeSizeX * (width / height)
++ property real spread: rootItem.spread / 2.0
++ property real cornerRadius: clampedCornerRadius()
++
++ fragmentShader: "qrc:/qt-project.org/imports/Qt5Compat/GraphicalEffects/shaders_ng/rectangularglow.frag.qsb"
++ }
++ }