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
Returns the blend mode for the effect
Returns the blur level (radius)
Returns the map unit scale used for the blur strength (radius).
Returns the blur method (algorithm) used for performing the blur.
Returns the units used for the blur level (radius).
- param rect:
- rtype:
QgsBlurEffect
Creates a new
QgsBlurEffect
effect from a properties string map.- param context:
Draws the source QPicture onto the specified painter.
Applies a workaround to a QPainter to avoid an issue with incorrect scaling when drawing QPictures.
Returns the offset which should be used when drawing the source image on to a destination render context.
Returns the opacity for the effect.
- rtype:
Dict[str, Any]
- param props:
Sets the blend mode for the effect
Sets blur level (radius)
Sets the map unit scale used for the blur strength (radius).
Sets the blur method (algorithm) to use for performing the blur.
Sets the units used for the blur level (radius).
Sets the
opacity
for the effect.Returns the source QPicture.
Returns the source QPicture rendered to a new QImage.
- rtype:
str
Attributes
- 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
- 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
See also
See also
See also
- blurMapUnitScale(self) QgsMapUnitScale ¶
Returns the map unit scale used for the blur strength (radius).
- Return type:
- Returns:
map unit scale for blur strength
See also
See also
See also
New in version 3.4.9.
- blurMethod(self) QgsBlurEffect.BlurMethod ¶
Returns the blur method (algorithm) used for performing the blur.
- Return type:
- Returns:
blur method
See also
- blurUnit(self) Qgis.RenderUnit ¶
Returns the units used for the blur level (radius).
- Return type:
- Returns:
units for blur level
See also
See also
See also
New in version 3.4.9.
- boundingRect(self, rect: QRectF, context: QgsRenderContext) QRectF ¶
- Parameters:
rect (QRectF) –
context (QgsRenderContext) –
- Return type:
QRectF
- clone(self) QgsBlurEffect ¶
- Return type:
- create(map: Dict[str, Any]) QgsPaintEffect ¶
Creates a new
QgsBlurEffect
effect from a properties string map.- Parameters:
map (Dict[str) – encoded properties string map
- Return type:
- 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
See also
- fixQPictureDpi(self, painter: QPainter)¶
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
- 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
- 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
- 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
See also
See also
See also
- 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
See also
See also
New 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
- setBlurUnit(self, unit: Qgis.RenderUnit)¶
Sets the units used for the blur level (radius).
- Parameters:
unit (Qgis.RenderUnit) – units for blur level
See also
See also
See also
New 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
- source(self) QPicture ¶
Returns the source QPicture. The
draw()
member can utilize this when drawing the effect.- Returns:
source QPicture
See also
See also
- sourceAsImage(self, context: QgsRenderContext) QImage ¶
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 theboundingRect()
method. The result is cached to speed up subsequent calls to sourceAsImage.- Returns:
source QPicture rendered to an image
See also
See also
See also
See also
- type(self) str ¶
- Return type:
str