Vulkan.Extensions.VK_HUAWEI_subpass_shading

Name

VK_HUAWEI_subpass_shading - device extension

VK_HUAWEI_subpass_shading

Name String

VK_HUAWEI_subpass_shading

Extension Type

Device extension

Registered Extension Number

370

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_create_renderpass2 to be enabled for any device-level functionality
• Requires VK_KHR_synchronization2 to be enabled for any device-level functionality

Contact

• Pan Gao @PanGao-h%0A*Here describe the issue or question you have about the VK_HUAWEI_subpass_shading extension*

Other Extension Metadata

Last Modified Date

2021-06-01

Interactions and External Dependencies

• This extension requires SPV_HUAWEI_subpass_shading.
• This extension provides API support for GL_HUAWEI_subpass_shading.

Contributors

• Hueilong Wang
• Juntao Li, Huawei
• Renmiao Lu, Huawei
• Pan Gao, Huawei

Description

This extension allows applications to execute a subpass shading pipeline in a subpass of a render pass in order to save memory bandwidth for algorithms like tile-based deferred rendering and forward plus. A subpass shading pipeline is a pipeline with the compute pipeline ability, allowed to read values from input attachments, and only allowed to be dispatched inside a stand-alone subpass. Its work dimension is defined by the render pass’s render area size. Its workgroup size (width, height) shall be a power-of-two number in width or height, with minimum value from 8, and maximum value shall be decided from the render pass attachments and sample counts but depends on implementation.

The GlobalInvocationId.xy of a subpass shading pipeline is equal to the FragCoord.xy of a graphic pipeline in the same render pass subtracted the offset of the RenderPassBeginInfo::renderArea. GlobalInvocationId.z is mapped to the Layer if VK_EXT_shader_viewport_index_layer is supported. The GlobalInvocationId.xy is equal to the index of the local workgroup multiplied by the size of the local workgroup plus the LocalInvocationId and the offset of the RenderPassBeginInfo::renderArea.

This extension allows a subpass’s pipeline bind point to be PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI.

New Commands

• cmdSubpassShadingHUAWEI

• getDeviceSubpassShadingMaxWorkgroupSizeHUAWEI

New Structures

• Extending ComputePipelineCreateInfo:

  • SubpassShadingPipelineCreateInfoHUAWEI

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceSubpassShadingFeaturesHUAWEI

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceSubpassShadingPropertiesHUAWEI

New Enum Constants

• HUAWEI_SUBPASS_SHADING_EXTENSION_NAME

• HUAWEI_SUBPASS_SHADING_SPEC_VERSION

• Extending PipelineBindPoint:

  • PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI

• Extending PipelineStageFlagBits2:

  • PIPELINE_STAGE_2_SUBPASS_SHADING_BIT_HUAWEI

• Extending ShaderStageFlagBits:

  • SHADER_STAGE_SUBPASS_SHADING_BIT_HUAWEI

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBPASS_SHADING_FEATURES_HUAWEI
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBPASS_SHADING_PROPERTIES_HUAWEI
  • STRUCTURE_TYPE_SUBPASS_SHADING_PIPELINE_CREATE_INFO_HUAWEI

Sample Code

Example of subpass shading in a GLSL shader

#extension GL_HUAWEI_subpass_shading: enable
#extension GL_KHR_shader_subgroup_arithmetic: enable

layout(constant_id = 0) const uint tileWidth = 8;
layout(constant_id = 1) const uint tileHeight = 8;
layout(local_size_x_id = 0, local_size_y_id = 1, local_size_z = 1) in;
layout(set=0, binding=0, input_attachment_index=0) uniform subpassInput depth;

void main()
{
  float d = subpassLoad(depth).x;
  float minD = subgroupMin(d);
  float maxD = subgroupMax(d);
}

Example of subpass shading dispatching in a subpass

vkCmdNextSubpass(commandBuffer, VK_SUBPASS_CONTENTS_INLINE);
vkCmdBindPipeline(commandBuffer, VK_PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI, subpassShadingPipeline);
vkCmdBindDescriptorSets(commandBuffer, VK_PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI, subpassShadingPipelineLayout,
  firstSet, descriptorSetCount, pDescriptorSets, dynamicOffsetCount, pDynamicOffsets);
vkCmdSubpassShadingHUAWEI(commandBuffer)
vkCmdEndRenderPass(commandBuffer);

