DirectionalBlur QML Type | Qt 5 Compatibility APIs: Graphical Effects | Qt 6.11.1
Description: Applies blur effect to the specified direction.

- Qt 6.11
- Qt 5 Compatibility APIs: Graphical Effects
- QML Types
- DirectionalBlur
- Qt 6.11.1 Reference Documentation

# DirectionalBlur QML Type

Applies blur effect to the specified direction. More...

Import Statement: | `import Qt5Compat.GraphicalEffects`
Since: | QtGraphicalEffects 1.0
Inherits: | Item

- List of all members, including inherited members

## Properties

- angle : real
- cached : bool
- length : real
- samples : int
- source : variant
- transparentBorder : bool

## Detailed Description

Effect creates perceived impression that the source item appears to be moving in the direction of the blur. Blur is applied to both sides of each pixel, therefore setting the direction to 0 and 180 provides the same result.

Other available motionblur effects are ZoomBlur and RadialBlur.

Source | Effect applied
--- | ---

Note: This effect is available when running with OpenGL.

## Example

The following example shows how to apply the effect.

     import QtQuick
     import Qt5Compat.GraphicalEffects

     Item {
         width: 300
         height: 300

         Image {
             id: bug
             source: "images/bug.jpg"
             sourceSize: Qt.size(parent.width, parent.height)
             smooth: true
             visible: false
         }

         DirectionalBlur {
             anchors.fill: bug
             source: bug
             angle: 90
             length: 32
             samples: 24
         }
     }

## Property Documentation

### angle : real

This property defines the direction for the blur. Blur is applied to both sides of each pixel, therefore setting the direction to 0 and 180 produces the same result.

The value ranges from -180.0 to 180.0. By default the property is set to `0.0`.

Output examples with different angle values |  |
--- | --- | ---
angle: 0.0 | angle: 45.0 | angle: 90.0
samples: 24 | samples: 24 | samples: 24
length: 32 | length: 32 | length: 32

### cached : bool

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 `false`.

### length : real

This property defines the perceived amount of movement for each pixel. The movement is divided evenly to both sides of each pixel.

The quality of the blur depends on 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 `0.0` (no blur).

Output examples with different length values |  |
--- | --- | ---
length: 0.0 | length: 32.0 | length: 48.0
samples: 24 | samples: 24 | samples: 24
angle: 0 | angle: 0 | angle: 0

### samples : int

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 `0` (no samples).

### source : variant

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

Note: It is not supported to let the effect include itself, for instance by setting source to the effect's parent.

### transparentBorder : bool

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 `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 `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 `false`.