Class: QgsBlurEffect

A paint effect which blurs a source picture, using a number of different blur methods.

Class Hierarchy

Base classes

QgsPaintEffect

Base class for visual effects which can be applied to QPicture drawings.

class qgis.core.QgsBlurEffect

Bases: QgsPaintEffect

class BlurMethod

Bases: int

GaussianBlur = 1

StackBlur = 0

blendMode(self) → QPainter.CompositionMode

Returns the blend mode for the effect

Return type:

QPainter.CompositionMode

Returns:

blend mode used for drawing the effect on to a destination paint device

See also

setBlendMode()

blurLevel(self) → float

Returns the blur level (radius)

Return type:

float

Returns:

blur level. Depending on the current blurMethod(), this parameter has different effects

See also

setBlurLevel()

See also

blurUnit()

See also

blurMapUnitScale()

See also

blurMethod()

blurMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale used for the blur strength (radius).

Return type:

QgsMapUnitScale

Returns:

map unit scale for blur strength

See also

setBlurMapUnitScale()

See also

blurLevel()

See also

blurUnit()

Added in version 3.4.9.

blurMethod(self) → QgsBlurEffect.BlurMethod

Returns the blur method (algorithm) used for performing the blur.

Return type:

QgsBlurEffect.BlurMethod

Returns:

blur method

See also

setBlurMethod()

blurUnit(self) → Qgis.RenderUnit

Returns the units used for the blur level (radius).

Return type:

Qgis.RenderUnit

Returns:

units for blur level

See also

setBlurUnit()

See also

blurLevel()

See also

blurMapUnitScale()

Added in version 3.4.9.

static create(map: Dict[str, Any]) → QgsPaintEffect | None

Creates a new QgsBlurEffect effect from a properties string map.

Parameters:

map (Dict[str, Any]) – encoded properties string map

Return type:

Optional[QgsPaintEffect]

Returns:

new QgsBlurEffect

opacity(self) → float

Returns the opacity for the effect.

Return type:

float

Returns:

opacity value between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque

See also

setOpacity()

setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blend mode for the effect

Parameters:

mode (QPainter.CompositionMode) – blend mode used for drawing the effect on to a destination paint device

See also

blendMode()

setBlurLevel(self, level: float)

Sets blur level (radius)

Parameters:

level (float) – blur level. Depending on the current blurMethod(), this parameter has different effects

See also

blurLevel()

See also

setBlurUnit()

See also

setBlurMapUnitScale()

See also

setBlurMethod()

setBlurMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale used for the blur strength (radius).

Parameters:

scale (QgsMapUnitScale) – map unit scale for blur strength

See also

blurMapUnitScale()

See also

setBlurLevel()

See also

setBlurUnit()

Added in version 3.4.9.

setBlurMethod(self, method: QgsBlurEffect.BlurMethod)

Sets the blur method (algorithm) to use for performing the blur.

Parameters:

method (QgsBlurEffect.BlurMethod) – blur method

See also

blurMethod()

setBlurUnit(self, unit: Qgis.RenderUnit)

Sets the units used for the blur level (radius).

Parameters:

unit (Qgis.RenderUnit) – units for blur level

See also

blurUnit()

See also

setBlurLevel()

See also

setBlurMapUnitScale()

Added in version 3.4.9.

setOpacity(self, opacity: float)

Sets the opacity for the effect.

Parameters:

opacity (float) – double between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque

See also

opacity()