Example of subpass shading render pass creation

VkAttachmentDescription2 attachments[] = {
  {
    VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2, NULL,
    0, VK_FORMAT_R8G8B8A8_UNORM, VK_SAMPLE_COUNT_1_BIT,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_STORE_OP_DONT_CARE,
    VK_ATTACHMENT_LOAD_OP_DONT_CARE, VK_ATTACHMENT_LOAD_OP_DONT_CARE,
    VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
  },
  {
    VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2, NULL,
    0, VK_FORMAT_R8G8B8A8_UNORM, VK_SAMPLE_COUNT_1_BIT,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_STORE_OP_DONT_CARE,
    VK_ATTACHMENT_LOAD_OP_DONT_CARE, VK_ATTACHMENT_LOAD_OP_DONT_CARE,
    VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
  },
  {
    VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2, NULL,
    0, VK_FORMAT_R8G8B8A8_UNORM, VK_SAMPLE_COUNT_1_BIT,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_STORE_OP_DONT_CARE,
    VK_ATTACHMENT_LOAD_OP_DONT_CARE, VK_ATTACHMENT_LOAD_OP_DONT_CARE,
    VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
  },
  {
    VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2, NULL,
    0, VK_FORMAT_D24_UNORM_S8_UINT, VK_SAMPLE_COUNT_1_BIT,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_STORE_OP_DONT_CARE,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_LOAD_OP_DONT_CARE,
    VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
  },
  {
    VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2, NULL,
    0, VK_FORMAT_R8G8B8A8_UNORM, VK_SAMPLE_COUNT_1_BIT,
    VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_STORE_OP_STORE,
    VK_ATTACHMENT_LOAD_OP_DONT_CARE, VK_ATTACHMENT_LOAD_OP_DONT_CARE,
    VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
  }
};

VkAttachmentReference2 gBufferAttachmentReferences[] = {
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 0, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT },
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 1, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT },
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 2, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT }
};
VkAttachmentReference2 gBufferDepthStencilAttachmentReferences =
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 3, VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_DEPTH_BIT|VK_IMAGE_ASPECT_STENCIL_BIT };
VkAttachmentReference2 depthInputAttachmentReferences[] = {
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 3, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, VK_IMAGE_ASPECT_DEPTH_BIT|VK_IMAGE_ASPECT_STENCIL_BIT };
};
VkAttachmentReference2 preserveAttachmentReferences[] = {
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 0, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT },
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 1, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT },
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 2, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT },
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 3, VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_DEPTH_BIT|VK_IMAGE_ASPECT_STENCIL_BIT }
}; // G buffer including depth/stencil
VkAttachmentReference2 colorAttachmentReferences[] = {
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 4, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT }
};
VkAttachmentReference2 resolveAttachmentReference =
  { VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2, NULL, 4, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_ASPECT_COLOR_BIT };

VkSubpassDescription2 subpasses[] = {
  {
    VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2, NULL, 0, VK_PIPELINE_BIND_POINT_GRAPHICS, 0,
    0, NULL, // input
    sizeof(gBufferAttachmentReferences)/sizeof(gBufferAttachmentReferences[0]), gBufferAttachmentReferences, // color
    NULL, &gBufferDepthStencilAttachmentReferences, // resolve & DS
    0, NULL
  },
  {
    VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2, NULL, 0, VK_PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI , 0,
    sizeof(depthInputAttachmentReferences)/sizeof(depthInputAttachmentReferences[0]), depthInputAttachmentReferences, // input
    0, NULL, // color
    NULL, NULL, // resolve & DS
    sizeof(preserveAttachmentReferences)/sizeof(preserveAttachmentReferences[0]), preserveAttachmentReferences,
  },
  {
    VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2, NULL, 0, VK_PIPELINE_BIND_POINT_GRAPHICS, 0,
    sizeof(gBufferAttachmentReferences)/sizeof(gBufferAttachmentReferences[0]), gBufferAttachmentReferences, // input
    sizeof(colorAttachmentReferences)/sizeof(colorAttachmentReferences[0]), colorAttachmentReferences, // color
    &resolveAttachmentReference, &gBufferDepthStencilAttachmentReferences, // resolve & DS
    0, NULL
  },
};

