Class: QgsBlurEffect

class qgis.core.QgsBlurEffect

Bases: QgsPaintEffect

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

QgsBlurEffect() Constructor for QgsBlurEffect.

Methods

blendMode

Returns the blend mode for the effect

blurLevel

Returns the blur level (radius)

blurMapUnitScale

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

blurMethod

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

blurUnit

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

boundingRect

param rect:

clone

rtype:

Optional[QgsBlurEffect]

create

Creates a new QgsBlurEffect effect from a properties string map.

draw

param context:

drawSource

Draws the source QPicture onto the specified painter.

fixQPictureDpi

Applies a workaround to a QPainter to avoid an issue with incorrect scaling when drawing QPictures.

imageOffset

Returns the offset which should be used when drawing the source image on to a destination render context.

opacity

Returns the opacity for the effect.

properties

rtype:

Dict[str, Any]

readProperties

param props:

setBlendMode

Sets the blend mode for the effect

setBlurLevel

Sets blur level (radius)

setBlurMapUnitScale

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

setBlurMethod

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

setBlurUnit

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

setOpacity

Sets the opacity for the effect.

source

Returns the source QPicture.

sourceAsImage

Returns the source QPicture rendered to a new QImage.

type

rtype:

str

Attributes

GaussianBlur

StackBlur

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

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

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()

Added in version 3.4.9.

boundingRect(self, rect: QRectF, context: QgsRenderContext) QRectF
Parameters:
Return type:

QRectF

clone(self) QgsBlurEffect | None
Return type:

Optional[QgsBlurEffect]

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

Creates a new QgsBlurEffect effect from a properties string map.

Parameters:

map (Dict[str) – encoded properties string map

Return type:

Optional[QgsPaintEffect]

Returns:

new QgsBlurEffect

draw(self, context: QgsRenderContext)
Parameters:

context (QgsRenderContext)

drawSource(self, painter: QPainter)

Draws the source QPicture onto the specified painter. Handles scaling of the picture to account for the destination painter’s DPI.

Parameters:

painter – destination painter

See also

source()

See also

sourceAsImage()

fixQPictureDpi(self, painter: QPainter | None)

Applies a workaround to a QPainter to avoid an issue with incorrect scaling when drawing QPictures. This may need to be called by derived classes prior to rendering results onto a painter.

Parameters:

painter – destination painter

imageOffset(self, context: QgsRenderContext) QPointF

Returns the offset which should be used when drawing the source image on to a destination render context.

Parameters:

context – destination render context

Returns:

point offset for image top left corner

See also

sourceAsImage()

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()

properties(self) Dict[str, Any]
Return type:

Dict[str, Any]

readProperties(self, props: Dict[str, Any])
Parameters:

props (Dict[str)

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

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

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()

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()

source(self) QPicture | None

Returns the source QPicture. The draw() member can utilize this when drawing the effect.

Returns:

source QPicture

See also

drawSource()

See also

sourceAsImage()

sourceAsImage(self, context: QgsRenderContext) QImage | None

Returns the source QPicture rendered to a new QImage. The draw() member can utilize this when drawing the effect. The image will be padded or cropped from the original source QPicture by the results of the boundingRect() method. The result is cached to speed up subsequent calls to sourceAsImage.

Returns:

source QPicture rendered to an image

See also

drawSource()

See also

source()

See also

imageOffset()

See also

boundingRect()

type(self) str
Return type:

str