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 に、変数リストまたはブロックリストのいずれかに少なくとも1つのエントリが含まれている場合、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 を割り当てます。