PySide6.QtGui.QBackingStore¶

class QBackingStore¶

The QBackingStore class provides a drawing area for QWindow .

Details

QBackingStore enables the use of QPainter to paint on a QWindow with type RasterSurface. The other way of rendering to a QWindow is through the use of OpenGL with QOpenGLContext .

A QBackingStore contains a buffered representation of the window contents, and thus supports partial updates by using QPainter to only update a sub region of the window contents.

QBackingStore might be used by an application that wants to use QPainter without OpenGL acceleration and without the extra overhead of using the QWidget or QGraphicsView UI stacks. For an example of how to use QBackingStore see the Raster Window Example .

Synopsis¶

Methods¶

def __init__()
def beginPaint()
def endPaint()
def flush()
def hasStaticContents()
def paintDevice()
def resize()
def scroll()
def setStaticContents()
def size()
def staticContents()
def window()

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

__init__(window)¶

Parameters:: window – QWindow

Constructs an empty surface for the given top-level window.

beginPaint(region)¶

Parameters:: region – QRegion

Begins painting on the backing store surface in the given region.

You should call this function before using the paintDevice() to paint.

See also

endPaint() paintDevice()

endPaint()¶

Ends painting.

You should call this function after painting with the paintDevice() has ended.

See also

beginPaint() paintDevice()

flush(region[, window=None[, offset=QPoint()]])¶

Parameters:

region – QRegion
window – QWindow
offset – QPoint

Flushes the given region from the specified window onto the screen.

The window must either be the top level window represented by this backingstore, or a non-transient child of that window. Passing None falls back to using the backingstore’s top level window.

If the window is a child window, the region should be in child window coordinates, and the offset should be the child window’s offset in relation to the backingstore’s top level window.

You should call this function after ending painting with endPaint() .

hasStaticContents()¶

Return type:: bool

Returns a boolean indicating if this window has static contents or not.

paintDevice()¶

Return type:: QPaintDevice

Returns the paint device for this surface.

Warning

The device is only valid between calls to beginPaint() and endPaint() . You should not cache the returned value.

resize(size)¶

Parameters:: size – QSize

Sets the size of the window surface to size.

See also

size()

scroll(area, dx, dy)¶

Parameters:

area – QRegion
dx – int
dy – int

Return type:

bool

Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.

Returns true if the area was scrolled successfully; false otherwise.

setStaticContents(region)¶

Parameters:: region – QRegion

Set region as the static contents of this window.

See also

staticContents()

size()¶

Return type:: QSize

Returns the current size of the window surface.

staticContents()¶

Return type:: QRegion

Returns a QRegion representing the area of the window that has static contents.

See also

setStaticContents()

window()¶

Return type:: QWindow

Returns a pointer to the top-level window associated with this surface.