QPaintEngineState

The QPaintEngineState class provides information about the active paint engine’s current state. More

Inheritance diagram of PySide2.QtGui.QPaintEngineState

Synopsis

Functions

Detailed Description

QPaintEngineState records which properties that have changed since the last time the paint engine was updated, as well as their current value.

Which properties that have changed can at any time be retrieved using the state() function. This function returns an instance of the DirtyFlags type which stores an OR combination of DirtyFlag values. The DirtyFlag enum defines whether a property has changed since the last update or not.

If a property is marked with a dirty flag, its current value can be retrieved using the corresponding get function:

Property Flag

Current Property Value

DirtyBackground

backgroundBrush()

DirtyBackgroundMode

backgroundMode()

DirtyBrush

brush()

DirtyBrushOrigin

brushOrigin()

DirtyClipRegion or DirtyClipPath

clipOperation()

DirtyClipPath

clipPath()

DirtyClipRegion

clipRegion()

DirtyCompositionMode

compositionMode()

DirtyFont

font()

DirtyTransform

transform()

DirtyClipEnabled

isClipEnabled()

DirtyPen

pen()

DirtyHints

renderHints()

The QPaintEngineState class also provide the painter() function which returns a pointer to the painter that is currently updating the paint engine.

An instance of this class, representing the current state of the active paint engine, is passed as argument to the updateState() function. The only situation in which you will have to use this class directly is when implementing your own paint engine.

See also

QPaintEngine

class PySide2.QtGui.QPaintEngineState
PySide2.QtGui.QPaintEngineState.dirtyFlags
PySide2.QtGui.QPaintEngineState.backgroundBrush()
Return type

PySide2.QtGui.QBrush

Returns the background brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyBackground flag.

PySide2.QtGui.QPaintEngineState.backgroundMode()
Return type

BGMode

Returns the background mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyBackgroundMode flag.

PySide2.QtGui.QPaintEngineState.brush()
Return type

PySide2.QtGui.QBrush

Returns the brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyBrush flag.

PySide2.QtGui.QPaintEngineState.brushNeedsResolving()
Return type

bool

Returns whether the coordinate of the fill have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

PySide2.QtGui.QPaintEngineState.brushOrigin()
Return type

PySide2.QtCore.QPointF

Returns the brush origin in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyBrushOrigin flag.

PySide2.QtGui.QPaintEngineState.clipOperation()
Return type

ClipOperation

Returns the clip operation in the current paint engine state.

This variable should only be used when the state() returns a combination which includes either the DirtyClipPath or the DirtyClipRegion flag.

PySide2.QtGui.QPaintEngineState.clipPath()
Return type

PySide2.QtGui.QPainterPath

Returns the clip path in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyClipPath flag.

PySide2.QtGui.QPaintEngineState.clipRegion()
Return type

PySide2.QtGui.QRegion

Returns the clip region in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyClipRegion flag.

PySide2.QtGui.QPaintEngineState.compositionMode()
Return type

CompositionMode

Returns the composition mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyCompositionMode flag.

PySide2.QtGui.QPaintEngineState.font()
Return type

PySide2.QtGui.QFont

Returns the font in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyFont flag.

PySide2.QtGui.QPaintEngineState.isClipEnabled()
Return type

bool

Returns whether clipping is enabled or not in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyClipEnabled flag.

PySide2.QtGui.QPaintEngineState.matrix()
Return type

PySide2.QtGui.QMatrix

Note

This function is deprecated.

Use transform() instead.

Returns the matrix in the current paint engine state.

Note

It is advisable to use transform() instead of this function to preserve the properties of perspective transformations.

This variable should only be used when the state() returns a combination which includes the DirtyTransform flag.

PySide2.QtGui.QPaintEngineState.opacity()
Return type

float

Returns the opacity in the current paint engine state.

PySide2.QtGui.QPaintEngineState.painter()
Return type

PySide2.QtGui.QPainter

Returns a pointer to the painter currently updating the paint engine.

PySide2.QtGui.QPaintEngineState.pen()
Return type

PySide2.QtGui.QPen

Returns the pen in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyPen flag.

PySide2.QtGui.QPaintEngineState.penNeedsResolving()
Return type

bool

Returns whether the coordinate of the stroke have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

PySide2.QtGui.QPaintEngineState.renderHints()
Return type

RenderHints

Returns the render hints in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyHints flag.

PySide2.QtGui.QPaintEngineState.state()
Return type

DirtyFlags

Returns a combination of flags identifying the set of properties that need to be updated when updating the paint engine’s state (i.e. during a call to the updateState() function).

See also

updateState()

PySide2.QtGui.QPaintEngineState.transform()
Return type

PySide2.QtGui.QTransform

Returns the matrix in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the DirtyTransform flag.