QBrush¶
- PyQt5.QtGui.QBrush
Description¶
The QBrush class defines the fill pattern of shapes drawn by QPainter.
A brush has a style, a color, a gradient and a texture.
The brush style() defines the fill pattern using the BrushStyle enum. The default brush style is NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is SolidPattern. The style can be set when the brush is created using the appropriate constructor, and in addition the setStyle() function provides means for altering the style once the brush is constructed.
The brush color() defines the color of the fill pattern. The color can either be one of Qt’s predefined colors, GlobalColor, or any other custom QColor. The currently set color can be retrieved and altered using the color() and setColor() functions, respectively.
The gradient() defines the gradient fill used when the current style is either LinearGradientPattern, RadialGradientPattern or ConicalGradientPattern. Gradient brushes are created by giving a QGradient as a constructor argument when creating the QBrush. Qt provides three different gradients: QLinearGradient, QConicalGradient, and QRadialGradient - all of which inherit QGradient.
# QRadialGradient gradient(50, 50, 50, 50, 50);
# gradient.setColorAt(0, QColor::fromRgbF(0, 1, 0, 1));
# gradient.setColorAt(1, QColor::fromRgbF(0, 0, 0, 0));
# QBrush brush(gradient);
The texture() defines the pixmap used when the current style is TexturePattern. You can create a brush with a texture by providing the pixmap when the brush is created or by using setTexture().
Note that applying setTexture() makes style() == TexturePattern, regardless of previous style settings. Also, calling setColor() will not make a difference if the style is a gradient. The same is the case if the style is TexturePattern style unless the current texture is a QBitmap.
The isOpaque() function returns true if the brush is fully opaque otherwise false. A brush is considered opaque if:
The alpha component of the color() is 255.
Its texture() does not have an alpha channel and is not a QBitmap.
The colors in the gradient() all have an alpha component that is 255.
|
To specify the style and color of lines and outlines, use the QPainter’s QPen combined with PenStyle and GlobalColor: # QPainter painter(this);
# painter.setBrush(Qt::cyan);
# painter.setPen(Qt::darkCyan);
# painter.drawRect(0, 0, 100,100);
# painter.setBrush(Qt::NoBrush);
# painter.setPen(Qt::darkGreen);
# painter.drawRect(40, 40, 100, 100);
Note that, by default, QPainter renders the outline (using the currently set pen) when drawing shapes. Use NoPen to disable this behavior. |
For more information about painting in general, see the Paint System.
See also
Methods¶
- __init__()
Constructs a default black brush with the style NoBrush (i.e. this brush will not fill shapes).
- __init__(BrushStyle)
Constructs a black brush with the given style.
See also
- __init__(QPixmap)
Constructs a brush with a black color and a texture set to the given pixmap. The style is set to TexturePattern.
See also
- __init__(QImage)
Constructs a brush with a black color and a texture set to the given image. The style is set to TexturePattern.
See also
- __init__(Union[QBrush, QColor, GlobalColor, QGradient])
Constructs a copy of other.
- __init__(Any)
TODO
- __init__(Union[QColor, GlobalColor], style: BrushStyle = SolidPattern)
Constructs a brush with the given color and style.
See also
- __init__(Union[QColor, GlobalColor], QPixmap)
Constructs a brush with the given color and the custom pattern stored in pixmap.
The style is set to TexturePattern. The color will only have an effect for QBitmaps.
See also
- color() → QColor
See also
- __eq__(Union[QBrush, QColor, GlobalColor, QGradient]) → bool
TODO
- gradient() → QGradient
Returns the gradient describing this brush.
- isOpaque() → bool
Returns
trueif the brush is fully opaque otherwise false. A brush is considered opaque if:The alpha component of the color() is 255.
Its texture() does not have an alpha channel and is not a QBitmap.
The colors in the gradient() all have an alpha component that is 255.
It is an extended radial gradient.
- __ne__(Union[QBrush, QColor, GlobalColor, QGradient]) → bool
TODO
- setColor(Union[QColor, GlobalColor, QGradient])
See also
- setColor(GlobalColor)
TODO
- setStyle(BrushStyle)
Sets the brush style to style.
See also
- setTexture(QPixmap)
Sets the brush pixmap to pixmap. The style is set to TexturePattern.
The current brush color will only have an effect for monochrome pixmaps, i.e. for depth() == 1 (QBitmap).
See also
- setTextureImage(QImage)
Sets the brush image to image. The style is set to TexturePattern.
Note the current brush color will not have any affect on monochrome images, as opposed to calling setTexture() with a QBitmap. If you want to change the color of monochrome image brushes, either convert the image to QBitmap with
QBitmap::fromImage()and set the resulting QBitmap as a texture, or change the entries in the color table for the image.See also
- setTransform(QTransform)
Sets matrix as an explicit transformation matrix on the current brush. The brush transformation matrix is merged with QPainter transformation matrix to produce the final result.
See also
- style() → BrushStyle
See also
- swap(QBrush)
TODO
- texture() → QPixmap
See also
- textureImage() → QImage
Returns the custom brush pattern, or a null image if no custom brush pattern has been set.
If the texture was set as a QPixmap it will be converted to a QImage.
See also
- transform() → QTransform
See also
