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
Public Member Functions | Protected Attributes | List of all members
QSGRhiAtlasTexture::TextureBase Class Reference

#include <qsgrhiatlastexture_p.h>

+ Inheritance diagram for QSGRhiAtlasTexture::TextureBase:
+ Collaboration diagram for QSGRhiAtlasTexture::TextureBase:

Public Member Functions

 TextureBase (AtlasBase *atlas, const QRect &textureRect)
 
 ~TextureBase ()
 
qint64 comparisonKey () const override
 Returns a key suitable for comparing textures.
 
QRhiTexture * rhiTexture () const override
 
void commitTextureOperations (QRhi *rhi, QRhiResourceUpdateBatch *resourceUpdates) override
 Call this function to enqueue image upload operations to resourceUpdates, in case there are any pending ones.
 
bool isAtlasTexture () const override
 Returns whether this texture is part of an atlas or not.
 
QRect atlasSubRect () const
 
- Public Member Functions inherited from QSGTexture
 QSGTexture ()
 Constructs the QSGTexture base class.
 
 ~QSGTexture () override
 Destroys the QSGTexture.
 
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 QSGTexture * removedFromAtlas (QRhiResourceUpdateBatch *resourceUpdates=nullptr) const
 This function returns a copy of the current texture which is removed from its atlas.
 
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< QString > bindableObjectName ()
 
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).
 
QThread * thread () 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 >
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 >
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 QObjectList & children () 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< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () 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 Attributes

QRect m_allocated_rect
 
AtlasBase * m_atlas
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 

Additional Inherited Members

- 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...
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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.
 
- 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 Member Functions inherited from QSGTexture
 QSGTexture (QSGTexturePrivate &dd)
 
- Protected Member Functions inherited from QObject
QObject * sender () 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)
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 117 of file qsgrhiatlastexture_p.h.

Constructor & Destructor Documentation

◆ TextureBase()

QSGRhiAtlasTexture::TextureBase::TextureBase ( AtlasBase * atlas,
const QRect & textureRect )

Definition at line 309 of file qsgrhiatlastexture.cpp.

◆ ~TextureBase()

QSGRhiAtlasTexture::TextureBase::~TextureBase ( )

Definition at line 316 of file qsgrhiatlastexture.cpp.

References m_atlas, and QSGRhiAtlasTexture::AtlasBase::remove().

+ Here is the call graph for this function:

Member Function Documentation

◆ atlasSubRect()

QRect QSGRhiAtlasTexture::TextureBase::atlasSubRect ( ) const
inline

Definition at line 129 of file qsgrhiatlastexture_p.h.

References m_allocated_rect.

Referenced by QSGCompressedAtlasTexture::Texture::Texture().

+ Here is the caller graph for this function:

◆ commitTextureOperations()

void QSGRhiAtlasTexture::TextureBase::commitTextureOperations ( QRhi * rhi,
QRhiResourceUpdateBatch * resourceUpdates )
overridevirtual

Call this function to enqueue image upload operations to resourceUpdates, in case there are any pending ones.

When there is no new data (for example, because there was no setImage() since the last call to this function), the function does nothing.

Materials involving rhi textures are expected to call this function from their \l{QSGMaterialShader::updateSampledImage()}{updateSampledImage()} implementation, typically without any conditions, passing {state.rhi()} and {state.resourceUpdateBatch()} from the QSGMaterialShader::RenderState.

Warning
This function can only be called from the rendering thread.
Since
6.0

Reimplemented from QSGTexture.

Definition at line 339 of file qsgrhiatlastexture.cpp.

References QSGRhiAtlasTexture::AtlasBase::commitTextureOperations(), m_atlas, QSGRhiAtlasTexture::AtlasBase::m_rhi, Q_ASSERT, and Q_UNUSED.

+ Here is the call graph for this function:

◆ comparisonKey()

qint64 QSGRhiAtlasTexture::TextureBase::comparisonKey ( ) const
overridevirtual

Returns a key suitable for comparing textures.

Typically used in QSGMaterial::compare() implementations.

Just comparing QSGTexture pointers is not always sufficient because two QSGTexture instances that refer to the same native texture object underneath should also be considered equal. Hence the need for this function.

Implementations of this function are not expected to, and should not create any graphics resources (native texture objects) in case there are none yet.

A QSGTexture that does not have a native texture object underneath is typically not equal to any other QSGTexture, so the return value has to be crafted accordingly. There are exceptions to this, in particular when atlasing is used (where multiple textures share the same atlas texture under the hood), that is then up to the subclass implementations to deal with as appropriate.

Warning
This function can only be called from the rendering thread.
Since
5.14

Implements QSGTexture.

Definition at line 321 of file qsgrhiatlastexture.cpp.

References m_atlas.

◆ isAtlasTexture()

bool QSGRhiAtlasTexture::TextureBase::isAtlasTexture ( ) const
inlineoverridevirtual

Returns whether this texture is part of an atlas or not.

The default implementation returns false.

Reimplemented from QSGTexture.

Definition at line 128 of file qsgrhiatlastexture_p.h.

◆ rhiTexture()

QRhiTexture * QSGRhiAtlasTexture::TextureBase::rhiTexture ( ) const
overridevirtual
Returns
the QRhiTexture for this QSGTexture or null if there is none (either because a valid texture has not been created internally yet, or because the concept is not applicable to the scenegraph backend in use).

This function is not expected to create a new QRhiTexture in case there is none. It should return null in that case. The expectation towards the renderer is that a null texture leads to using a transparent, dummy texture instead.

Warning
This function can only be called from the rendering thread.
Since
6.0

Reimplemented from QSGTexture.

Definition at line 334 of file qsgrhiatlastexture.cpp.

References m_atlas, and QSGRhiAtlasTexture::AtlasBase::m_texture.

Member Data Documentation

◆ m_allocated_rect

QRect QSGRhiAtlasTexture::TextureBase::m_allocated_rect
protected

Definition at line 132 of file qsgrhiatlastexture_p.h.

Referenced by atlasSubRect(), QSGRhiAtlasTexture::Texture::atlasSubRect(), and QSGRhiAtlasTexture::Texture::atlasSubRectWithoutPadding().

◆ m_atlas

AtlasBase* QSGRhiAtlasTexture::TextureBase::m_atlas
protected

Definition at line 133 of file qsgrhiatlastexture_p.h.

Referenced by ~TextureBase(), commitTextureOperations(), comparisonKey(), QSGCompressedAtlasTexture::Texture::hasAlphaChannel(), QSGCompressedAtlasTexture::Texture::removedFromAtlas(), QSGRhiAtlasTexture::Texture::removedFromAtlas(), and rhiTexture().

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