VkMemoryBarrier2KHR fragmentToSubpassShading = {
  VK_STRUCTURE_TYPE_MEMORY_BARRIER_2_KHR, NULL,
  VK_PIPELINE_STAGE_2_FRAGMENT_SHADER_BIT_KHR, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT|VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
  VK_PIPELINE_STAGE_2_SUBPASS_SHADING_BIT_HUAWEI, VK_ACCESS_INPUT_ATTACHMENT_READ_BIT
};

VkMemoryBarrier2KHR subpassShadingToFragment = {
  VK_STRUCTURE_TYPE_MEMORY_BARRIER_2_KHR, NULL,
  VK_PIPELINE_STAGE_2_SUBPASS_SHADING_BIT_HUAWEI, VK_ACCESS_SHADER_WRITE_BIT,
  VK_PIPELINE_STAGE_2_FRAGMENT_SHADER_BIT_KHR, VK_ACCESS_SHADER_READ_BIT
};

VkSubpassDependency2 dependencies[] = {
  {
    VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2, &fragmentToSubpassShading,
    0, 1,
    0, 0, 0, 0,
    0, 0
  },
  {
    VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2, &subpassShadingToFragment,
    1, 2,
    0, 0, 0, 0,
    0, 0
  },
};

VkRenderPassCreateInfo2 renderPassCreateInfo = {
  VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2, NULL, 0,
    sizeof(attachments)/sizeof(attachments[0]), attachments,
    sizeof(subpasses)/sizeof(subpasses[0]), subpasses,
    sizeof(dependencies)/sizeof(dependencies[0]), dependencies,
    0, NULL
};
VKRenderPass renderPass;
vkCreateRenderPass2(device, &renderPassCreateInfo, NULL, &renderPass);

Example of subpass shading pipeline creation

VkExtent2D maxWorkgroupSize;

VkSpecializationMapEntry subpassShadingConstantMapEntries[] = {
  { 0, 0 * sizeof(uint32_t), sizeof(uint32_t) },
  { 1, 1 * sizeof(uint32_t), sizeof(uint32_t) }
};

VkSpecializationInfo subpassShadingConstants = {
  2, subpassShadingConstantMapEntries,
  sizeof(VkExtent2D), &maxWorkgroupSize
};

VkSubpassShadingPipelineCreateInfoHUAWEI subpassShadingPipelineCreateInfo {
  VK_STRUCTURE_TYPE_SUBPASSS_SHADING_PIPELINE_CREATE_INFO_HUAWEI, NULL,
  renderPass, 1
};

VkPipelineShaderStageCreateInfo subpassShadingPipelineStageCreateInfo {
  VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO, NULL,
  0, VK_SHADER_STAGE_SUBPASS_SHADING_BIT_HUAWEI,
  shaderModule, "main",
  &subpassShadingConstants
};

VkComputePipelineCreateInfo subpassShadingComputePipelineCreateInfo = {
  VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO, &subpassShadingPipelineCreateInfo,
  0, &subpassShadingPipelineStageCreateInfo,
  pipelineLayout, basePipelineHandle, basePipelineIndex
};

VKPipeline pipeline;

vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI(device, renderPass, &maxWorkgroupSize);
vkCreateComputePipelines(device, pipelineCache, 1, &subpassShadingComputePipelineCreateInfo, NULL, &pipeline);

Version History

• Revision 2, 2021-06-28 (Hueilong Wang)

  • Change vkGetSubpassShadingMaxWorkgroupSizeHUAWEI to vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI to resolve issue pub1564

• Revision 1, 2020-12-15 (Hueilong Wang)

  • Initial draft.

See Also

PhysicalDeviceSubpassShadingFeaturesHUAWEI, PhysicalDeviceSubpassShadingPropertiesHUAWEI, SubpassShadingPipelineCreateInfoHUAWEI, cmdSubpassShadingHUAWEI, getDeviceSubpassShadingMaxWorkgroupSizeHUAWEI

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getDeviceSubpassShadingMaxWorkgroupSizeHUAWEI

Arguments

:: forall io. MonadIO io

=> Device

device is a handle to a local device object that was used to create the given render pass.

device must be a valid Device handle

-> RenderPass

renderpass must be a valid RenderPass handle

renderpass must have been created, allocated, or retrieved from device

-> io (Result, "maxWorkgroupSize" ::: Extent2D)

vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI - Query maximum supported subpass shading workgroup size for a give render pass

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VK_HUAWEI_subpass_shading, Device, Extent2D, RenderPass

