diff options
Diffstat (limited to 'doc/src/10-best-practices/distortion-ripple.qdoc')
-rw-r--r-- | doc/src/10-best-practices/distortion-ripple.qdoc | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/src/10-best-practices/distortion-ripple.qdoc b/doc/src/10-best-practices/distortion-ripple.qdoc new file mode 100644 index 00000000..fe720da7 --- /dev/null +++ b/doc/src/10-best-practices/distortion-ripple.qdoc @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $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 The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Distortion Ripple +\page distortion-ripple.html +\ingroup qt3dstudio-best-practices + +The distortion ripple effect adds circular ripples, moving away from the center of the effect. + +\image effects-distortion-ripple.png + +\section1 Properties + +\table + \header + \li Property + \li Description + \row + \li + Radius + \li + The spread between the ripples. + \row + \li + Center + \li + The center of the effect. \c 0.5 and \c 0.5 is the center of the layer while \c 1.0 and \c 1.0 + is the upper right corner of the layer. + \row + \li + Wave width + \li + Adjusts the amount of ripples. + \row + \li + Wave height + \li + Adjusts the distortion amount. + \row + \li + Ripple phase + \li + The offset of each ripple. Animate this property to achieve an effect of moving waves. +\endtable + +*/ |