DistortionRipple QML Type | Qt Quick 3D | Qt 6.12.0
Description: A ripple distortion effect.
Keywords: qmltype

- Qt 6.12
- Qt Quick 3D
- QML Types
- QtQuick3D.Effects
- DistortionRipple
- Qt Quick 3D | Commercial or GPLv3

# DistortionRipple QML Type

A ripple distortion effect. More...

Import Statement: | `import QtQuick3D.Effects 6.12`
Status: | Deprecated since 6.5

This type is deprecated since QtQuick3D.Effects 6.5. We strongly advise against using it in new code.

- List of all members, including inherited members

## Properties

- center : vector2d
- distortionHeight : real
- distortionPhase : real
- distortionWidth : real
- radius : real

## Detailed Description

Use ExtendedSceneEnvironment, MultiEffect, or user-defined effects via the Effect type instead.

Warning: All pre-made standalone effects in QtQuick3D.Effects are considered deprecated starting with Qt 6.5. Applications are advised to use ExtendedSceneEnvironment or MultiEffect instead, when applicable, or alternatively provide their own custom post-processing effect via the Effect type.

The DistortionRipple effect adds a wavelike distortion of circular ripples around a center point.

## Property Documentation

### center : vector2d

The center point of the distortion. The default is `Qt.vector2d(0.5, 0.5)`, the center of the scene.

### distortionHeight : real

The distortion amount. Sensible values are in the range `[0...100]`. The default value is `10`.

### distortionPhase : real

The offset of each wave. Animate this property to see the waves move. Sensible values are in the range `[0...360]`. The default value is `0`.

### distortionWidth : real

The width of a ripple. Sensible values are in the range `[2...100]`. The default value is `10`.

### radius : real

How far the ripples extend from the center point. Sensible values are in the range `[0...100]`. The default value is `100`.