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 | List of all members
QSGRhiAtlasTexture::Texture Class Reference

#include <qsgrhiatlastexture_p.h>

+ Inheritance diagram for QSGRhiAtlasTexture::Texture:
+ Collaboration diagram for QSGRhiAtlasTexture::Texture:

Public Member Functions

 Texture (Atlas *atlas, const QRect &textureRect, const QImage &image)
 
 ~Texture ()
 
QSize textureSize () const override
 Returns the size of the texture in pixels.
 
void setHasAlphaChannel (bool alpha)
 
bool hasAlphaChannel () const override
 Returns true if the texture data contains an alpha channel.
 
bool hasMipmaps () const override
 Returns true if the texture data contains mipmap levels.
 
QRectF normalizedTextureSubRect () const override
 Returns the rectangle inside textureSize() that this texture represents in normalized coordinates.
 
QRect atlasSubRect () const
 
QRect atlasSubRectWithoutPadding () const
 
QSGTexture * removedFromAtlas (QRhiResourceUpdateBatch *resourceUpdates) const override
 This function returns a copy of the current texture which is removed from its atlas.
 
void releaseImage ()
 
const QImage & image () const
 
- Public Member Functions inherited from QSGRhiAtlasTexture::TextureBase
 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.
 
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.
 

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)
 
- Protected Attributes inherited from QSGRhiAtlasTexture::TextureBase
QRect m_allocated_rect
 
AtlasBase * m_atlas
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- 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 136 of file qsgrhiatlastexture_p.h.

Constructor & Destructor Documentation

◆ Texture()

QSGRhiAtlasTexture::Texture::Texture ( Atlas * atlas,
const QRect & textureRect,
const QImage & image )

Definition at line 348 of file qsgrhiatlastexture.cpp.

References atlasSubRectWithoutPadding().

+ Here is the call graph for this function:

◆ ~Texture()

QSGRhiAtlasTexture::Texture::~Texture ( )

Definition at line 362 of file qsgrhiatlastexture.cpp.

Member Function Documentation

◆ atlasSubRect()

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

Definition at line 150 of file qsgrhiatlastexture_p.h.

References QSGRhiAtlasTexture::TextureBase::m_allocated_rect.

Referenced by QSGRhiAtlasTexture::Atlas::enqueueTextureUpload().

+ Here is the caller graph for this function:

◆ atlasSubRectWithoutPadding()

QRect QSGRhiAtlasTexture::Texture::atlasSubRectWithoutPadding ( ) const
inline

Definition at line 151 of file qsgrhiatlastexture_p.h.

References QRect::adjusted(), and QSGRhiAtlasTexture::TextureBase::m_allocated_rect.

Referenced by Texture(), removedFromAtlas(), and textureSize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasAlphaChannel()

bool QSGRhiAtlasTexture::Texture::hasAlphaChannel ( ) const
inlineoverridevirtual

Returns true if the texture data contains an alpha channel.

Implements QSGTexture.

Definition at line 145 of file qsgrhiatlastexture_p.h.

◆ hasMipmaps()

bool QSGRhiAtlasTexture::Texture::hasMipmaps ( ) const
inlineoverridevirtual

Returns true if the texture data contains mipmap levels.

Implements QSGTexture.

Definition at line 146 of file qsgrhiatlastexture_p.h.

◆ image()

const QImage & QSGRhiAtlasTexture::Texture::image ( ) const
inline

Definition at line 156 of file qsgrhiatlastexture_p.h.

Referenced by QSGRhiAtlasTexture::Atlas::enqueueTextureUpload().

+ Here is the caller graph for this function:

◆ normalizedTextureSubRect()

QRectF QSGRhiAtlasTexture::Texture::normalizedTextureSubRect ( ) const
inlineoverridevirtual

Returns the rectangle inside textureSize() that this texture represents in normalized coordinates.

The default implementation returns a rect at position (0, 0) with width and height of 1.

Reimplemented from QSGTexture.

Definition at line 148 of file qsgrhiatlastexture_p.h.

◆ releaseImage()

void QSGRhiAtlasTexture::Texture::releaseImage ( )
inline

Definition at line 155 of file qsgrhiatlastexture_p.h.

Referenced by QSGRhiAtlasTexture::Atlas::enqueueTextureUpload().

+ Here is the caller graph for this function:

◆ removedFromAtlas()

QSGTexture * QSGRhiAtlasTexture::Texture::removedFromAtlas ( QRhiResourceUpdateBatch * resourceUpdates) const
overridevirtual

This function returns a copy of the current texture which is removed from its atlas.

The current texture remains unchanged, so texture coordinates do not need to be updated.

Removing a texture from an atlas is primarily useful when passing it to a shader that operates on the texture coordinates 0-1 instead of the texture subrect inside the atlas.

If the texture is not part of a texture atlas, this function returns 0.

Implementations of this function are recommended to return the same instance for multiple calls to limit memory usage.

resourceUpdates is an optional resource update batch, on which texture operations, if any, are enqueued. Materials can retrieve an instance from QSGMaterialShader::RenderState. When null, the removedFromAtlas() implementation creates its own batch and submit it right away. However, when a valid instance is specified, this function will not submit the update batch.

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

Reimplemented from QSGTexture.

Definition at line 368 of file qsgrhiatlastexture.cpp.

References atlasSubRectWithoutPadding(), QSGDefaultRenderContext::currentFrameCommandBuffer(), QSGTexture::filtering(), QRhiTexture::format(), QImage::isNull(), QRhi::isRecordingFrame(), QSGRhiAtlasTexture::TextureBase::m_atlas, QSGTexture::mipmapFiltering(), QRhi::newTexture(), QRhi::nextResourceUpdateBatch(), Q_ASSERT, QSGRhiAtlasTexture::AtlasBase::renderContext(), QRhiCommandBuffer::resourceUpdate(), QSGRhiAtlasTexture::AtlasBase::rhi(), QSGTexture::setFiltering(), QSGPlainTexture::setHasAlphaChannel(), QSGPlainTexture::setImage(), QSGTexture::setMipmapFiltering(), QSGPlainTexture::setOwnsTexture(), QSGPlainTexture::setTexture(), QSGPlainTexture::setTextureSize(), and QSGRhiAtlasTexture::AtlasBase::texture().

+ Here is the call graph for this function:

◆ setHasAlphaChannel()

void QSGRhiAtlasTexture::Texture::setHasAlphaChannel ( bool alpha)
inline

Definition at line 144 of file qsgrhiatlastexture_p.h.

Referenced by QSGRhiAtlasTexture::Manager::create().

+ Here is the caller graph for this function:

◆ textureSize()

QSize QSGRhiAtlasTexture::Texture::textureSize ( ) const
inlineoverridevirtual

Returns the size of the texture in pixels.

Implements QSGTexture.

Definition at line 143 of file qsgrhiatlastexture_p.h.

References atlasSubRectWithoutPadding(), and QRect::size().

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: