PySide6.QtQuick.QSGImageNode

class QSGImageNode

The QSGImageNode class is provided for convenience to easily draw textured content using the QML scene graph. More…

Synopsis

Methods

• def setRect()

• def setSourceRect()

Virtual methods

• def anisotropyLevel()

• def filtering()

• def mipmapFiltering()

• def ownsTexture()

• def rect()

• def setAnisotropyLevel()

• def setFiltering()

• def setMipmapFiltering()

• def setOwnsTexture()

• def setRect()

• def setSourceRect()

• def setTexture()

• def setTextureCoordinatesTransform()

• def sourceRect()

• def texture()

• def textureCoordinatesTransform()

Static functions

• def rebuildGeometry()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

The image node class must have a texture before being added to the scene graph to be rendered.

class TextureCoordinatesTransformFlag

(inherits enum.Flag) The TextureCoordinatesTransformFlag enum is used to specify the mode used to generate texture coordinates for a textured quad.

Constant	Description
QSGImageNode.NoTransform	Texture coordinates are oriented with window coordinates i.e. with origin at top-left.
QSGImageNode.MirrorHorizontally	Texture coordinates are inverted in the horizontal axis with respect to window coordinates
QSGImageNode.MirrorVertically	Texture coordinates are inverted in the vertical axis with respect to window coordinates

abstract anisotropyLevel()

Return type:

AnisotropyLevel

Returns this image node’s anistropy level.

See also

setAnisotropyLevel()

abstract filtering()

Return type:

Filtering

Returns the filtering for this image node.

See also

setFiltering()

abstract mipmapFiltering()

Return type:

Filtering

Returns the mipmap filtering for this image node.

See also

setMipmapFiltering()

abstract ownsTexture()

Return type:

bool

Returns true if the node takes ownership of the texture; otherwise false.

See also

setOwnsTexture()

static rebuildGeometry(g, texture, rect, sourceRect, texCoordMode)

Parameters:

• g – QSGGeometry

• texture – QSGTexture

• rect – QRectF

• sourceRect – QRectF

• texCoordMode – Combination of TextureCoordinatesTransformFlag

Updates the geometry g with the texture, the coordinates in rect, and the texture coordinates from sourceRect.

g is assumed to be a triangle strip of four vertices of type TexturedPoint2D .

texCoordMode is used for normalizing the sourceRect.

abstract rect()

Return type:

QRectF

Returns the target rect of this image node.

See also

setRect()

abstract setAnisotropyLevel(level)

Parameters:

level – AnisotropyLevel

Sets this image node’s anistropy level to level.

See also

anisotropyLevel()

abstract setFiltering(filtering)

Parameters:

filtering – Filtering

Sets the filtering to be used for this image node to filtering.

For smooth scaling, use Linear . For normal scaling, use Nearest .

See also

filtering()

abstract setMipmapFiltering(filtering)

Parameters:

filtering – Filtering

Sets the mipmap filtering to be used for this image node to filtering.

For smooth scaling between mip maps, use Linear . For normal scaling, use Nearest .

See also

mipmapFiltering()

abstract setOwnsTexture(owns)

Parameters:

owns – bool

Sets whether the node takes ownership of the texture to owns.

By default, the node does not take ownership of the texture.

See also

ownsTexture()

abstract setRect(rect)

Parameters:

rect – QRectF

Sets the target rect of this image node to rect.

See also

rect()

setRect(x, y, w, h)

Parameters:

• x – float

• y – float

• w – float

• h – float

This is an overloaded function.

Sets the rectangle of this image node to begin at (x, y) and have width w and height h.

abstract setSourceRect(r)

Parameters:

r – QRectF

Sets the source rect of this image node to rect.

See also

sourceRect()

setSourceRect(x, y, w, h)

Parameters:

• x – float

• y – float

• w – float

• h – float

This is an overloaded function.

Sets the rectangle of this image node to show its texture from (x, y) and have width w and height h relatively to the textureSize .

abstract setTexture(texture)

Parameters:

texture – QSGTexture

Sets the texture of this image node to texture.

Use setOwnsTexture() to set whether the node should take ownership of the texture. By default, the node does not take ownership.

Warning

An image node must have a texture before being added to the scenegraph to be rendered.

See also

texture()

abstract setTextureCoordinatesTransform(mode)

Parameters:

mode – Combination of TextureCoordinatesTransformFlag

Sets the method used to generate texture coordinates to mode. This can be used to obtain correct orientation of the texture. This is commonly needed when using a third-party OpenGL library to render to texture as OpenGL has an inverted y-axis relative to Qt Quick.

See also

textureCoordinatesTransform()

abstract sourceRect()

Return type:

QRectF

Returns the source rect of this image node.

See also

setSourceRect()

abstract texture()

Return type:

QSGTexture

Returns the texture for this image node.

See also

setTexture()

abstract textureCoordinatesTransform()

Return type:

Combination of TextureCoordinatesTransformFlag

Returns the mode used to generate texture coordinates for this node.

See also

setTextureCoordinatesTransform()