[SPIR-V] Add GetDimensions() method for vk::SampledTexture2D type.

include/dxc/dxcapi.internal.h

@@ -136,7 +136,8 @@ enum LEGAL_INTRINSIC_COMPTYPES {
 
 #ifdef ENABLE_SPIRV_CODEGEN
   LICOMPTYPE_VK_BUFFER_POINTER = 54,
-  LICOMPTYPE_COUNT = 55
+  LICOMPTYPE_VK_SAMPLED_TEXTURE2D = 55,
+  LICOMPTYPE_COUNT = 56
 #else
   LICOMPTYPE_COUNT = 54
 #endif

tools/clang/include/clang/AST/HlslTypes.h

@@ -407,6 +407,11 @@ clang::CXXRecordDecl *
 DeclareVkBufferPointerType(clang::ASTContext &context,
                            clang::DeclContext *declContext);
 
+clang::CXXRecordDecl *DeclareVkSampledTextureType(
+    clang::ASTContext &context, clang::DeclContext *declContext,
+    llvm::StringRef hlslTypeName, clang::QualType defaultParamType,
+    clang::QualType coordinateType, clang::QualType offsetType);
+
 clang::CXXRecordDecl *DeclareInlineSpirvType(clang::ASTContext &context,
                                              clang::DeclContext *declContext,
                                              llvm::StringRef typeName,

tools/clang/include/clang/Basic/DiagnosticSemaKinds.td

@@ -7610,6 +7610,9 @@ def err_hlsl_unsupported_typedbuffer_template_parameter : Error<
   "elements of typed buffers and textures must be scalars or vectors">;
 def err_hlsl_unsupported_typedbuffer_template_parameter_size : Error<
   "elements of typed buffers and textures must fit in four 32-bit quantities">;
+def err_hlsl_unsupported_vk_sampledtexture_template_parameter
+    : Error<"%0 cannot be used as a type parameter where it must be of type "
+            "float, int, uint or their vector equivalents">;
 def err_hlsl_unsupported_payload_access_qualifier : Error<
   "payload access qualifiers are only allowed for member variables of a payload structure">;
 def err_hlsl_unsupported_payload_access_qualifier_struct : Error<

tools/clang/include/clang/SPIRV/AstTypeProbe.h

@@ -257,6 +257,9 @@ bool isTexture(QualType);
 /// Texture2DMSArray type.
 bool isTextureMS(QualType);
 
+/// \brief Returns true if the given type is an HLSL SampledTexture type.
+bool isSampledTexture(QualType);
+
 /// \brief Returns true if the given type is an HLSL RWTexture type.
 bool isRWTexture(QualType);
 

tools/clang/include/clang/SPIRV/SpirvBuilder.h

@@ -286,6 +286,10 @@ class SpirvBuilder {
   /// If compareVal is given a non-zero value, *Dref* variants of OpImageSample*
   /// will be generated.
   ///
+  /// If the of `image` is a sampled image, then that image will be sampled.
+  /// In this case, `sampler` must be `nullptr`. If `image` is not a sampled
+  /// image, a sampled image will be created by combining `image` and `sampler`.
+  ///
   /// If lod or grad is given a non-zero value, *ExplicitLod variants of
   /// OpImageSample* will be generated; otherwise, *ImplicitLod variant will
   /// be generated.
@@ -334,6 +338,10 @@ class SpirvBuilder {
 
   /// \brief Creates SPIR-V instructions for gathering the given image.
   ///
+  /// If the of `image` is a sampled image, then that image will be gathered.
+  /// In this case, `sampler` must be `nullptr`. If `image` is not a sampled
+  /// image, a sampled image will be created by combining `image` and `sampler`.
+  ///
   /// If compareVal is given a non-null value, OpImageDrefGather or
   /// OpImageSparseDrefGather will be generated; otherwise, OpImageGather or
   /// OpImageSparseGather will be generated.

tools/clang/lib/AST/ASTContextHLSL.cpp

@@ -1369,6 +1369,247 @@ CXXRecordDecl *hlsl::DeclareNodeOrRecordType(
 }
 
 #ifdef ENABLE_SPIRV_CODEGEN
+static void AddSampleFunction(ASTContext &context, CXXRecordDecl *recordDecl,
+                              QualType returnType, QualType coordinateType,
+                              QualType offsetType) {
+  QualType floatType = context.FloatTy;
+  QualType uintType = context.UnsignedIntTy;
+  // Sample(location)
+  CXXMethodDecl *sampleDecl = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, ArrayRef<QualType>(coordinateType),
+      ArrayRef<StringRef>(StringRef("location")),
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Sample")),
+      /*isConst*/ true);
+  sampleDecl->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Sample)));
+  sampleDecl->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+
+  // Sample(location, offset)
+  QualType params2[] = {coordinateType, offsetType};
+  StringRef names2[] = {"location", "offset"};
+  CXXMethodDecl *sampleDecl2 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, params2, names2,
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Sample")),
+      /*isConst*/ true);
+  sampleDecl2->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Sample)));
+  sampleDecl2->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+
+  // Sample(location, offset, clamp)
+  QualType params3[] = {coordinateType, offsetType, floatType};
+  StringRef names3[] = {"location", "offset", "clamp"};
+  CXXMethodDecl *sampleDecl3 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, params3, names3,
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Sample")),
+      /*isConst*/ true);
+  sampleDecl3->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Sample)));
+  sampleDecl3->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+
+  // Sample(location, offset, clamp, status)
+  QualType params4[] = {coordinateType, offsetType, floatType,
+                        context.getLValueReferenceType(uintType)};
+  StringRef names4[] = {"location", "offset", "clamp", "status"};
+  CXXMethodDecl *sampleDecl4 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, params4, names4,
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Sample")),
+      /*isConst*/ true);
+  sampleDecl4->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Sample)));
+  sampleDecl4->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+}
+
+static void AddCalculateLevelOfDetailFunction(ASTContext &context,
+                                              CXXRecordDecl *recordDecl,
+                                              QualType coordinateType,
+                                              bool unclamped) {
+  QualType floatType = context.FloatTy;
+
+  const char *functionName =
+      unclamped ? "CalculateLevelOfDetailUnclamped" : "CalculateLevelOfDetail";
+  const auto intrinsicOp =
+      unclamped ? hlsl::IntrinsicOp::MOP_CalculateLevelOfDetailUnclamped
+                : hlsl::IntrinsicOp::MOP_CalculateLevelOfDetail;
+
+  // // CalculateLevelOfDetail(location),
+  // CalculateLevelOfDetailUnclamped(location)
+  CXXMethodDecl *lodDecl = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, floatType, ArrayRef<QualType>(coordinateType),
+      ArrayRef<StringRef>(StringRef("location")),
+      context.DeclarationNames.getIdentifier(&context.Idents.get(functionName)),
+      /*isConst*/ true);
+  lodDecl->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(intrinsicOp)));
+  lodDecl->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+}
+
+static void AddGatherFunction(ASTContext &context, CXXRecordDecl *recordDecl,
+                              QualType returnType, QualType coordinateType,
+                              QualType offsetType) {
+  // Gather(location)
+  CXXMethodDecl *gatherDecl = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, ArrayRef<QualType>(coordinateType),
+      ArrayRef<StringRef>(StringRef("location")),
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Gather")),
+      /*isConst*/ true);
+  gatherDecl->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Gather)));
+  gatherDecl->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+
+  // Gather(location, offset)
+  QualType gatherParams2[] = {coordinateType, offsetType};
+  StringRef gatherNames2[] = {"location", "offset"};
+  CXXMethodDecl *gatherDecl2 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, gatherParams2, gatherNames2,
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Gather")),
+      /*isConst*/ true);
+  gatherDecl2->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Gather)));
+  gatherDecl2->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+
+  // Gather(location, offset, status)
+  QualType gatherParams3[] = {
+      coordinateType, offsetType,
+      context.getLValueReferenceType(context.UnsignedIntTy)};
+  StringRef gatherNames3[] = {"location", "offset", "status"};
+  CXXMethodDecl *gatherDecl3 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, returnType, gatherParams3, gatherNames3,
+      context.DeclarationNames.getIdentifier(&context.Idents.get("Gather")),
+      /*isConst*/ true);
+  gatherDecl3->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "", static_cast<int>(hlsl::IntrinsicOp::MOP_Gather)));
+  gatherDecl3->addAttr(HLSLCXXOverloadAttr::CreateImplicit(context));
+}
+
+static void AddGetDimensionsFunction(ASTContext &context,
+                                     CXXRecordDecl *recordDecl,
+                                     QualType coordinateType) {
+  QualType uintType = context.UnsignedIntTy;
+  QualType intType = context.IntTy;
+  QualType floatType = context.FloatTy;
+
+  // GetDimensions(width, height)
+  QualType getDimensionsParams2[] = {context.getLValueReferenceType(uintType),
+                                     context.getLValueReferenceType(uintType)};
+  StringRef getDimensionsNames2[] = {"width", "height"};
+  CXXMethodDecl *getDimensionsDecl2 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, context.VoidTy, getDimensionsParams2,
+      getDimensionsNames2,
+      context.DeclarationNames.getIdentifier(
+          &context.Idents.get("GetDimensions")),
+      /*isConst*/ true);
+  getDimensionsDecl2->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+  // GetDimensions(width, height) float version
+  QualType getDimensionsParams2Float[] = {
+      context.getLValueReferenceType(floatType),
+      context.getLValueReferenceType(floatType)};
+  StringRef getDimensionsNames2Float[] = {"width", "height"};
+  CXXMethodDecl *getDimensionsDecl2Float =
+      CreateObjectFunctionDeclarationWithParams(
+          context, recordDecl, context.VoidTy, getDimensionsParams2Float,
+          getDimensionsNames2Float,
+          context.DeclarationNames.getIdentifier(
+              &context.Idents.get("GetDimensions")),
+          /*isConst*/ true);
+  getDimensionsDecl2Float->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+  // GetDimensions(width, height) int version
+  QualType getDimensionsParams2Int[] = {
+      context.getLValueReferenceType(intType),
+      context.getLValueReferenceType(intType)};
+  StringRef getDimensionsNames2Int[] = {"width", "height"};
+  CXXMethodDecl *getDimensionsDecl2Int =
+      CreateObjectFunctionDeclarationWithParams(
+          context, recordDecl, context.VoidTy, getDimensionsParams2Int,
+          getDimensionsNames2Int,
+          context.DeclarationNames.getIdentifier(
+              &context.Idents.get("GetDimensions")),
+          /*isConst*/ true);
+  getDimensionsDecl2Int->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+
+  // GetDimensions(mipLevel, width, height, numLevels)
+  QualType getDimensionsParams4[] = {uintType,
+                                     context.getLValueReferenceType(uintType),
+                                     context.getLValueReferenceType(uintType),
+                                     context.getLValueReferenceType(uintType)};
+  StringRef getDimensionsNames4[] = {"mipLevel", "width", "height",
+                                     "numLevels"};
+  CXXMethodDecl *getDimensionsDecl4 = CreateObjectFunctionDeclarationWithParams(
+      context, recordDecl, context.VoidTy, getDimensionsParams4,
+      getDimensionsNames4,
+      context.DeclarationNames.getIdentifier(
+          &context.Idents.get("GetDimensions")),
+      /*isConst*/ true);
+  getDimensionsDecl4->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+  // GetDimensions(mipLevel, width, height, numLevels) float version
+  QualType getDimensionsParams4Float[] = {
+      uintType, context.getLValueReferenceType(floatType),
+      context.getLValueReferenceType(floatType),
+      context.getLValueReferenceType(floatType)};
+  StringRef getDimensionsNames4Float[] = {"mipLevel", "width", "height",
+                                          "numLevels"};
+  CXXMethodDecl *getDimensionsDecl4Float =
+      CreateObjectFunctionDeclarationWithParams(
+          context, recordDecl, context.VoidTy, getDimensionsParams4Float,
+          getDimensionsNames4Float,
+          context.DeclarationNames.getIdentifier(
+              &context.Idents.get("GetDimensions")),
+          /*isConst*/ true);
+  getDimensionsDecl4Float->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+  // GetDimensions(mipLevel, width, height, numLevels) int version
+  QualType getDimensionsParams4Int[] = {
+      uintType, context.getLValueReferenceType(intType),
+      context.getLValueReferenceType(intType),
+      context.getLValueReferenceType(intType)};
+  StringRef getDimensionsNames4Int[] = {"mipLevel", "width", "height",
+                                        "numLevels"};
+  CXXMethodDecl *getDimensionsDecl4Int =
+      CreateObjectFunctionDeclarationWithParams(
+          context, recordDecl, context.VoidTy, getDimensionsParams4Int,
+          getDimensionsNames4Int,
+          context.DeclarationNames.getIdentifier(
+              &context.Idents.get("GetDimensions")),
+          /*isConst*/ true);
+  getDimensionsDecl4Int->addAttr(HLSLIntrinsicAttr::CreateImplicit(
+      context, "op", "",
+      static_cast<int>(hlsl::IntrinsicOp::MOP_GetDimensions)));
+}
+
+CXXRecordDecl *hlsl::DeclareVkSampledTextureType(
+    ASTContext &context, DeclContext *declContext, llvm::StringRef hlslTypeName,
+    QualType defaultParamType, QualType coordinateType, QualType offsetType) {
+  BuiltinTypeDeclBuilder Builder(declContext, hlslTypeName,
+                                 TagDecl::TagKind::TTK_Struct);
+
+  TemplateTypeParmDecl *TyParamDecl =
+      Builder.addTypeTemplateParam("SampledTextureType", defaultParamType);
+
+  Builder.startDefinition();
+
+  QualType paramType = QualType(TyParamDecl->getTypeForDecl(), 0);
+  CXXRecordDecl *recordDecl = Builder.getRecordDecl();
+
+  AddSampleFunction(context, recordDecl, paramType, coordinateType, offsetType);
+  AddCalculateLevelOfDetailFunction(context, recordDecl, coordinateType,
+                                    /*unclamped=*/false);
+  AddCalculateLevelOfDetailFunction(context, recordDecl, coordinateType,
+                                    /*unclamped=*/true);
+  AddGatherFunction(context, recordDecl, paramType, coordinateType, offsetType);
+  AddGetDimensionsFunction(context, recordDecl, coordinateType);
+
+  Builder.completeDefinition();
+  return recordDecl;
+}
+
 CXXRecordDecl *hlsl::DeclareVkBufferPointerType(ASTContext &context,
                                                 DeclContext *declContext) {
   BuiltinTypeDeclBuilder Builder(declContext, "BufferPointer",

tools/clang/lib/SPIRV/AstTypeProbe.cpp

@@ -926,6 +926,17 @@ bool isTexture(QualType type) {
   return false;
 }
 
+bool isSampledTexture(QualType type) {
+  if (const auto *rt = type->getAs<RecordType>()) {
+    const auto name = rt->getDecl()->getName();
+    // TODO(https://github.com/microsoft/DirectXShaderCompiler/issues/7979): Add
+    // other sampled texture types as needed.
+    if (name == "SampledTexture2D")
+      return true;
+  }
+  return false;
+}
+
 bool isTextureMS(QualType type) {
   if (const auto *rt = type->getAs<RecordType>()) {
     const auto name = rt->getDecl()->getName();

tools/clang/lib/SPIRV/LowerTypeVisitor.cpp

@@ -849,6 +849,23 @@ const SpirvType *LowerTypeVisitor::lowerVkTypeInVkNamespace(
     assert(visitedTypeStack.size() == visitedTypeStackSize);
     return pointerType;
   }
+  if (name == "SampledTexture2D") {
+    const auto sampledType = hlsl::GetHLSLResourceResultType(type);
+    auto loweredType = lowerType(getElementType(astContext, sampledType), rule,
+                                 /*isRowMajor*/ llvm::None, srcLoc);
+
+    // Bool does not have a defined size in SPIR-V, so it cannot be
+    // used in the external interface.
+    if (loweredType == spvContext.getBoolType()) {
+      loweredType = spvContext.getUIntType(32);
+    }
+
+    const auto *imageType = spvContext.getImageType(
+        loweredType, spv::Dim::Dim2D, ImageType::WithDepth::No,
+        false /* array */, false /* ms */, ImageType::WithSampler::Yes,
+        spv::ImageFormat::Unknown);
+    return spvContext.getSampledImageType(imageType);
+  }
   emitError("unknown type %0 in vk namespace", srcLoc) << type;
   return nullptr;
 }
@@ -892,7 +909,8 @@ LowerTypeVisitor::lowerResourceType(QualType type, SpirvLayoutRule rule,
       auto loweredType =
           lowerType(getElementType(astContext, sampledType), rule,
                     /*isRowMajor*/ llvm::None, srcLoc);
-      // Treat bool textures as uint for compatibility with OpTypeImage.
+      // Bool does not have a defined size in SPIR-V, so it cannot be
+      // used in the external interface.
       if (loweredType == spvContext.getBoolType()) {
         loweredType = spvContext.getUIntType(32);
       }

tools/clang/lib/SPIRV/SpirvBuilder.cpp

@@ -620,8 +620,15 @@ SpirvInstruction *SpirvBuilder::createImageSample(
   assert(lod == nullptr || minLod == nullptr);
 
   // An OpSampledImage is required to do the image sampling.
-  auto *sampledImage =
-      createSampledImage(imageType, image, sampler, loc, range);
+  // Skip creating OpSampledImage if the imageType is a sampled texture.
+  SpirvInstruction *sampledImage = nullptr;
+  if (isSampledTexture(imageType)) {
+    assert(!sampler &&
+           "sampler must be null when sampling from a sampled texture");
+    sampledImage = image;
+  } else {
+    sampledImage = createSampledImage(imageType, image, sampler, loc, range);
+  }
 
   const auto mask = composeImageOperandsMask(
       bias, lod, grad, constOffset, varOffset, constOffsets, sample, minLod);
@@ -707,8 +714,15 @@ SpirvInstruction *SpirvBuilder::createImageGather(
   assert(insertPoint && "null insert point");
 
   // An OpSampledImage is required to do the image sampling.
-  auto *sampledImage =
-      createSampledImage(imageType, image, sampler, loc, range);
+  // Skip creating OpSampledImage if the imageType is a sampled texture.
+  SpirvInstruction *sampledImage = nullptr;
+  if (isSampledTexture(imageType)) {
+    assert(!sampler &&
+           "sampler must be null when sampling from a sampled texture");
+    sampledImage = image;
+  } else {
+    sampledImage = createSampledImage(imageType, image, sampler, loc, range);
+  }
 
   // TODO: Update ImageGather to accept minLod if necessary.
   const auto mask = composeImageOperandsMask(