Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QXcbNativeBackingStore Class Reference

#include <qbackingstore_x11_p.h>

Inheritance diagram for QXcbNativeBackingStore:
Collaboration diagram for QXcbNativeBackingStore:

Public Member Functions

 QXcbNativeBackingStore (QWindow *window)
 ~QXcbNativeBackingStore ()
QPaintDevice * paintDevice () override
 Implement this function to return the appropriate paint device.
void flush (QWindow *window, const QRegion &region, const QPoint &offset) override
 Flushes the given region from the specified window.
QImage toImage () const override
 Implemented in subclasses to return the content of the backingstore as a QImage.
void resize (const QSize &size, const QRegion &staticContents) override
bool scroll (const QRegion &area, int dx, int dy) override
 Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.
void beginPaint (const QRegion &region) override
 This function is called before painting onto the surface begins, with the region in which the painting will occur.
Public Member Functions inherited from QPlatformBackingStore
 QPlatformBackingStore (QWindow *window)
 Constructs an empty surface for the given top-level window.
virtual ~QPlatformBackingStore ()
 Destroys this surface.
QWindow * window () const
 Returns a pointer to the top-level window associated with this surface.
QBackingStore * backingStore () const
 Returns a pointer to the backing store associated with this surface.
virtual FlushResult rhiFlush (QWindow *window, qreal sourceDevicePixelRatio, const QRegion &region, const QPoint &offset, QPlatformTextureList *textures, bool translucentBackground, qreal sourceTransformFactor=0)
 Flushes the given region from the specified window, and compositing it with the specified textures list.
virtual QRhiTexture * toTexture (QRhiResourceUpdateBatch *resourceUpdates, const QRegion &dirtyRegion, TextureFlags *flags) const
 May be reimplemented in subclasses to return the content of the backingstore as an QRhiTexture.
virtual QPlatformGraphicsBuffer * graphicsBuffer () const
 Accessor for a backingstores graphics buffer abstraction.
virtual void endPaint ()
 This function is called after painting onto the surface has ended.
void createRhi (QWindow *window, QPlatformBackingStoreRhiConfig config)
QRhi * rhi (QWindow *window) const
void surfaceAboutToBeDestroyed ()
void graphicsDeviceReportedLost (QWindow *window)

Additional Inherited Members

Public Types inherited from QPlatformBackingStore
enum  FlushResult { FlushSuccess , FlushFailed , FlushFailedDueToLostDevice }
enum  TextureFlag { TextureSwizzle = 0x01 , TextureFlip = 0x02 , TexturePremultiplied = 0x04 }

Detailed Description

Definition at line 15 of file qbackingstore_x11_p.h.

Constructor & Destructor Documentation

◆ QXcbNativeBackingStore()

QT_BEGIN_NAMESPACE QXcbNativeBackingStore::QXcbNativeBackingStore ( QWindow * window)

Definition at line 22 of file qbackingstore_x11.cpp.

◆ ~QXcbNativeBackingStore()

QXcbNativeBackingStore::~QXcbNativeBackingStore ( )

Definition at line 32 of file qbackingstore_x11.cpp.

Member Function Documentation

◆ beginPaint()

void QXcbNativeBackingStore::beginPaint ( const QRegion & )
overridevirtual

This function is called before painting onto the surface begins, with the region in which the painting will occur.

See also
endPaint(), paintDevice()

Reimplemented from QPlatformBackingStore.

Definition at line 151 of file qbackingstore_x11.cpp.

References QX11PlatformPixmap::setIsBackingStore().

Here is the call graph for this function:

◆ flush()

void QXcbNativeBackingStore::flush ( QWindow * window,
const QRegion & region,
const QPoint & offset )
overridevirtual

Flushes the given region from the specified window.

Note
region is relative to the window which may not be top-level in case window corresponds to a native child widget. offset is the position of the native child relative to the top-level window.

Unlike rhiFlush(), this function's default implementation does nothing. It is expected that subclasses provide a platform-specific (non-QRhi-based) implementation, if applicable on the given platform.

See also
rhiFlush()

Reimplemented from QPlatformBackingStore.

Definition at line 40 of file qbackingstore_x11.cpp.

Referenced by testing.tools.encode_pdf_filter._SinkPdfStream::close().

Here is the caller graph for this function:

◆ paintDevice()

QPaintDevice * QXcbNativeBackingStore::paintDevice ( )
overridevirtual

Implement this function to return the appropriate paint device.

Implements QPlatformBackingStore.

Definition at line 35 of file qbackingstore_x11.cpp.

◆ resize()

void QXcbNativeBackingStore::resize ( const QSize & size,
const QRegion & staticContents )
overridevirtual

Implements QPlatformBackingStore.

Definition at line 108 of file qbackingstore_x11.cpp.

◆ scroll()

bool QXcbNativeBackingStore::scroll ( const QRegion & area,
int dx,
int dy )
overridevirtual

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.

Reimplemented from QPlatformBackingStore.

Definition at line 135 of file qbackingstore_x11.cpp.

◆ toImage()

QImage QXcbNativeBackingStore::toImage ( ) const
overridevirtual

Implemented in subclasses to return the content of the backingstore as a QImage.

If composition via a 3D graphics API is supported, either this function or toTexture() must be implemented.

The returned image is only valid until the next operation (resize, paint, scroll, or flush) on the backingstore. The caller must not store the return value between calls, but instead call this function before each use, or make an explicit copy.

See also
toTexture()

Reimplemented from QPlatformBackingStore.

Definition at line 103 of file qbackingstore_x11.cpp.

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