\inmodule QtGui More...

#include <qbrush.h>

Collaboration diagram for QBrush:

Public Types
using	DataPtr = std::unique_ptr<QBrushData, QBrushDataPointerDeleter>

Public Member Functions
	QBrush ()
	Constructs a default black brush with the style Qt::NoBrush (i.e.

	QBrush (Qt::BrushStyle bs)
	Constructs a black brush with the given style.

	QBrush (const QColor &color, Qt::BrushStyle bs=Qt::SolidPattern)
	Constructs a brush with the given color and style.

	QBrush (Qt::GlobalColor color, Qt::BrushStyle bs=Qt::SolidPattern)
	Constructs a brush with the given color and style.

	QBrush (const QColor &color, const QPixmap &pixmap)
	Constructs a brush with the given color and the custom pattern stored in pixmap.

	QBrush (Qt::GlobalColor color, const QPixmap &pixmap)
	Constructs a brush with the given color and the custom pattern stored in pixmap.

	QBrush (const QPixmap &pixmap)
	Constructs a brush with a black color and a texture set to the given pixmap.

	QBrush (const QImage &image)
	Constructs a brush with a black color and a texture set to the given image.

	QBrush (const QBrush &brush)
	Constructs a copy of other.

	QBrush (const QGradient &gradient)
	Constructs a brush based on the given gradient.

	~QBrush ()
	Destroys the brush.

QBrush &	operator= (const QBrush &brush)
	Assigns the given brush to this brush and returns a reference to this brush.

void	swap (QBrush &other) noexcept

	operator QVariant () const
	Returns the brush as a QVariant.

Qt::BrushStyle	style () const
	Returns the brush style.

void	setStyle (Qt::BrushStyle)
	Sets the brush style to style.

QTransform	transform () const

void	setTransform (const QTransform &)

QPixmap	texture () const
	Returns the custom brush pattern, or a null pixmap if no custom brush pattern has been set.

void	setTexture (const QPixmap &pixmap)
	Sets the brush pixmap to pixmap.

QImage	textureImage () const

void	setTextureImage (const QImage &image)

const QColor &	color () const
	Returns the brush color.

void	setColor (const QColor &color)
	Sets the brush color to the given color.

void	setColor (Qt::GlobalColor color)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the brush color to the given color.

const QGradient *	gradient () const
	Returns the gradient describing this brush.

bool	isOpaque () const
	Returns `true` if the brush is fully opaque otherwise false.

bool	operator== (const QBrush &b) const
	Returns `true` if the brush is equal to the given brush; otherwise returns `false`.

bool	operator!= (const QBrush &b) const
	Returns `true` if the brush is different from the given brush; otherwise returns `false`.

bool	isDetached () const

DataPtr &	data_ptr ()

Friends
class	QRasterPaintEngine

class	QRasterPaintEnginePrivate

struct	QSpanData

class	QPainter

bool Q_GUI_EXPORT	qHasPixmapTexture (const QBrush &brush)

Related Symbols
(Note that these are not member symbols.)
QDataStream &	operator<< (QDataStream &stream, const QBrush &brush)
	Writes the given brush to the given stream and returns a reference to the stream.

QDataStream &	operator>> (QDataStream &stream, QBrush &brush)
	Reads the given brush from the given stream and returns a reference to the stream.

Detailed Description

\inmodule QtGui

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 Qt::BrushStyle enum. The default brush style is Qt::NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is Qt::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.

Brush Styles

The brush color() defines the color of the fill pattern. The color can either be one of Qt's predefined colors, Qt::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 Qt::LinearGradientPattern, Qt::RadialGradientPattern or Qt::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 Qt::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() == Qt::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 Qt::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:

\list

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. \endlist

\table 100% \row

\inlineimage brush-outline.png Outlines

To specify the style and color of lines and outlines, use the QPainter's \l {QPen}{pen} combined with Qt::PenStyle and Qt::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 \l {Qt::NoPen}{painter.setPen(Qt::NoPen)} to disable this behavior.

\endtable

For more information about painting in general, see the \l{Paint System}.

See also: Qt::BrushStyle, QPainter, QColor

Definition at line 29 of file qbrush.h.

Member Typedef Documentation

◆ DataPtr

QBrush::DataPtr = std::unique_ptr<QBrushData, QBrushDataPointerDeleter>

Definition at line 77 of file qbrush.h.

Constructor & Destructor Documentation

◆ QBrush() [1/10]

QBrush::QBrush ( )

Constructs a default black brush with the style Qt::NoBrush (i.e.

this brush will not fill shapes).

Definition at line 393 of file qbrush.cpp.

References Q_ASSERT.

◆ QBrush() [2/10]

QBrush::QBrush ( Qt::BrushStyle style )

Constructs a black brush with the given style.

See also: setStyle()

Definition at line 433 of file qbrush.cpp.

◆ QBrush() [3/10]

QBrush::QBrush	(	const QColor &	color,
		Qt::BrushStyle	style = Qt::SolidPattern )

Constructs a brush with the given color and style.

See also: setColor(), setStyle()

Definition at line 444 of file qbrush.cpp.

References nullBrushInstance(), qbrush_check_type(), and style().

Here is the call graph for this function:

◆ QBrush() [4/10]

QBrush::QBrush	(	Qt::GlobalColor	color,
		Qt::BrushStyle	style = Qt::SolidPattern )

Constructs a brush with the given color and style.

See also: setColor(), setStyle()

Definition at line 461 of file qbrush.cpp.

◆ QBrush() [5/10]

QBrush::QBrush	(	const QColor &	color,
		const QPixmap &	pixmap )

Constructs a brush with the given color and the custom pattern stored in pixmap.

The style is set to Qt::TexturePattern. The color will only have an effect for QBitmaps.

See also: setColor(), setTexture()

Definition at line 476 of file qbrush.cpp.

References pixmap, setTexture(), and Qt::TexturePattern.

Here is the call graph for this function:

◆ QBrush() [6/10]

QBrush::QBrush	(	Qt::GlobalColor	color,
		const QPixmap &	pixmap )

Constructs a brush with the given color and the custom pattern stored in pixmap.

The style is set to Qt::TexturePattern. The color will only have an effect for QBitmaps.

See also: setColor(), setTexture()

Definition at line 492 of file qbrush.cpp.

References pixmap, setTexture(), and Qt::TexturePattern.

Here is the call graph for this function:

◆ QBrush() [7/10]

QBrush::QBrush ( const QPixmap & pixmap )

Constructs a brush with a black color and a texture set to the given pixmap.

The style is set to Qt::TexturePattern.

See also: setTexture()

Definition at line 407 of file qbrush.cpp.

References Qt::black, pixmap, setTexture(), and Qt::TexturePattern.

Here is the call graph for this function:

◆ QBrush() [8/10]

QBrush::QBrush ( const QImage & image )

Constructs a brush with a black color and a texture set to the given image.

The style is set to Qt::TexturePattern.

See also: setTextureImage()

Definition at line 421 of file qbrush.cpp.

References Qt::black, setTextureImage(), and Qt::TexturePattern.

Here is the call graph for this function:

◆ QBrush() [9/10]

QBrush::QBrush ( const QBrush & brush )

Constructs a copy of other.

Definition at line 502 of file qbrush.cpp.

◆ QBrush() [10/10]

QBrush::QBrush ( const QGradient & gradient )

Constructs a brush based on the given gradient.

The brush style is set to the corresponding gradient style (either Qt::LinearGradientPattern, Qt::RadialGradientPattern or Qt::ConicalGradientPattern).

Definition at line 515 of file qbrush.cpp.

References Qt::ConicalGradientPattern, QGradientBrushData::gradient, gradient(), Qt::LinearGradientPattern, QGradient::NoGradient, nullBrushInstance(), Q_UNLIKELY, Qt::RadialGradientPattern, and QGradient::type().

Here is the call graph for this function:

◆ ~QBrush()

QBrush::~QBrush ( )

Destroys the brush.

Definition at line 538 of file qbrush.cpp.

Member Function Documentation

◆ color()

const QColor & QBrush::color ( ) const

inline

Returns the brush color.

See also: setColor()

Definition at line 121 of file qbrush.h.

References d.

Referenced by QQuickTextNodeEngine::addBorder(), QQuickTextNodeEngine::addFrameDecorations(), QQuickTextNodeEngine::addText(), QQuickTextNodeEngine::addTextBlock(), QPen::color(), QQuickTextSelection::color(), QQC2::QCommonStyle::drawComplexControl(), QQC2::QWindowsStyle::drawComplexControl(), QCommonStyle::drawComplexControl(), QAndroidStyle::AndroidControl::drawControl(), QQC2_NAMESPACE::QMacStyle::drawControl(), QQC2::QCommonStyle::drawControl(), QQC2::QWindowsStyle::drawControl(), QMacStyle::drawControl(), QCommonStyle::drawControl(), QWindows11Style::drawControl(), QQC2::QStyleHelper::drawDial(), QStyle::drawItemText(), QQC2::QStyle::drawItemText(), QWindows11Style::drawPrimitive(), QQC2_NAMESPACE::QMacStyle::drawPrimitive(), QQC2::QCommonStyle::drawPrimitive(), QQC2::QWindowsStyle::drawPrimitive(), QMacStyle::drawPrimitive(), QCommonStyle::drawPrimitive(), QLCDNumberPrivate::drawSegment(), QWin32PrintEngine::drawTextItem(), QTextEditPrivate::paint(), QCommandLinkButton::paintEvent(), QLineEdit::paintEvent(), QWizardHeader::paintEvent(), QWindowsVistaStyle::polish(), QWindows11Style::polish(), qDrawShadeLine(), QQC2::qDrawShadeLine(), qDrawShadePanel(), QQC2::qDrawShadePanel(), qDrawShadeRect(), QQC2::qDrawShadeRect(), qDrawWinButton(), QQC2::qDrawWinButton(), qDrawWinPanel(), QQC2::qDrawWinPanel(), qt_ensure_default_accent_color(), qt_mac_createSystemPalette(), QWizardPrivate::recreateLayout(), QPainter::setBackground(), QPalette::setColorGroup(), QWindows11Style::styleHint(), toolTipPalette(), QPicturePaintEngine::updateBackground(), and QOpenGL2PaintEngineExPrivate::updateBrushUniforms().

◆ data_ptr()

DataPtr & QBrush::data_ptr ( )

inline

Definition at line 91 of file qbrush.h.

References d.

◆ gradient()

const QGradient * QBrush::gradient ( ) const

Returns the gradient describing this brush.

Definition at line 791 of file qbrush.cpp.

References Qt::ConicalGradientPattern, gradient(), Qt::LinearGradientPattern, and Qt::RadialGradientPattern.

Referenced by QBrush(), gradient(), isOpaque(), QOpenGL2PaintEngineExPrivate::updateBrushTexture(), and QOpenGL2PaintEngineExPrivate::updateBrushUniforms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDetached()

bool QBrush::isDetached ( ) const

inline

Definition at line 123 of file qbrush.h.

References d.

◆ isOpaque()

bool QBrush::isOpaque ( ) const

Returns true if the brush is fully opaque otherwise false.

A brush is considered opaque if:

\list

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. \endlist

Definition at line 830 of file qbrush.cpp.

References QList< T >::at(), Qt::ConicalGradientPattern, gradient(), QImage::hasAlphaChannel(), QPixmap::hasAlphaChannel(), i, QPixmap::isQBitmap(), Qt::LinearGradientPattern, qHasPixmapTexture, qt_isExtendedRadialGradient(), Qt::RadialGradientPattern, QList< T >::size(), Qt::SolidPattern, QGradient::stops(), texture(), textureImage(), and Qt::TexturePattern.

Referenced by QPaintEngineEx::drawPoints(), QPaintEngineEx::drawPoints(), QOpenGL2PaintEngineExPrivate::fill(), QWidgetPrivate::init(), QGraphicsView::paintEvent(), and QAlphaPaintEngine::updateState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator QVariant()

QBrush::operator QVariant ( ) const

Returns the brush as a QVariant.

Definition at line 636 of file qbrush.cpp.

References QVariant::fromValue().

Here is the call graph for this function:

◆ operator!=()

bool QBrush::operator!= ( const QBrush & brush ) const

inline

Returns true if the brush is different from the given brush; otherwise returns false.

Two brushes are different if they have different styles, colors or transforms or different pixmaps or gradients depending on the style.

See also: operator==()

Definition at line 75 of file qbrush.h.

References operator==().

Here is the call graph for this function:

◆ operator=()

QBrush & QBrush::operator= ( const QBrush & brush )

Assigns the given brush to this brush and returns a reference to this brush.

Move-assigns other to this QBrush instance.

Since: 5.2

Definition at line 607 of file qbrush.cpp.

◆ operator==()

bool QBrush::operator== ( const QBrush & brush ) const

Returns true if the brush is equal to the given brush; otherwise returns false.

Two brushes are equal if they have equal styles, colors and transforms and equal pixmaps or gradients depending on the style.

See also: operator!=()

Definition at line 898 of file qbrush.cpp.

References QPixmap::cacheKey(), Qt::ConicalGradientPattern, d1, d2, Qt::LinearGradientPattern, qHasPixmapTexture, Qt::RadialGradientPattern, QPlatformPixmap::RasterClass, and Qt::TexturePattern.

Here is the call graph for this function:

◆ setColor() [1/2]

void QBrush::setColor ( const QColor & color )

Sets the brush color to the given color.

Note that calling setColor() will not make a difference if the style is a gradient. The same is the case if the style is Qt::TexturePattern style unless the current texture is a QBitmap.

See also: color()

Definition at line 687 of file qbrush.cpp.

Referenced by QSvgAnimateColor::apply(), QWindows11Style::drawPrimitive(), and setColor().

Here is the caller graph for this function:

◆ setColor() [2/2]

void QBrush::setColor ( Qt::GlobalColor color )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the brush color to the given color.

Definition at line 94 of file qbrush.h.

References setColor().

Here is the call graph for this function:

◆ setStyle()

void QBrush::setStyle ( Qt::BrushStyle style )

Sets the brush style to style.

See also: style()

Definition at line 655 of file qbrush.cpp.

References qbrush_check_type(), and style().

Referenced by QPdfEngine::updateState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTexture()

void QBrush::setTexture ( const QPixmap & pixmap )

Sets the brush pixmap to pixmap.

The style is set to Qt::TexturePattern.

The current brush color will only have an effect for monochrome pixmaps, i.e. for QPixmap::depth() == 1 (\l {QBitmap}{QBitmaps}).

See also: texture()

Definition at line 728 of file qbrush.cpp.

References Qt::NoBrush, pixmap, QTexturedBrushData::setPixmap(), and Qt::TexturePattern.

Referenced by QBrush(), QBrush(), QBrush(), and QTextHtmlParserNode::applyForegroundImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTextureImage()

void QBrush::setTextureImage ( const QImage & image )

Since: 4.2

Sets the brush image to image. The style is set to Qt::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: textureImage(), setTexture()

Definition at line 776 of file qbrush.cpp.

References Qt::NoBrush, QTexturedBrushData::setImage(), and Qt::TexturePattern.

Referenced by QBrush().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTransform()

void QBrush::setTransform ( const QTransform & matrix )

Since: 4.3

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

Definition at line 867 of file qbrush.cpp.

◆ style()

Qt::BrushStyle QBrush::style ( ) const

inline

Returns the brush style.

See also: setStyle()

Definition at line 120 of file qbrush.h.

References d.

Referenced by QBrush(), QQuickTextNodeEngine::addFrameDecorations(), QQuickTextNodeEngine::addText(), QQuickTextNodeEngine::addTextBlock(), drawBackground(), QTextDocumentLayoutPrivate::drawTableCell(), QWin32PrintEngine::drawTextItem(), QWidgetPrivate::drawWidget(), QOpenGL2PaintEngineExPrivate::fill(), QPainter::fillRect(), QPainter::fillRect(), QWidgetPrivate::init(), QPen::isSolid(), QOpenGL2PaintEngineExPrivate::prepareForDraw(), qpen_style(), QPainter::setBackground(), QOpenGL2PaintEngineExPrivate::setBrush(), QPainter::setPen(), setStyle(), QSvgNode::strokeWidth(), QPicturePaintEngine::updateBackground(), QOpenGL2PaintEngineExPrivate::updateBrushTexture(), QOpenGL2PaintEngineExPrivate::updateBrushUniforms(), and QAlphaPaintEngine::updateState().

Here is the caller graph for this function:

◆ swap()

void QBrush::swap ( QBrush & other )

inlinenoexcept

Since: 4.8

Swaps brush other with this brush. This operation is very fast and never fails.

Definition at line 49 of file qbrush.h.

References d, and other().

Here is the call graph for this function:

◆ texture()

QPixmap QBrush::texture ( ) const

Returns the custom brush pattern, or a null pixmap if no custom brush pattern has been set.

See also: setTexture()

Definition at line 711 of file qbrush.cpp.

References Qt::TexturePattern.

Referenced by QWidgetPrivate::drawWidget(), isOpaque(), and QOpenGL2PaintEngineExPrivate::updateBrushUniforms().

Here is the caller graph for this function:

◆ textureImage()

QImage QBrush::textureImage ( ) const

Since: 4.2

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

Definition at line 752 of file qbrush.cpp.

References Qt::TexturePattern.

Referenced by isOpaque(), and QOpenGL2PaintEngineExPrivate::updateBrushTexture().

Here is the caller graph for this function:

◆ transform()

QTransform QBrush::transform ( ) const

inline

Since: 4.3

Returns the current transformation matrix for the brush.

See also: setTransform()

Definition at line 122 of file qbrush.h.

References d.

Referenced by QOpenGL2PaintEngineExPrivate::setBrush(), QOpenGL2PaintEngineExPrivate::updateBrushUniforms(), and QRasterPaintEngine::updatePen().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ operator<<()

QDataStream & operator<<	(	QDataStream &	stream,
		const QBrush &	brush )

See also: {Serializing Qt Data Types}

Definition at line 998 of file qbrush.cpp.

References Qt::ConicalGradientPattern, QGradient::coordinateMode(), i, QGradient::interpolationMode(), QGradient::LinearGradient, Qt::LinearGradientPattern, Qt::NoBrush, QGradient::ObjectBoundingMode, QGradient::ObjectMode, QGradient::RadialGradient, Qt::RadialGradientPattern, QGradient::spread(), QGradient::stops(), Qt::TexturePattern, and QGradient::type().

Here is the call graph for this function:

◆ operator>>()

QDataStream & operator>>	(	QDataStream &	stream,
		QBrush &	brush )

See also: {Serializing Qt Data Types}

Definition at line 1074 of file qbrush.cpp.

References QGradient::ColorInterpolation, Qt::ConicalGradientPattern, i, QGradient::LinearGradient, Qt::LinearGradientPattern, QGradient::LogicalMode, p1, p2, QGradient::PadSpread, QGradient::RadialGradient, Qt::RadialGradientPattern, QList< T >::reserve(), QGradient::setCoordinateMode(), QGradient::setInterpolationMode(), QGradient::setSpread(), QGradient::setStops(), and Qt::TexturePattern.

Here is the call graph for this function:

◆ qHasPixmapTexture

bool Q_GUI_EXPORT qHasPixmapTexture ( const QBrush & brush )

friend

Definition at line 202 of file qbrush.cpp.

Referenced by isOpaque(), and operator==().

◆ QPainter

friend class QPainter

friend

Definition at line 83 of file qbrush.h.

◆ QRasterPaintEngine

friend class QRasterPaintEngine

friend

Definition at line 80 of file qbrush.h.

◆ QRasterPaintEnginePrivate

friend class QRasterPaintEnginePrivate

friend

Definition at line 81 of file qbrush.h.

◆ QSpanData

friend struct QSpanData

friend

Definition at line 82 of file qbrush.h.

The documentation for this class was generated from the following files:

qtbase/src/gui/painting/qbrush.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/gui/painting/qbrush.cpp (6376b1c5a708ddb1a82e81cbc7ce4df159ba565b)

Public Types

Public Member Functions

Friends

Related Symbols

Detailed Description

Member Typedef Documentation

◆ DataPtr

Constructor & Destructor Documentation

◆ QBrush() [1/10]

◆ QBrush() [2/10]

◆ QBrush() [3/10]

◆ QBrush() [4/10]

◆ QBrush() [5/10]

◆ QBrush() [6/10]

◆ QBrush() [7/10]

◆ QBrush() [8/10]

◆ QBrush() [9/10]

◆ QBrush() [10/10]

◆ ~QBrush()

Member Function Documentation

◆ color()

◆ data_ptr()

◆ gradient()

◆ isDetached()

◆ isOpaque()

◆ operator QVariant()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setStyle()

◆ setTexture()

◆ setTextureImage()

◆ setTransform()

◆ style()

◆ swap()

◆ texture()

◆ textureImage()

◆ transform()

Friends And Related Symbol Documentation

◆ operator<<()

◆ operator>>()

◆ qHasPixmapTexture

◆ QPainter

◆ QRasterPaintEngine

◆ QRasterPaintEnginePrivate

◆ QSpanData