QPaintedTextureImage

A QAbstractTextureImage that can be written through a QPainter . More…

Synopsis

Functions

• def height ()

• def size ()

• def update ([rect=QRect()])

• def width ()

Virtual functions

• def paint (painter)

Slots

• def setHeight (h)

• def setSize (size)

• def setWidth (w)

Signals

• def heightChanged (w)

• def sizeChanged (size)

• def widthChanged (w)

Detailed Description

A QPaintedTextureImage provides a way to specify a texture image (and thus an OpenGL texture) through a QPainter . The width and height of the texture image can be specified through the width and height or size properties.

A QPaintedTextureImage must be subclassed and the virtual paint() function implemented. Each time update() is called on the QPaintedTextureImage , the paint() function is invoked and the resulting image is uploaded.

The QPaintedTextureImage must be attached to some QAbstractTexture .

class PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage([parent=None])

Parameters

parent – PySide6.Qt3DCore.Qt3DCore.QNode

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.height()

Return type

int

This property holds the height of the texture image. The height must be greater than or equal to 1.

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.heightChanged(w)

Parameters

w – int

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.paint(painter)

Parameters

painter – PySide6.QtGui.QPainter

Paints the texture image with the specified QPainter object painter.

QPainter considers the top-left corner of an image as its origin, while OpenGL considers the bottom-left corner of a texture as its origin. An easy way to account for this difference is to set a custom viewport on the painter before doing any other painting:

painter->setViewport(0, height(), width(), -height());
...

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.setHeight(h)

Parameters

h – int

This property holds the height of the texture image. The height must be greater than or equal to 1.

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.setSize(size)

Parameters

size – PySide6.QtCore.QSize

This property holds the size of the texture image.

See also

height width

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.setWidth(w)

Parameters

w – int

This property holds the width of the texture image. The width must be greater than or equal to 1.

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.size()

Return type

PySide6.QtCore.QSize

This property holds the size of the texture image.

See also

height width

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.sizeChanged(size)

Parameters

size – PySide6.QtCore.QSize

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.update([rect=QRect()])

Parameters

rect – PySide6.QtCore.QRect

Immediately triggers the painted texture’s paint() function, which in turn uploads the new image to the GPU. If you are making multiple changes to a painted texture, consider waiting until all changes are complete before calling update, in order to minimize the number of repaints required.

Parameter rect is currently unused.

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.width()

Return type

int

This property holds the width of the texture image. The width must be greater than or equal to 1.

PySide6.Qt3DRender.Qt3DRender.QPaintedTextureImage.widthChanged(w)

Parameters

w – int