Class: QgsColorEffect

class qgis.core.QgsColorEffect

Bases: qgis._core.QgsPaintEffect

A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.

New in version 2.9: Enums

Methods

blendMode Returns the blend mode for the effect
boundingRect
brightness Returns the brightness modification for the effect.
clone
colorizeColor Returns the color used for colorizing a picture.
colorizeOn Returns whether the effect will colorize a picture.
colorizeStrength Returns the strength used for colorizing a picture.
contrast Returns the contrast modification for the effect.
create Creates a new QgsColorEffect effect from a properties string map.
draw
drawSource
fixQPictureDpi
grayscaleMode Returns whether the effect will convert a picture to grayscale.
imageOffset
opacity Returns the opacity for the effect.
properties
readProperties
saturation Returns the saturation modification for the effect.
setBlendMode Sets the blend mode for the effect
setBrightness Sets the brightness modification for the effect.
setColorizeColor Sets the color used for colorizing a picture.
setColorizeOn Sets whether the effect should colorize a picture.
setColorizeStrength Sets the strength for colorizing a picture.
setContrast Sets the contrast modification for the effect.
setGrayscaleMode Sets whether the effect should convert a picture to grayscale.
setOpacity Sets the opacity for the effect.
setSaturation Sets the saturation modification for the effect.
source
sourceAsImage
type

Signals

Attributes

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

setBlendMode()

boundingRect()
brightness(self) → int

Returns the brightness modification for the effect.

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

setBrightness()

clone(self) → QgsColorEffect
colorizeColor(self) → QColor

Returns the color used for colorizing a picture. This is only used if colorizeOn() is set to True.

Returns:colorization color

See also

colorizeOn()

colorizeOn(self) → bool

Returns whether the effect will colorize a picture.

Returns:True if colorization is enabled

See also

setColorizeOn()

See also

colorizeColor()

colorizeStrength(self) → int

Returns the strength used for colorizing a picture. This is only used if setColorizeOn() is set to True.

Returns:colorization strength, between 0 and 100

See also

colorizeOn()

See also

colorizeColor()

contrast(self) → int

Returns the contrast modification for the effect.

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

setContrast()

create(map: Dict[str, str]) → QgsPaintEffect

Creates a new QgsColorEffect effect from a properties string map.

Parameters:map – encoded properties string map
Returns:new QgsColorEffect
draw(self, context: QgsRenderContext)
drawSource()
fixQPictureDpi()
grayscaleMode(self) → QgsImageOperation.GrayscaleMode

Returns whether the effect will convert a picture to grayscale.

Returns:method for grayscale conversion
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

setOpacity()

properties(self) → Dict[str, str]
readProperties(self, props: Dict[str, str])
saturation(self) → float

Returns the saturation modification for the effect.

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

setSaturation()

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

blendMode()

setBrightness(self, brightness: int)

Sets the brightness modification for the effect.

Parameters:brightness – Valid values are between -255 and 255, where 0 represents no change, negative values indicate darkening and positive values indicate lightening

See also

setBrightness()

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 – colorization color

See also

colorizeColor()

See also

setColorizeOn()

setColorizeOn(self, colorizeOn: bool)

Sets whether the effect should colorize a picture.

Parameters:colorizeOn – set to True to enable colorization

See also

colorizeOn()

setColorizeStrength(self, colorizeStrength: int)

Sets the strength for colorizing a picture. This is only used if setColorizeOn() is set to True.

Parameters:colorizeStrength – colorization strength, between 0 and 100

See also

setColorizeOn()

setContrast(self, contrast: int)

Sets the contrast modification for the effect.

Parameters:contrast – 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

setContrast()

setGrayscaleMode(self, grayscaleMode: QgsImageOperation.GrayscaleMode)

Sets whether the effect should convert a picture to grayscale.

Parameters:grayscaleMode – method for grayscale conversion

See also

grayscaleMode()

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

opacity()

setSaturation(self, saturation: float)

Sets the saturation modification for the effect.

Parameters:saturation – 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

saturation()

source()
sourceAsImage()
type(self) → str