Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QWindowsDirect2DBackingStore Class Reference

Backing store for windows. More...

#include <qwindowsdirect2dbackingstore.h>

+ Inheritance diagram for QWindowsDirect2DBackingStore:
+ Collaboration diagram for QWindowsDirect2DBackingStore:

Public Member Functions

 QWindowsDirect2DBackingStore (QWindow *window)
 
 ~QWindowsDirect2DBackingStore ()
 
void beginPaint (const QRegion &) override
 This function is called before painting onto the surface begins, with the region in which the painting will occur.
 
void endPaint () override
 This function is called after painting onto the surface has ended.
 
QPaintDevicepaintDevice () override
 Implement this function to return the appropriate paint device.
 
void flush (QWindow *targetWindow, const QRegion &region, const QPoint &offset) override
 Flushes the given region from the specified window.
 
void resize (const QSize &size, const QRegion &staticContents) override
 
QImage toImage () const override
 Implemented in subclasses to return the content of the backingstore as a QImage.
 
- Public Member Functions inherited from QPlatformBackingStore
 QPlatformBackingStore (QWindow *window)
 Constructs an empty surface for the given top-level window.
 
virtual ~QPlatformBackingStore ()
 Destroys this surface.
 
QWindowwindow () const
 Returns a pointer to the top-level window associated with this surface.
 
QBackingStorebackingStore () 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)
 Flushes the given region from the specified window, and compositing it with the specified textures list.
 
virtual QRhiTexturetoTexture (QRhiResourceUpdateBatch *resourceUpdates, const QRegion &dirtyRegion, TextureFlags *flags) const
 May be reimplemented in subclasses to return the content of the backingstore as an QRhiTexture.
 
virtual QPlatformGraphicsBuffergraphicsBuffer () const
 Accessor for a backingstores graphics buffer abstraction.
 
virtual bool scroll (const QRegion &area, int dx, int dy)
 Scrolls the given area dx pixels to the right and dy downward; both dx and dy may be negative.
 
void setRhiConfig (const QPlatformBackingStoreRhiConfig &config)
 
QRhirhi () const
 
void surfaceAboutToBeDestroyed ()
 
void graphicsDeviceReportedLost ()
 

Additional Inherited Members

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

Detailed Description

Backing store for windows.

Definition at line 13 of file qwindowsdirect2dbackingstore.h.

Constructor & Destructor Documentation

◆ QWindowsDirect2DBackingStore()

QWindowsDirect2DBackingStore::QWindowsDirect2DBackingStore ( QWindow * window)

Definition at line 42 of file qwindowsdirect2dbackingstore.cpp.

◆ ~QWindowsDirect2DBackingStore()

QWindowsDirect2DBackingStore::~QWindowsDirect2DBackingStore ( )

Definition at line 47 of file qwindowsdirect2dbackingstore.cpp.

Member Function Documentation

◆ beginPaint()

void QWindowsDirect2DBackingStore::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 51 of file qwindowsdirect2dbackingstore.cpp.

References clear(), QPainter::CompositionMode_Source, QPainter::fillRect(), nativeWindow(), painter, pixmap, QPainter::setCompositionMode(), Qt::transparent, and QPlatformBackingStore::window().

+ Here is the call graph for this function:

◆ endPaint()

void QWindowsDirect2DBackingStore::endPaint ( )
overridevirtual

This function is called after painting onto the surface has ended.

See also
beginPaint(), paintDevice()

Reimplemented from QPlatformBackingStore.

Definition at line 65 of file qwindowsdirect2dbackingstore.cpp.

References nativeWindow(), pixmap, and QPlatformBackingStore::window().

+ Here is the call graph for this function:

◆ flush()

void QWindowsDirect2DBackingStore::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 75 of file qwindowsdirect2dbackingstore.cpp.

References copy(), nativeWindow(), and QPlatformBackingStore::window().

+ Here is the call graph for this function:

◆ paintDevice()

QPaintDevice * QWindowsDirect2DBackingStore::paintDevice ( )
overridevirtual

Implement this function to return the appropriate paint device.

Implements QPlatformBackingStore.

Definition at line 70 of file qwindowsdirect2dbackingstore.cpp.

References nativeWindow(), and QPlatformBackingStore::window().

+ Here is the call graph for this function:

◆ resize()

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

Implements QPlatformBackingStore.

Definition at line 85 of file qwindowsdirect2dbackingstore.cpp.

References QPixmap::handle(), QPixmap::isNull(), nativeWindow(), platformPixmap(), rect, and QPlatformBackingStore::window().

+ Here is the call graph for this function:

◆ toImage()

QImage QWindowsDirect2DBackingStore::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 98 of file qwindowsdirect2dbackingstore.cpp.

References nativeWindow(), and QPlatformBackingStore::window().

+ Here is the call graph for this function:

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