cmdSubpassShadingHUAWEI

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> io ()

vkCmdSubpassShadingHUAWEI - Dispatch compute work items

Description

When the command is executed, a global workgroup consisting of ceil (render area size / local workgroup size) local workgroups is assembled.

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a ImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a ImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For any ImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any ImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any BufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any BufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by the Pipeline bound to the pipeline bind point used by this command, a descriptor set must have been bound to n at the same pipeline bind point, with a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by the Pipeline bound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command and the bound Pipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdBindDescriptorSets, the bound Pipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via cmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the Pipeline bound to the pipeline bind point used by this command and the bound Pipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the Pipeline bound to the pipeline bind point were specified via cmdSetDescriptorBufferOffsetsEXT, the bound Pipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a Pipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident.
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited (if the VK_NV_inherited_viewport_scissor extension is enabled) for commandBuffer, and done so after any previously bound pipeline with the corresponding state not specified as dynamic
• There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for uniformBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If any stage of the Pipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_EXT or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2_EXT for storageBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler or ImageView object that enables sampler Y′CBCR conversion, that object must not use the ConstOffset and Offset operands
• If a ImageView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format
• If a BufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a ImageView with a Format that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a ImageView with a Format that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a BufferView with a Format that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a BufferView with a Format that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, Image objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, Buffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If OpImageWeightedSampleQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a ImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation.
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM.
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a Sampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM.
• Any shader invocation executed by this command must terminate
• This command must be called in a subpass with bind point PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI. No draw commands can be called in the same subpass. Only one cmdSubpassShadingHUAWEI command can be called in a subpass

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called inside of a render pass instance
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Inside	Outside	Graphics	Action

See Also

VK_HUAWEI_subpass_shading, CommandBuffer

data SubpassShadingPipelineCreateInfoHUAWEI

VkSubpassShadingPipelineCreateInfoHUAWEI - Structure specifying parameters of a newly created subpass shading pipeline

Valid Usage (Implicit)

See Also

VK_HUAWEI_subpass_shading, RenderPass, StructureType

Constructors

SubpassShadingPipelineCreateInfoHUAWEI

Fields

• renderPass :: RenderPass

  renderPass is a handle to a render pass object describing the environment in which the pipeline will be used. The pipeline must only be used with a render pass instance compatible with the one provided. See Render Pass Compatibility for more information.

• subpass :: Word32

  subpass is the index of the subpass in the render pass where this pipeline will be used.

  subpass must be created with PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI bind point

Instances

Storable SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

sizeOf :: SubpassShadingPipelineCreateInfoHUAWEI -> Int

alignment :: SubpassShadingPipelineCreateInfoHUAWEI -> Int

peekElemOff :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> Int -> IO SubpassShadingPipelineCreateInfoHUAWEI

pokeElemOff :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> Int -> SubpassShadingPipelineCreateInfoHUAWEI -> IO ()

peekByteOff :: Ptr b -> Int -> IO SubpassShadingPipelineCreateInfoHUAWEI

pokeByteOff :: Ptr b -> Int -> SubpassShadingPipelineCreateInfoHUAWEI -> IO ()

peek :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> IO SubpassShadingPipelineCreateInfoHUAWEI

poke :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> SubpassShadingPipelineCreateInfoHUAWEI -> IO ()

Show SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

showsPrec :: Int -> SubpassShadingPipelineCreateInfoHUAWEI -> ShowS

show :: SubpassShadingPipelineCreateInfoHUAWEI -> String

showList :: [SubpassShadingPipelineCreateInfoHUAWEI] -> ShowS

Eq SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

(==) :: SubpassShadingPipelineCreateInfoHUAWEI -> SubpassShadingPipelineCreateInfoHUAWEI -> Bool

(/=) :: SubpassShadingPipelineCreateInfoHUAWEI -> SubpassShadingPipelineCreateInfoHUAWEI -> Bool

FromCStruct SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

peekCStruct :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> IO SubpassShadingPipelineCreateInfoHUAWEI

ToCStruct SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

withCStruct :: SubpassShadingPipelineCreateInfoHUAWEI -> (Ptr SubpassShadingPipelineCreateInfoHUAWEI -> IO b) -> IO b

pokeCStruct :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> SubpassShadingPipelineCreateInfoHUAWEI -> IO b -> IO b

