PySide6.QtGui.QPaintEngineState¶

class QPaintEngineState¶

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

Synopsis¶

Methods¶

def backgroundBrush()
def backgroundMode()
def brush()
def brushNeedsResolving()
def brushOrigin()
def clipOperation()
def clipPath()
def clipRegion()
def compositionMode()
def font()
def isClipEnabled()
def opacity()
def painter()
def pen()
def penNeedsResolving()
def renderHints()
def state()
def transform()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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.

PySide6.QtGui.QPaintEngineState.dirtyFlags¶

backgroundBrush()¶

Return type:: 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.

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.

brush()¶

Return type:: 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.

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

brushOrigin()¶

Return type:: 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.

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.

clipPath()¶

Return type:: 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.

clipRegion()¶

Return type:: 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.

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.

font()¶

Return type:: 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.

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.

opacity()¶

Return type:: float

Returns the opacity in the current paint engine state.

painter()¶

Return type:: QPainter

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

pen()¶

Return type:: 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.

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

renderHints()¶

Return type:: Combination of RenderHint

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.

state()¶

Return type:: Combination of DirtyFlag

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

transform()¶

Return type:: 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.