QShaderDescription Class

成员函数文档

QShaderDescription::QShaderDescription()

创建一个新的、空的 QShaderDescription。

QShaderDescription::QShaderDescription(const QShaderDescription &other)

创建other 的副本。

[noexcept] QShaderDescription::~QShaderDescription()

析构函数。

QList<QShaderDescription::InOutVariable> QShaderDescription::combinedImageSamplers() const

返回组合图像采样器的列表

以 GLSL/Vulkan 着色器为源时，layout(binding = 1) uniform sampler2D tex; 统一变量会生成以下内容：（此处以 JSON 文本形式展示）

"combinedImageSamplers": [
     {
         "binding": 1,
         "name": "tex",
         "set": 0,
         "type": "sampler2D"
     }
 ]

这并不意味着其他语言版本的着色器也必须使用组合图像采样器，尤其是考虑到该概念并非在所有语言中都存在。例如，HLSL 版本很可能仅使用 Texture2D 和 SamplerState 对象，并分别将其注册为 t1 和 s1。

std::array<uint, 3> QShaderDescription::computeShaderLocalSize() const

返回计算着色器的本地大小。

例如，对于具有以下声明的计算着色器，该函数返回 { 256, 16, 1}。

layout(local_size_x = 256, local_size_y = 16, local_size_z = 1) in;

[static] QShaderDescription QShaderDescription::deserialize(QDataStream *stream, int version)

返回一个从stream 加载而来的新QShaderDescription 对象。version 指定了 qsb 的版本。

另请参阅 serialize()。

QList<QShaderDescription::BuiltinVariable> QShaderDescription::inputBuiltinVariables() const

返回用作输入的活跃内置函数列表。例如，一个读取 gl_TessCoord 和 gl_Position 值的镶嵌计算着色器，其TessCoordBuiltin 和PositionBuiltin 将在此处列出。

QList<QShaderDescription::InOutVariable> QShaderDescription::inputVariables() const

返回输入变量的列表。其中包括顶点阶段的顶点输入（有时称为属性），以及其他阶段的输入（有时称为变量）。

bool QShaderDescription::isValid() const

如果QShaderDescription 在变量列表或代码块列表中至少包含一个条目，则返回true。

QList<QShaderDescription::BuiltinVariable> QShaderDescription::outputBuiltinVariables() const

返回用作输入的有效内置变量列表。例如，顶点着色器通常会将PositionBuiltin 作为输出内置变量。

QList<QShaderDescription::InOutVariable> QShaderDescription::outputVariables() const

返回输出变量的列表。

QList<QShaderDescription::PushConstantBlock> QShaderDescription::pushConstantBlocks() const

返回推送常量块的列表。

void QShaderDescription::serialize(QDataStream *stream, int version) const

将此QShaderDescription 序列化为stream 。version 指定了qsb版本。

另请参阅 deserialize() 和toJson()。

QList<QShaderDescription::StorageBlock> QShaderDescription::storageBlocks() const

返回着色器存储块的列表。

例如，以 GLSL/Vulkan 着色器为源代码，以下声明

struct Stuff {
    vec2 a;
    vec2 b;
};
layout(std140, binding = 0) buffer StuffSsbo {
    vec4 whatever;
    Stuff stuff[];
} buf;

将生成以下内容：（此处以纯文本 JSON 形式展示）

"storageBlocks": [ {
    "binding": 0,
    "blockName": "StuffSsbo",
    "instanceName": "buf",
    "knownSize": 16,
    "runtimeArrayStride": 16
    "members": [
        {
            "name": "whatever",
            "offset": 0,
            "size": 16,
            "type": "vec4"
        },
        {
            "arrayDims": [
                0
            ],
            "name": "stuff",
            "offset": 16,
            "size": 0,
            "structMembers": [
                {
                    "name": "a",
                    "offset": 0,
                    "size": 8,
                    "type": "vec2"
                },
                {
                    "name": "b",
                    "offset": 8,
                    "size": 8,
                    "type": "vec2"
                }
            ],
            "type": "struct"
        }
    ],
    "set": 0
} ]

QList<QShaderDescription::InOutVariable> QShaderDescription::storageImages() const

返回图像变量的列表。

这些变量通常出现在计算着色器中。例如，layout (binding = 0, rgba8) uniform readonly image2D inputImage; 会生成以下内容：（此处以文本形式的 JSON 显示）

"storageImages": [
     {
         "binding": 0,
         "imageFormat": "rgba8",
         "name": "inputImage",
         "set": 0,
         "type": "image2D"
     }
 ]

QShaderDescription::TessellationMode QShaderDescription::tessellationMode() const

返回一个镶嵌控制着色器或评估着色器的镶嵌执行模式。

若未设置，则返回值为UnknownTessellationMode 。

例如，对于具有以下声明的细分评估着色器，该函数返回TrianglesTessellationMode 。

layout(triangles) in;

uint QShaderDescription::tessellationOutputVertexCount() const

返回输出顶点的数量。

例如，对于具有以下声明的镶嵌控制着色器，该函数返回 3。

layout(vertices = 3) out;

QShaderDescription::TessellationPartitioning QShaderDescription::tessellationPartitioning() const

返回一个细分控制着色器或评估着色器的细分划分模式。

若未设置，则返回值为UnknownTessellationPartitioning 。

例如，对于具有以下声明的细分评估着色器，该函数返回FractionalOddTessellationPartitioning 。

layout(triangles, fractional_odd_spacing, ccw) in;

QShaderDescription::TessellationWindingOrder QShaderDescription::tessellationWindingOrder() const

返回一个细分控制着色器或评估着色器的细分缠绕顺序。

若未设置，则返回值为UnknownTessellationWindingOrder 。

例如，对于具有以下声明的细分评估着色器，该函数返回CcwTessellationWindingOrder 。

layout(triangles, fractional_odd_spacing, ccw) in;

QByteArray QShaderDescription::toJson() const

返回数据的序列化 JSON 文本版本。

另请参阅 serialize()。

QList<QShaderDescription::UniformBlock> QShaderDescription::uniformBlocks() const

返回均匀块的列表。

QShaderDescription &QShaderDescription::operator=(const QShaderDescription &other)

将other 分配给该对象。