QGraphicsBlurEffect Class

The QGraphicsBlurEffect class provides a blur effect. More...

Header: #include <QGraphicsBlurEffect>
CMake: find_package(Qt6 REQUIRED COMPONENTS Widgets)
target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: QT += widgets
Inherits: QGraphicsEffect

Public Types

enum BlurHint { PerformanceHint, QualityHint, AnimationHint }
flags BlurHints

Properties

Public Functions

QGraphicsBlurEffect(QObject *parent = nullptr)
virtual ~QGraphicsBlurEffect()
QGraphicsBlurEffect::BlurHints blurHints() const
qreal blurRadius() const

Reimplemented Public Functions

virtual QRectF boundingRectFor(const QRectF &rect) const override

Public Slots

void setBlurHints(QGraphicsBlurEffect::BlurHints hints)
void setBlurRadius(qreal blurRadius)

Signals

void blurHintsChanged(QGraphicsBlurEffect::BlurHints hints)
void blurRadiusChanged(qreal radius)

Reimplemented Protected Functions

virtual void draw(QPainter *painter) override

Detailed Description

A blur effect blurs the source. This effect is useful for reducing details, such as when the source loses focus and you want to draw attention to other elements. The level of detail can be modified using the setBlurRadius() function. Use setBlurHints() to choose the blur hints.

By default, the blur radius is 5 pixels. The blur radius is specified in device coordinates.

See also QGraphicsDropShadowEffect, QGraphicsColorizeEffect, and QGraphicsOpacityEffect.

Member Type Documentation

enum QGraphicsBlurEffect::BlurHint
flags QGraphicsBlurEffect::BlurHints

This enum describes the possible hints that can be used to control how blur effects are applied. The hints might not have an effect in all the paint engines.

ConstantValueDescription
QGraphicsBlurEffect::PerformanceHint0x00Indicates that rendering performance is the most important factor, at the potential cost of lower quality.
QGraphicsBlurEffect::QualityHint0x01Indicates that rendering quality is the most important factor, at the potential cost of lower performance.
QGraphicsBlurEffect::AnimationHint0x02Indicates that the blur radius is going to be animated, hinting that the implementation can keep a cache of blurred versions of the source. Do not use this hint if the source is going to be dynamically changing.

The BlurHints type is a typedef for QFlags<BlurHint>. It stores an OR combination of BlurHint values.

See also blurHints() and setBlurHints().

Property Documentation

blurHints : BlurHints

This property holds the blur hint of the effect.

Use the PerformanceHint hint to say that you want a faster blur, the QualityHint hint to say that you prefer a higher quality blur, or the AnimationHint when you want to animate the blur radius.

By default, the blur hint is PerformanceHint.

Access functions:

QGraphicsBlurEffect::BlurHints blurHints() const
void setBlurHints(QGraphicsBlurEffect::BlurHints hints)

Notifier signal:

void blurHintsChanged(QGraphicsBlurEffect::BlurHints hints)

blurRadius : qreal

This property holds the blur radius of the effect.

Using a smaller radius results in a sharper appearance, whereas a bigger radius results in a more blurred appearance.

By default, the blur radius is 5 pixels.

The radius is given in device coordinates, meaning it is unaffected by scale.

Access functions:

qreal blurRadius() const
void setBlurRadius(qreal blurRadius)

Notifier signal:

void blurRadiusChanged(qreal radius)

Member Function Documentation

QGraphicsBlurEffect::QGraphicsBlurEffect(QObject *parent = nullptr)

Constructs a new QGraphicsBlurEffect instance. The parent parameter is passed to QGraphicsEffect's constructor.

[virtual noexcept] QGraphicsBlurEffect::~QGraphicsBlurEffect()

Destroys the effect.

[signal] void QGraphicsBlurEffect::blurHintsChanged(QGraphicsBlurEffect::BlurHints hints)

This signal is emitted whenever the effect's blur hints changes. The hints parameter holds the effect's new blur hints.

Note: Notifier signal for property blurHints.

[signal] void QGraphicsBlurEffect::blurRadiusChanged(qreal radius)

This signal is emitted whenever the effect's blur radius changes. The radius parameter holds the effect's new blur radius.

Note: Notifier signal for property blurRadius.

[override virtual] QRectF QGraphicsBlurEffect::boundingRectFor(const QRectF &rect) const

Reimplements: QGraphicsEffect::boundingRectFor(const QRectF &rect) const.

[override virtual protected] void QGraphicsBlurEffect::draw(QPainter *painter)

Reimplements: QGraphicsEffect::draw(QPainter *painter).