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
QSGLayer Class Referenceabstract

#include <qsgadaptationlayer_p.h>

+ Inheritance diagram for QSGLayer:
+ Collaboration diagram for QSGLayer:

Public Types

enum  Format { RGBA8 = 1 , RGBA16F , RGBA32F }
 
- Public Types inherited from QSGTexture
enum  WrapMode { Repeat , ClampToEdge , MirroredRepeat }
 Specifies how the sampler should treat texture coordinates. More...
 
enum  Filtering { None , Nearest , Linear }
 Specifies how sampling of texels should filter when texture coordinates are not pixel aligned. More...
 
enum  AnisotropyLevel {
  AnisotropyNone , Anisotropy2x , Anisotropy4x , Anisotropy8x ,
  Anisotropy16x
}
 Specifies the anisotropic filtering level to be used when the texture is not screen aligned. More...
 

Signals

void updateRequested ()
 
void scheduledUpdateCompleted ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 ~QSGLayer () override
 
virtual void setItem (QSGNode *item)=0
 
virtual void setRect (const QRectF &logicalRect)=0
 
virtual void setSize (const QSize &pixelSize)=0
 
virtual void scheduleUpdate ()=0
 
virtual QImage toImage () const =0
 
virtual void setLive (bool live)=0
 
virtual void setRecursive (bool recursive)=0
 
virtual void setFormat (Format format)=0
 
virtual void setHasMipmaps (bool mipmap)=0
 
virtual void setDevicePixelRatio (qreal ratio)=0
 
virtual void setMirrorHorizontal (bool mirror)=0
 
virtual void setMirrorVertical (bool mirror)=0
 
virtual void setSamples (int samples)=0
 
virtual Q_SLOT void markDirtyTexture ()=0
 
virtual Q_SLOT void invalidated ()=0
 
- Public Member Functions inherited from QSGDynamicTexture
 QSGDynamicTexture ()=default
 
 ~QSGDynamicTexture () override
 
virtual bool updateTexture ()=0
 Call this function to explicitly update the dynamic texture.
 
- Public Member Functions inherited from QSGTexture
 QSGTexture ()
 Constructs the QSGTexture base class.
 
 ~QSGTexture () override
 Destroys the QSGTexture.
 
virtual qint64 comparisonKey () const =0
 Returns a key suitable for comparing textures.
 
virtual QRhiTexturerhiTexture () const
 
virtual QSize textureSize () const =0
 Returns the size of the texture in pixels.
 
virtual bool hasAlphaChannel () const =0
 Returns true if the texture data contains an alpha channel.
 
virtual bool hasMipmaps () const =0
 Returns true if the texture data contains mipmap levels.
 
virtual QRectF normalizedTextureSubRect () const
 Returns the rectangle inside textureSize() that this texture represents in normalized coordinates.
 
virtual bool isAtlasTexture () const
 Returns whether this texture is part of an atlas or not.
 
virtual QSGTextureremovedFromAtlas (QRhiResourceUpdateBatch *resourceUpdates=nullptr) const
 This function returns a copy of the current texture which is removed from its atlas.
 
virtual void commitTextureOperations (QRhi *rhi, QRhiResourceUpdateBatch *resourceUpdates)
 Call this function to enqueue image upload operations to resourceUpdates, in case there are any pending ones.
 
void setMipmapFiltering (Filtering filter)
 Sets the mipmap sampling mode to filter.
 
QSGTexture::Filtering mipmapFiltering () const
 Returns whether mipmapping should be used when sampling from this texture.
 
void setFiltering (Filtering filter)
 Sets the sampling mode to filter.
 
QSGTexture::Filtering filtering () const
 Returns the sampling mode to be used for this texture.
 
void setAnisotropyLevel (AnisotropyLevel level)
 Sets the level of anisotropic filtering to level.
 
QSGTexture::AnisotropyLevel anisotropyLevel () const
 Returns the anisotropy level in use for filtering this texture.
 
void setHorizontalWrapMode (WrapMode hwrap)
 Sets the horizontal wrap mode to hwrap.
 
QSGTexture::WrapMode horizontalWrapMode () const
 Returns the horizontal wrap mode to be used for this texture.
 
