Class: QgsColorEffect¶
-
class
qgis.core.
QgsColorEffect
¶ Bases:
QgsPaintEffect
A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.
Methods
Returns the blend mode for the effect
Returns the brightness modification for the effect.
- rtype
QgsColorEffect
Returns the color used for colorizing a picture.
Returns whether the effect will colorize a picture.
Returns the strength used for colorizing a picture.
Returns the contrast modification for the effect.
Creates a new
QgsColorEffect
effect from a properties string map.- param context
Returns whether the effect will convert a picture to grayscale.
Returns the opacity for the effect.
- rtype
Dict[str, str]
- param props
Returns the saturation modification for the effect.
Sets the blend mode for the effect
Sets the brightness modification for the effect.
Sets the color used for colorizing a picture.
Sets whether the effect should colorize a picture.
Sets the strength for colorizing a picture.
Sets the contrast modification for the effect.
Sets whether the effect should convert a picture to grayscale.
Sets the
opacity
for the effect.Sets the saturation modification for the effect.
- rtype
str
-
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
-
boundingRect
()¶
-
brightness
(self) → int¶ Returns the brightness modification for the effect.
- Return type
int
- Returns
brightness value. Values are between -255 and 255, where 0 represents no change, negative values indicate darkening and positive values indicate lightening
See also
-
clone
(self) → QgsColorEffect¶ - Return type
-
colorizeColor
(self) → QColor¶ Returns the color used for colorizing a picture. This is only used if colorizeOn() is set to true.
- Return type
QColor
- Returns
colorization color
See also
See also
See also
-
colorizeOn
(self) → bool¶ Returns whether the effect will colorize a picture.
- Return type
bool
- Returns
true if colorization is enableds
See also
See also
See also
-
colorizeStrength
(self) → int¶ Returns the strength used for colorizing a picture. This is only used if setColorizeOn() is set to true.
- Return type
int
- Returns
colorization strength, between 0 and 100
See also
See also
See also
-
contrast
(self) → int¶ Returns the contrast modification for the effect.
- Return type
int
- Returns
contrast value. Values are between -100 and 100, where 0 represents no change, negative values indicate less contrast and positive values indicate greater contrast
See also
-
create
(map: Dict[str, str]) → QgsPaintEffect¶ Creates a new
QgsColorEffect
effect from a properties string map.- Parameters
map (Dict[str) – encoded properties string map
- Return type
- Returns
new QgsColorEffect
-
draw
(self, context: QgsRenderContext)¶ - Parameters
context (QgsRenderContext) –
-
drawSource
()¶
-
fixQPictureDpi
()¶
-
grayscaleMode
(self) → QgsImageOperation.GrayscaleMode¶ Returns whether the effect will convert a picture to grayscale.
- Return type
- Returns
method for grayscale conversion
See also
-
imageOffset
()¶
-
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, str]¶ - Return type
Dict[str, str]
-
readProperties
(self, props: Dict[str, str])¶ - Parameters
props (Dict[str) –
-
saturation
(self) → float¶ Returns the saturation modification for the effect.
- Return type
float
- Returns
saturation value. Values are between 0 and 2.0, where 1.0 represents no change, 0.0 represents totally desaturated (grayscale), and positive values indicate greater saturation
See also
-
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
-
setBrightness
(self, brightness: int)¶ Sets the brightness modification for the effect.
- Parameters
brightness (int) – Valid values are between -255 and 255, where 0 represents no change, negative values indicate darkening and positive values indicate lightening
See also
-
setColorizeColor
(self, colorizeColor: Union[QColor, Qt.GlobalColor, QGradient])¶ Sets the color used for colorizing a picture. This is only used if setColorizeOn() is set to true.
- Parameters
colorizeColor (Union[QColor) – colorization color
See also
See also
See also
-
setColorizeOn
(self, colorizeOn: bool)¶ Sets whether the effect should colorize a picture.
- Parameters
colorizeOn (bool) – set to true to enable colorization
See also
See also
See also
-
setColorizeStrength
(self, colorizeStrength: int)¶ Sets the strength for colorizing a picture. This is only used if setColorizeOn() is set to true.
- Parameters
colorizeStrength (int) – colorization strength, between 0 and 100
See also
See also
See also
-
setContrast
(self, contrast: int)¶ Sets the contrast modification for the effect.
- Parameters
contrast (int) – Valid values are between -100 and 100, where 0 represents no change, negative values indicate less contrast and positive values indicate greater contrast
See also
-
setGrayscaleMode
(self, grayscaleMode: QgsImageOperation.GrayscaleMode)¶ Sets whether the effect should convert a picture to grayscale.
- Parameters
grayscaleMode (QgsImageOperation.GrayscaleMode) – method for grayscale conversion
See also
-
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
-
setSaturation
(self, saturation: float)¶ Sets the saturation modification for the effect.
- Parameters
saturation (float) – Valid values are between 0 and 2.0, where 1.0 represents no change, 0.0 represents totally desaturated (grayscale), and positive values indicate greater saturation
See also
-
source
()¶
-
sourceAsImage
()¶
-
type
(self) → str¶ - Return type
str