QAbstractTextureImage Class
class Qt3DRender::QAbstractTextureImageEncapsulates the necessary information to create an OpenGL texture image. More...
Header: | #include <QAbstractTextureImage> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS 3drender) target_link_libraries(mytarget PRIVATE Qt6::3drender) |
qmake: | QT += 3drender |
Instantiated By: | AbstractTextureImage |
Inherits: | Qt3DCore::QNode |
Inherited By: | Qt3DRender::QPaintedTextureImage and Qt3DRender::QTextureImage |
Properties
Public Functions
QAbstractTextureImage(Qt3DCore::QNode *parent = nullptr) | |
Qt3DRender::QAbstractTexture::CubeMapFace | face() const |
int | layer() const |
int | mipLevel() const |
Public Slots
void | setFace(Qt3DRender::QAbstractTexture::CubeMapFace face) |
void | setLayer(int layer) |
void | setMipLevel(int level) |
Signals
void | faceChanged(Qt3DRender::QAbstractTexture::CubeMapFace face) |
void | layerChanged(int layer) |
void | mipLevelChanged(int mipLevel) |
Protected Functions
virtual Qt3DRender::QTextureImageDataGeneratorPtr | dataGenerator() const = 0 |
void | notifyDataGeneratorChanged() |
Detailed Description
QAbstractTextureImage should be used as the means of providing image data to a QAbstractTexture. It contains the necessary information: mipmap level, layer, cube face load at the proper place data into an OpenGL texture.
The actual data is provided through a QTextureImageDataGenerator that will be executed by Aspect jobs in the backend. QAbstractTextureImage should be subclassed to provide a functor and eventual additional properties needed by the functor to load actual data.
Note: : QAbstractTextureImage should never be shared. Expect crashes, undefined behavior at best if this rule is not respected.
Property Documentation
face : Qt3DRender::QAbstractTexture::CubeMapFace
Holds the cube map face of the texture image.
Note: The cube map face has a meaning only for TargetCubeMap and TargetCubeMapArray.
Access functions:
Qt3DRender::QAbstractTexture::CubeMapFace | face() const |
void | setFace(Qt3DRender::QAbstractTexture::CubeMapFace face) |
Notifier signal:
void | faceChanged(Qt3DRender::QAbstractTexture::CubeMapFace face) |
layer : int
Returns the layer of the texture image.
Access functions:
int | layer() const |
void | setLayer(int layer) |
Notifier signal:
void | layerChanged(int layer) |
mipLevel : int
Holds the mipmap level of the texture image.
Access functions:
int | mipLevel() const |
void | setMipLevel(int level) |
Notifier signal:
void | mipLevelChanged(int mipLevel) |
Member Function Documentation
[explicit]
QAbstractTextureImage::QAbstractTextureImage(Qt3DCore::QNode *parent = nullptr)
Constructs a new QAbstractTextureImage instance with parent as parent.
[pure virtual protected]
Qt3DRender::QTextureImageDataGeneratorPtr QAbstractTextureImage::dataGenerator() const
Implement this method to return the QTextureImageDataGeneratorPtr instance, which will provide the data for the texture image.
[protected]
void QAbstractTextureImage::notifyDataGeneratorChanged()
Triggers an update of the data generator that is sent to the backend.
[slot]
void QAbstractTextureImage::setFace(Qt3DRender::QAbstractTexture::CubeMapFace face)
Sets the texture image face to face. face
Note: Setter function for property face.
See also face().
[slot]
void QAbstractTextureImage::setLayer(int layer)
Sets the layer of a texture to layer. layer
Note: Setter function for property layer.
See also layer().
[slot]
void QAbstractTextureImage::setMipLevel(int level)
Sets the mip level of a texture to level. level
Note: Setter function for property mipLevel.
See also mipLevel().