• Home
• Qt 6.4
• Qt 3D
• QML Types
• Qt3D.Render
• ShaderImage

ShaderImage

Provides Image access to shader programs. More...

• List of all members, including inherited members

Properties

• access : enumeration
• format : enumeration
• layer : int
• layered : bool
• mipLevel : int

Detailed Description

To make the content of textures available for read and write operations in a shader, they need to exposed as ShaderImage. Textures can be composed of several mip levels, layers and faces. Additionally declaring a ShaderImage allows specifying which level, layer or face of the texture content we want to access.

ShaderImage has to be assigned as a Parameter's value and reference a valid Qt3D.Render.AbstractTexture to work properly.

If the referenced texture is a one-dimensional array, two-dimensional array, three-dimensional, cube map, cube map array, or two-dimensional multisample array texture, it is possible to bind either the entire texture level or a single layer or face of the texture level. This can be controlled with the layered property.

Support for ShaderImage is only supported with OpenGL 4 and partially with OpenGL ES 3.1 and 3.2.

OpenGL 4 supports the following image types:

OpenGL ES 3.1 supports the following image types:

OpenGL ES 3.2 supports all of the OpenGL ES 3.1 image types as well as the following:

Expected use would look like:

import Qt3D.Render 2.14

Entity {
...
    Texture2D {
        id: tex2D
        ...
    }

    Material {
        parameters: Parameter {
            name: "imageUniformName"
            value: ShaderImage {
                texture: tex2D
            }
        }
        ...
    }
 ...
}

Property Documentation

cubeMapLayer = layer / 6
cubeMapFace = layer - (cubeMapLayer * 6)