withZeroCStruct :: (Ptr SubpassShadingPipelineCreateInfoHUAWEI -> IO b) -> IO b

pokeZeroCStruct :: Ptr SubpassShadingPipelineCreateInfoHUAWEI -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SubpassShadingPipelineCreateInfoHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

zero :: SubpassShadingPipelineCreateInfoHUAWEI

data PhysicalDeviceSubpassShadingPropertiesHUAWEI

VkPhysicalDeviceSubpassShadingPropertiesHUAWEI - Structure describing subpass shading properties supported by an implementation

Description

If the PhysicalDeviceSubpassShadingPropertiesHUAWEI structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_HUAWEI_subpass_shading, StructureType

Constructors

PhysicalDeviceSubpassShadingPropertiesHUAWEI

Fields

• maxSubpassShadingWorkgroupSizeAspectRatio :: Word32

  maxSubpassShadingWorkgroupSizeAspectRatio indicates the maximum ratio between the width and height of the portion of the subpass shading shader workgroup size. maxSubpassShadingWorkgroupSizeAspectRatio must be a power-of-two value, and must be less than or equal to max(WorkgroupSize.x / WorkgroupSize.y, WorkgroupSize.y / WorkgroupSize.x).

Instances

Storable PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

sizeOf :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Int

alignment :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Int

peekElemOff :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Int -> IO PhysicalDeviceSubpassShadingPropertiesHUAWEI

pokeElemOff :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Int -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceSubpassShadingPropertiesHUAWEI

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO ()

peek :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO PhysicalDeviceSubpassShadingPropertiesHUAWEI

poke :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO ()

Show PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

showsPrec :: Int -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> ShowS

show :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> String

showList :: [PhysicalDeviceSubpassShadingPropertiesHUAWEI] -> ShowS

Eq PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

(==) :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Bool

(/=) :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> Bool

FromCStruct PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

peekCStruct :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO PhysicalDeviceSubpassShadingPropertiesHUAWEI

ToCStruct PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

withCStruct :: PhysicalDeviceSubpassShadingPropertiesHUAWEI -> (Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceSubpassShadingPropertiesHUAWEI -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceSubpassShadingPropertiesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

zero :: PhysicalDeviceSubpassShadingPropertiesHUAWEI

data PhysicalDeviceSubpassShadingFeaturesHUAWEI

VkPhysicalDeviceSubpassShadingFeaturesHUAWEI - Structure describing whether subpass shading is enabled

Members

This structure describes the following feature:

Description

If the PhysicalDeviceSubpassShadingFeaturesHUAWEI structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceSubpassShadingFeaturesHUAWEI can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_HUAWEI_subpass_shading, Bool32, StructureType

Constructors

PhysicalDeviceSubpassShadingFeaturesHUAWEI

Fields

• subpassShading :: Bool

  subpassShading specifies whether subpass shading is supported.

Instances

Storable PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

sizeOf :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Int

alignment :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Int

peekElemOff :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Int -> IO PhysicalDeviceSubpassShadingFeaturesHUAWEI

pokeElemOff :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Int -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceSubpassShadingFeaturesHUAWEI

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO ()

peek :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO PhysicalDeviceSubpassShadingFeaturesHUAWEI

poke :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO ()

Show PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

showsPrec :: Int -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> ShowS

show :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> String

showList :: [PhysicalDeviceSubpassShadingFeaturesHUAWEI] -> ShowS

Eq PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

(==) :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Bool

(/=) :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> Bool

FromCStruct PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

peekCStruct :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO PhysicalDeviceSubpassShadingFeaturesHUAWEI

ToCStruct PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

withCStruct :: PhysicalDeviceSubpassShadingFeaturesHUAWEI -> (Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceSubpassShadingFeaturesHUAWEI -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceSubpassShadingFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_subpass_shading

Methods

zero :: PhysicalDeviceSubpassShadingFeaturesHUAWEI

type HUAWEI_SUBPASS_SHADING_SPEC_VERSION = 2

pattern HUAWEI_SUBPASS_SHADING_SPEC_VERSION :: forall a. Integral a => a

type HUAWEI_SUBPASS_SHADING_EXTENSION_NAME = "VK_HUAWEI_subpass_shading"

pattern HUAWEI_SUBPASS_SHADING_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a