summaryrefslogtreecommitdiff
path: root/doc/src/qtgraphicaleffects-zoomblur.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/qtgraphicaleffects-zoomblur.qdoc')
-rw-r--r--doc/src/qtgraphicaleffects-zoomblur.qdoc196
1 files changed, 0 insertions, 196 deletions
diff --git a/doc/src/qtgraphicaleffects-zoomblur.qdoc b/doc/src/qtgraphicaleffects-zoomblur.qdoc
deleted file mode 100644
index 502171d..0000000
--- a/doc/src/qtgraphicaleffects-zoomblur.qdoc
+++ /dev/null
@@ -1,196 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the Qt Graphical Effects module.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
-**
-** GNU Free Documentation License Usage
-** 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. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \qmltype ZoomBlur
- \inqmlmodule QtGraphicalEffects 1.0
- \since QtGraphicalEffects 1.0
- \inherits QtQuick2::Item
- \ingroup qtgraphicaleffects-motion-blur
- \brief Applies directional blur effect towards source items center point.
-
- Effect creates perceived impression that the source item appears to be
- moving towards the center point in Z-direction or that the camera appears
- to be zooming rapidly. Other available motion blur effects are
- \l{QtGraphicalEffects1::DirectionalBlur}{DirectionalBlur}
- and \l{QtGraphicalEffects1::RadialBlur}{RadialBlur}.
-
- \table
- \header
- \li Source
- \li Effect applied
- \row
- \li \image Original_bug.png
- \li \image ZoomBlur_bug.png
- \endtable
-
- \section1 Example
-
- The following example shows how to apply the effect.
- \snippet snippets/ZoomBlur-example.qml example
-
-*/
-
-/*!
- \qmlproperty variant QtGraphicalEffects1::ZoomBlur::source
-
- This property defines the source item that is going to be blurred.
-
-*/
-
-/*!
- \qmlproperty real QtGraphicalEffects1::ZoomBlur::length
-
- This property defines the maximum perceived amount of movement for each
- pixel. The amount is smaller near the center and reaches the specified
- value at the edges.
-
- The quality of the blur depends on \l{ZoomBlur::samples}{samples} property. If length value is
- large, more samples are needed to keep the visual quality at high level.
-
- The value ranges from 0.0 to inf.
- By default the property is set to \c 0.0 (no blur).
-
- \table
- \header
- \li Output examples with different length values
- \li
- \li
- \row
- \li \image ZoomBlur_length1.png
- \li \image ZoomBlur_length2.png
- \li \image ZoomBlur_length3.png
- \row
- \li \b { length: 0.0 }
- \li \b { length: 32.0 }
- \li \b { length: 48.0 }
- \row
- \li \l samples: 24
- \li \l samples: 24
- \li \l samples: 24
- \row
- \li \l horizontalOffset: 0
- \li \l horizontalOffset: 0
- \li \l horizontalOffset: 0
- \row
- \li \l verticalOffset: 0
- \li \l verticalOffset: 0
- \li \l verticalOffset: 0
- \endtable
-
-*/
-
-/*!
- \qmlproperty int QtGraphicalEffects1::ZoomBlur::samples
-
- This property defines how many samples are taken per pixel when blur
- calculation is done. Larger value produces better quality, but is slower
- to render.
-
- This property is not intended to be animated. Changing this property may
- cause the underlying OpenGL shaders to be recompiled.
-
- Allowed values are between 0 and inf (practical maximum depends on GPU).
- By default the property is set to \c 0 (no samples).
-
-*/
-
-/*!
- \qmlproperty real QtGraphicalEffects1::ZoomBlur::horizontalOffset
- \qmlproperty real QtGraphicalEffects1::ZoomBlur::verticalOffset
-
- These properties define an offset in pixels for the blur direction center
- point.
-
- The values range from -inf to inf. By default these properties are set
- to \c 0.
-
- \table
- \header
- \li Output examples with different horizontalOffset values
- \li
- \li
- \row
- \li \image ZoomBlur_horizontalOffset1.png
- \li \image ZoomBlur_horizontalOffset2.png
- \li \image ZoomBlur_horizontalOffset3.png
- \row
- \li \b { horizontalOffset: 100.0 }
- \li \b { horizontalOffset: 0.0 }
- \li \b { horizontalOffset: -100.0 }
- \row
- \li \l samples: 24
- \li \l samples: 24
- \li \l samples: 24
- \row
- \li \l length: 32
- \li \l length: 32
- \li \l length: 32
- \row
- \li \l verticalOffset: 0
- \li \l verticalOffset: 0
- \li \l verticalOffset: 0
- \endtable
-
-*/
-
-
-/*!
- \qmlproperty bool QtGraphicalEffects1::ZoomBlur::transparentBorder
-
- This property defines the blur behavior near the edges of the item, where
- the pixel blurring is affected by the pixels outside the source edges.
-
- If the property is set to \c true, the pixels outside the source are
- interpreted to be transparent, which is similar to OpenGL clamp-to-border
- extension. The blur is expanded slightly outside the effect item area.
-
- If the property is set to \c false, the pixels outside the source are
- interpreted to contain the same color as the pixels at the edge of the item,
- which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
- outside the effect item area.
-
- By default, the property is set to \c false.
-
-*/
-
-/*!
- \qmlproperty bool QtGraphicalEffects1::ZoomBlur::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.
-
-*/