QTextureImage

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

Synopsis

Functions

• def isMirrored ()

• def setStatus (status)

• def source ()

• def status ()

Slots

• def setMirrored (mirrored)

• def setSource (source)

Signals

• def mirroredChanged (mirrored)

• def sourceChanged (source)

• def statusChanged (status)

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 PySide6.Qt3DRender.Qt3DRender.QTextureImage([parent=None])

Parameters

parent – PySide6.Qt3DCore.Qt3DCore.QNode

Constructs a new QTextureImage instance with parent as parent.

PySide6.Qt3DRender.Qt3DRender.QTextureImage.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.

PySide6.Qt3DRender.Qt3DRender.QTextureImage.isMirrored()

Return type

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 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.

PySide6.Qt3DRender.Qt3DRender.QTextureImage.mirroredChanged(mirrored)

Parameters

mirrored – bool

PySide6.Qt3DRender.Qt3DRender.QTextureImage.setMirrored(mirrored)

Parameters

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 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.

PySide6.Qt3DRender.Qt3DRender.QTextureImage.setSource(source)

Parameters

source – PySide6.QtCore.QUrl

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

PySide6.Qt3DRender.Qt3DRender.QTextureImage.setStatus(status)

Parameters

status – Status

Sets the status to status. status

See also

status()

PySide6.Qt3DRender.Qt3DRender.QTextureImage.source()

Return type

PySide6.QtCore.QUrl

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

PySide6.Qt3DRender.Qt3DRender.QTextureImage.sourceChanged(source)

Parameters

source – PySide6.QtCore.QUrl

PySide6.Qt3DRender.Qt3DRender.QTextureImage.status()

Return type

Status

This property holds the status of the texture image loading.

• TextureImage .None

• TextureImage .Loading

• TextureImage .Ready

• TextureImage .Error

PySide6.Qt3DRender.Qt3DRender.QTextureImage.statusChanged(status)

Parameters

status – Status