PySide6.QtQuick.QSGSimpleTextureNode

class QSGSimpleTextureNode

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

Inheritance diagram of PySide6.QtQuick.QSGSimpleTextureNode

Synopsis

Methods

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 simple texture node class must have a texture before being added to the scene graph to be rendered.

Warning

This utility class is only functional when running with the default or software backends of the Qt Quick scenegraph. As an alternative, prefer using QSGImageNode via createImageNode() . However, this standalone class is still useful when used via subclassing and the application knows that no special scenegraph backends will be involved.

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

QSGSimpleTextureNode.NoTransform

Texture coordinates are oriented with window coordinates i.e. with origin at top-left.

QSGSimpleTextureNode.MirrorHorizontally

Texture coordinates are inverted in the horizontal axis with respect to window coordinates

QSGSimpleTextureNode.MirrorVertically

Texture coordinates are inverted in the vertical axis with respect to window coordinates

__init__()

Constructs a new simple texture node

filtering()
Return type:

Filtering

Returns the filtering currently set on this texture node

See also

setFiltering()

ownsTexture()
Return type:

bool

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

See also

setOwnsTexture()

rect()
Return type:

QRectF

Returns the target rect of this texture node.

See also

setRect()

setFiltering(filtering)
Parameters:

filteringFiltering

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

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

See also

filtering()

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.

setRect(rect)
Parameters:

rectQRectF

Sets the target rect of this texture node to r.

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 texture node to begin at (x, y) and have width w and height h.

setSourceRect(r)
Parameters:

rQRectF

Sets the source rect of this texture node to r.

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 texture node to show its texture from (x, y) and have width w and height h relatively to the textureSize .

setTexture(texture)
Parameters:

textureQSGTexture

Sets the texture of this texture 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

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

See also

texture()

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.

sourceRect()
Return type:

QRectF

Returns the source rect of this texture node.

See also

setSourceRect()

texture()
Return type:

QSGTexture

Returns the texture for this texture node

See also

setTexture()

textureCoordinatesTransform()
Return type:

Combination of TextureCoordinatesTransformFlag

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