/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Graphical Effects module.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmlclass ThresholdMask
    \inqmlmodule QtGraphicalEffects 1.0
    \since QtGraphicalEffects 1.0
    \inherits QtQuick2::Item
    \ingroup qtgraphicaleffects-mask
    \brief Masks the source item with another item and applies a threshold value.

    The masking behavior can be controlled with the \l threshold value for the
    mask pixels.

    \table
    \header
        \li Source
        \li MaskSource
        \li Effect applied
    \row
        \li \image Original_bug.png
        \li \image ThresholdMask_mask.png
        \li \image ThresholdMask_bug.png
    \endtable

    \section1 Example

    The following example shows how to apply the effect.
    \snippet snippets/ThresholdMask-example.qml example

*/

/*!
    \qmlproperty variant QtGraphicalEffects1::ThresholdMask::source

    This property defines the source item that is going to be masked.

*/

/*!
    \qmlproperty variant QtGraphicalEffects1::ThresholdMask::maskSource

    This property defines the item that is going to be used as the mask. Mask item gets rendered into an intermediate pixel buffer and
    the alpha values from the result are used to determine the source item's pixels visibility in the display.

    \table
    \header
        \li Original
        \li Mask
        \li Effect applied
    \row
        \li \image Original_bug.png
        \li \image ThresholdMask_mask.png
        \li \image ThresholdMask_bug.png
    \endtable

*/

/*!
    \qmlproperty real QtGraphicalEffects1::ThresholdMask::threshold

    This property defines a threshold value for the mask pixels. The mask pixels that have an alpha value
    below this property are used to completely mask away the corresponding pixels from the source item.
    The mask pixels that have a higher alpha value are used to alphablend the source item to the display.

    The value ranges from 0.0 (alpha value 0) to 1.0 (alpha value 255). By default, the property is set to \c 0.0.

    \table
    \header
    \li Output examples with different threshold values
    \li
    \li
    \row
        \li \image ThresholdMask_threshold1.png
        \li \image ThresholdMask_threshold2.png
        \li \image ThresholdMask_threshold3.png
    \row
        \li \b { threshold: 0.0 }
        \li \b { threshold: 0.5 }
        \li \b { threshold: 0.7 }
    \row
        \li \l spread: 0.2
        \li \l spread: 0.2
        \li \l spread: 0.2
    \endtable

*/

/*!
    \qmlproperty real QtGraphicalEffects1::ThresholdMask::spread

    This property defines the smoothness of the mask edges near the
    \l{ThresholdMask::threshold}{threshold} alpha value. Setting spread to 0.0
    uses mask normally with the specified threshold. Setting higher spread values
    softens the transition from the transparent mask pixels towards opaque mask
    pixels by adding interpolated values between them.

    The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to \c 0.0.

    \table
    \header
    \li Output examples with different spread values
    \li
    \li
    \row
        \li \image ThresholdMask_spread1.png
        \li \image ThresholdMask_spread2.png
        \li \image ThresholdMask_spread3.png
    \row
        \li \b { spread: 0.0 }
        \li \b { spread: 0.2 }
        \li \b { spread: 0.8 }
    \row
        \li \l threshold: 0.4
        \li \l threshold: 0.4
        \li \l threshold: 0.4
    \endtable

*/


/*!
    \qmlproperty bool QtGraphicalEffects1::ThresholdMask::cached

    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.

*/