Class: QgsBlurEffect¶
-
class
qgis.core.
QgsBlurEffect
¶ Bases:
qgis._core.QgsPaintEffect
Constructor for QgsBlurEffect.
QgsBlurEffect(QgsBlurEffect)
A paint effect which blurs a source picture, using a number of different blur methods.
New in version 2.9: Enums
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).
Creates a new QgsBlurEffect effect from a properties string map.
Returns the opacity for the effect.
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.Signals
Attributes
-
class
BlurMethod
¶ Bases:
int
-
GaussianBlur
= 1¶
-
StackBlur
= 0¶
-
blendMode
(self) → QPainter.CompositionMode¶ Returns the blend mode for the effect
- Returns
blend mode used for drawing the effect on to a destination paint device
See also
-
blurLevel
(self) → float¶ Returns the blur level (radius)
- 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).
- 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.
- Returns
blur method
See also
-
blurUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units used for the blur level (radius).
- Returns
units for blur level
See also
See also
See also
New in version 3.4.9.
-
boundingRect
(self, rect: QRectF, context: QgsRenderContext) → QRectF¶
-
clone
(self) → QgsBlurEffect¶
-
create
(map: Dict[str, str]) → QgsPaintEffect¶ Creates a new QgsBlurEffect effect from a properties string map.
- Parameters
map – encoded properties string map
- Returns
new QgsBlurEffect
-
draw
(self, context: QgsRenderContext)¶
-
drawSource
()¶
-
fixQPictureDpi
()¶
-
imageOffset
()¶
-
opacity
(self) → float¶ Returns the opacity for the effect.
- Returns
opacity value between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque
See also
-
properties
(self) → Dict[str, str]¶
-
readProperties
(self, props: Dict[str, str])¶
-
setBlendMode
(self, mode: QPainter.CompositionMode)¶ Sets the blend mode for the effect
- Parameters
mode – 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 – 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 – 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 – blur method
See also
-
setBlurUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the units used for the blur level (radius).
- Parameters
unit – 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 – double between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque
See also
-
source
()¶
-
sourceAsImage
()¶
-
type
(self) → str¶
-
class