void setVerticalWrapMode (WrapMode vwrap)
 Sets the vertical wrap mode to vwrap.
 
QSGTexture::WrapMode verticalWrapMode () const
 Returns the vertical wrap mode to be used for this texture.
 
QRectF convertToNormalizedSourceRect (const QRectF &rect) const
 Returns rect converted to normalized coordinates.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

 QSGLayer (QSGTexturePrivate &dd)
 
- Protected Member Functions inherited from QSGDynamicTexture
 QSGDynamicTexture (QSGTexturePrivate &dd)
 
- Protected Member Functions inherited from QSGTexture
 QSGTexture (QSGTexturePrivate &dd)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 175 of file qsgadaptationlayer_p.h.

Member Enumeration Documentation

◆ Format

Enumerator
RGBA8 
RGBA16F 
RGBA32F 

Definition at line 181 of file qsgadaptationlayer_p.h.

Constructor & Destructor Documentation

◆ ~QSGLayer()

QSGLayer::~QSGLayer ( )
overridedefault

◆ QSGLayer()

QSGLayer::QSGLayer ( QSGTexturePrivate & dd)
protected

Definition at line 401 of file qsgadaptationlayer.cpp.

Member Function Documentation

◆ invalidated()

virtual Q_SLOT void QSGLayer::invalidated ( )
pure virtual

◆ markDirtyTexture()

virtual Q_SLOT void QSGLayer::markDirtyTexture ( )
pure virtual

◆ scheduledUpdateCompleted

void QSGLayer::scheduledUpdateCompleted ( )
signal

Referenced by QSGOpenVGLayer::updateTexture(), QSGSoftwareLayer::updateTexture(), and QSGRhiLayer::updateTexture().

+ Here is the caller graph for this function:

◆ scheduleUpdate()

virtual void QSGLayer::scheduleUpdate ( )
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setDevicePixelRatio()

virtual void QSGLayer::setDevicePixelRatio ( qreal ratio)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setFormat()

virtual void QSGLayer::setFormat ( Format format)
pure virtual

Implemented in QSGRhiLayer, and QSGSoftwareLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setHasMipmaps()

virtual void QSGLayer::setHasMipmaps ( bool mipmap)
pure virtual

Implemented in QSGOpenVGLayer, QSGRhiLayer, and QSGSoftwareLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setItem()

virtual void QSGLayer::setItem ( QSGNode * item)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode(), and QQuick3DTexture::updateSpatialNode().

+ Here is the caller graph for this function:

◆ setLive()

virtual void QSGLayer::setLive ( bool live)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setMirrorHorizontal()

virtual void QSGLayer::setMirrorHorizontal ( bool mirror)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setMirrorVertical()

virtual void QSGLayer::setMirrorVertical ( bool mirror)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setRect()

virtual void QSGLayer::setRect ( const QRectF & logicalRect)
pure virtual

Implemented in QSGRhiLayer, QSGOpenVGLayer, and QSGSoftwareLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setRecursive()

virtual void QSGLayer::setRecursive ( bool recursive)
pure virtual

Implemented in QSGOpenVGLayer, QSGSoftwareLayer, and QSGRhiLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setSamples()

virtual void QSGLayer::setSamples ( int samples)
pure virtual

Implemented in QSGRhiLayer, QSGOpenVGLayer, and QSGSoftwareLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ setSize()

virtual void QSGLayer::setSize ( const QSize & pixelSize)
pure virtual

Implemented in QSGRhiLayer, QSGOpenVGLayer, and QSGSoftwareLayer.

Referenced by QQuickShaderEffectSource::updatePaintNode().

+ Here is the caller graph for this function:

◆ toImage()

virtual QImage QSGLayer::toImage ( ) const
pure virtual

◆ updateRequested

void QSGLayer::updateRequested ( )
signal

Referenced by QSGOpenVGLayer::markDirtyTexture(), QSGSoftwareLayer::markDirtyTexture(), QSGRhiLayer::markDirtyTexture(), QSGOpenVGLayer::scheduleUpdate(), QSGSoftwareLayer::scheduleUpdate(), and QSGRhiLayer::scheduleUpdate().

+ Here is the caller graph for this function:

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