Class: QgsColorEffect

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

Class Hierarchy

Base classes

QgsPaintEffect

Base class for visual effects which can be applied to QPicture drawings.

class qgis.core.QgsColorEffect

Bases: QgsPaintEffect

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

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

setBrightness()

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

setColorizeColor()

See also

colorizeOn()

See also

colorizeStrength()

colorizeOn(self) → bool

Returns whether the effect will colorize a picture.

Return type:

bool

Returns:

True if colorization is enabled

See also

setColorizeOn()

See also

colorizeColor()

See also

colorizeStrength()

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

setColorizeStrength()

See also

colorizeOn()

See also

colorizeColor()

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

setContrast()

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

Creates a new QgsColorEffect effect from a properties string map.

Parameters:

map (Dict[str, Any]) – encoded properties string map

Return type:

Optional[QgsPaintEffect]

Returns:

new QgsColorEffect

grayscaleMode(self) → QgsImageOperation.GrayscaleMode

Returns whether the effect will convert a picture to grayscale.

Return type:

QgsImageOperation.GrayscaleMode

Returns:

method for grayscale conversion

See also

setGrayscaleMode()

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

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

setSaturation()

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

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

setBrightness()

setColorizeColor(self, colorizeColor: QColor | Qt.GlobalColor)

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

Parameters:

colorizeColor (Union[QColor, Qt.GlobalColor]) – colorization color

See also

colorizeColor()

See also

setColorizeOn()

See also

setColorizeStrength()

setColorizeOn(self, colorizeOn: bool)

Sets whether the effect should colorize a picture.

Parameters:

colorizeOn (bool) – set to True to enable colorization

See also

colorizeOn()

See also

setColorizeColor()

See also

setColorizeStrength()

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

colorizeStrength()

See also

setColorizeOn()

See also

setColorizeColor()

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

setContrast()

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

grayscaleMode()

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

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

saturation()