PySide6.Qt3DRender.Qt3DRender.QTextureImage

class QTextureImage

Encapsulates the necessary information to create an OpenGL texture image from an image source. More…

Synopsis

Properties

• mirroredᅟ

• sourceᅟ

• statusᅟ

Methods

• def __init__()

• def isMirrored()

• def setStatus()

• def source()

• def status()

Slots

• def setMirrored()

• def setSource()

Signals

• def mirroredChanged()

• def sourceChanged()

• def statusChanged()

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

It contains the necessary information mipmap level, layer, cube face and source URL to load at the proper place data into an OpenGL texture.

class Status

This enumeration specifies the status values for texture image loading.

Constant	Description
Qt3DRender.QTextureImage.None	The texture image loading has not been started yet.
Qt3DRender.QTextureImage.Loading	The texture image loading has started, but not finised.
Qt3DRender.QTextureImage.Ready	The texture image loading has finished.
Qt3DRender.QTextureImage.Error	The texture image loading confronted an error.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property mirroredᅟ: bool

This property specifies whether the image should be mirrored when loaded. This is a convenience to avoid having to manipulate images to match the origin of the texture coordinates used by the rendering API. By default this property is set to true. This has no effect when using GPU compressed texture formats.

Warning

This property results in a performance price payed at runtime when loading uncompressed or CPU compressed image formats such as PNG. To avoid this performance price it is better to set this property to false and load texture assets that have been pre-mirrored.

Note

OpenGL specifies the origin of texture coordinates from the lower left hand corner whereas DirectX uses the the upper left hand corner.

Note

When using cube map texture you’ll probably want mirroring disabled as the cube map sampler takes a direction rather than regular texture coordinates.

Access functions:

• isMirrored()

• setMirrored()

• Signal mirroredChanged()

property sourceᅟ: QUrl

This property holds the source url from which data for the texture image will be loaded.

Access functions:

• source()

• setSource()

• Signal sourceChanged()

property statusᅟ: Qt3DRender.QTextureImage.Status

This property holds the status of the texture image loading.

• TextureImage .None

• TextureImage .Loading

• TextureImage .Ready

• TextureImage .Error

Access functions:

• status()

• Signal statusChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QTextureImage instance with parent as parent.

isMirrored()

Return type:

bool

Returns whether mirroring is enabled or not.

Getter of property mirroredᅟ .

mirroredChanged(mirrored)

Parameters:

mirrored – bool

Notification signal of property mirroredᅟ .

setMirrored(mirrored)

Parameters:

mirrored – bool

Sets mirroring to mirrored.

Note

This internally triggers a call to update the data generator.

See also

isMirrored()

Setter of property mirroredᅟ .

setSource(source)

Parameters:

source – QUrl

Sets the source url of the texture image to source.

Note

This internally triggers a call to update the data generator.

See also

source()

Setter of property sourceᅟ .

setStatus(status)

Parameters:

status – Status

Sets the status to status. status

See also

status()

source()

Return type:

QUrl

Returns the source url from which data for the texture image will be loaded.

See also

setSource()

Getter of property sourceᅟ .

sourceChanged(source)

Parameters:

source – QUrl

Notification signal of property sourceᅟ .

status()

Return type:

Status

Returns the current status.

See also

setStatus()

Getter of property statusᅟ .

statusChanged(status)

Parameters:

status – Status

Notification signal of property statusᅟ .