Class: QgsColorEffect¶
- class qgis.core.QgsColorEffect¶
Bases:
QgsPaintEffect
A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.
New in version 2.9:
Methods
Returns the blend mode for the effect
Returns the bounding rect required for drawing 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:
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 whether the effect will convert a picture to grayscale.
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:
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.
Returns the source QPicture.
Returns the source QPicture rendered to a new QImage.
- 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(self, rect: QRectF, context: QgsRenderContext) QRectF ¶
Returns the bounding rect required for drawing the effect. This method can be used to expand the bounding rect of a source picture to account for offset or blurring effects.
- Parameters:
rect – original source bounding rect
context – destination render context
- Returns:
modified bounding rect
See also
- 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 toTrue
.- 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 enabled
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 toTrue
.- 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, Any]) 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(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
- grayscaleMode(self) QgsImageOperation.GrayscaleMode ¶
Returns whether the effect will convert a picture to grayscale.
- Return type:
- Returns:
method for grayscale conversion
See also
- 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) –
- 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: QColor | Qt.GlobalColor | QGradient)¶
Sets the color used for colorizing a picture. This is only used if
setColorizeOn()
is set toTrue
.- 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 toTrue
.- 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(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