QSGOpaqueTextureMaterial Class

The QSGOpaqueTextureMaterial class provides a convenient way of rendering textured geometry in the scene graph. More...

Header: #include <QSGOpaqueTextureMaterial>
CMake: find_package(Qt6 REQUIRED COMPONENTS Quick)
target_link_libraries(mytarget PRIVATE Qt6::Quick)
qmake: QT += quick
Inherits: QSGMaterial
Inherited By:


Public Functions

QSGTexture::AnisotropyLevel anisotropyLevel() const
QSGTexture::Filtering filtering() const
QSGTexture::WrapMode horizontalWrapMode() const
QSGTexture::Filtering mipmapFiltering() const
void setAnisotropyLevel(QSGTexture::AnisotropyLevel level)
void setFiltering(QSGTexture::Filtering filtering)
void setHorizontalWrapMode(QSGTexture::WrapMode mode)
void setMipmapFiltering(QSGTexture::Filtering filtering)
void setTexture(QSGTexture *texture)
void setVerticalWrapMode(QSGTexture::WrapMode mode)
QSGTexture *texture() const
QSGTexture::WrapMode verticalWrapMode() const

Detailed Description

Warning: This utility class is only functional when running with the default backend of the Qt Quick scenegraph.

The opaque textured material will fill every pixel in a geometry with the supplied texture. The material does not respect the opacity of the QSGMaterialShader::RenderState, so opacity nodes in the parent chain of nodes using this material, have no effect.

The geometry to be rendered with an opaque texture material requires vertices in attribute location 0 and texture coordinates in attribute location 1. The texture coordinate is a 2-dimensional floating-point tuple. The QSGGeometry::defaultAttributes_TexturedPoint2D returns an attribute set compatible with this material.

The texture to be rendered can be set using setTexture(). How the texture should be rendered can be specified using setMipmapFiltering(), setFiltering(), setHorizontalWrapMode() and setVerticalWrapMode(). The rendering state is set on the texture instance just before it is bound.

The opaque textured material respects the current matrix and the alpha channel of the texture. It will disregard the accumulated opacity in the scenegraph.

A texture material must have a texture set before it is used as a material in the scene graph.

Member Function Documentation


Creates a new QSGOpaqueTextureMaterial.

The default mipmap filtering and filtering mode is set to QSGTexture::Nearest. The default wrap modes is set to QSGTexture::ClampToEdge.

QSGTexture::AnisotropyLevel QSGOpaqueTextureMaterial::anisotropyLevel() const

Returns this material's anistropy level.

See also setAnisotropyLevel().

QSGTexture::Filtering QSGOpaqueTextureMaterial::filtering() const

Returns this material's filtering mode.

The default filtering is QSGTexture::Nearest.

See also setFiltering().

QSGTexture::WrapMode QSGOpaqueTextureMaterial::horizontalWrapMode() const

Returns this material's horizontal wrap mode.

The default horizontal wrap mode is QSGTexture::ClampToEdge.

See also setHorizontalWrapMode().

QSGTexture::Filtering QSGOpaqueTextureMaterial::mipmapFiltering() const

Returns this material's mipmap filtering mode.

The default mipmap mode is QSGTexture::Nearest.

See also setMipmapFiltering().

void QSGOpaqueTextureMaterial::setAnisotropyLevel(QSGTexture::AnisotropyLevel level)

Sets this material's anistropy level to level.

See also anisotropyLevel().

void QSGOpaqueTextureMaterial::setFiltering(QSGTexture::Filtering filtering)

Sets the filtering to filtering.

The filtering mode is set on the texture instance just before the texture is bound for rendering.

See also filtering().

void QSGOpaqueTextureMaterial::setHorizontalWrapMode(QSGTexture::WrapMode mode)

Sets the horizontal wrap mode to mode.

The horizontal wrap mode is set on the texture instance just before the texture is bound for rendering.

See also horizontalWrapMode().

void QSGOpaqueTextureMaterial::setMipmapFiltering(QSGTexture::Filtering filtering)

Sets the mipmap mode to filtering.

The mipmap filtering mode is set on the texture instance just before the texture is bound for rendering.

If the texture does not have mipmapping support, enabling mipmapping has no effect.

See also mipmapFiltering().

void QSGOpaqueTextureMaterial::setTexture(QSGTexture *texture)

Sets the texture of this material to texture.

The material does not take ownership of the texture.

See also texture().

void QSGOpaqueTextureMaterial::setVerticalWrapMode(QSGTexture::WrapMode mode)

Sets the vertical wrap mode to mode.

The vertical wrap mode is set on the texture instance just before the texture is bound for rendering.

See also verticalWrapMode().

QSGTexture *QSGOpaqueTextureMaterial::texture() const

Returns this texture material's texture.

See also setTexture().

QSGTexture::WrapMode QSGOpaqueTextureMaterial::verticalWrapMode() const

Returns this material's vertical wrap mode.

The default vertical wrap mode is QSGTexture::ClampToEdge.

See also setVerticalWrapMode().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.