Vulkan.Extensions.VK_HUAWEI_invocation_mask

Name

VK_HUAWEI_invocation_mask - device extension

VK_HUAWEI_invocation_mask

Name String

VK_HUAWEI_invocation_mask

Extension Type

Device extension

Registered Extension Number

371

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_ray_tracing_pipeline
• Requires VK_KHR_synchronization2

Contact

• Yunpeng Zhu @yunxingzhu%0A<<Here describe the issue or question you have about the VK_HUAWEI_invocation_mask extension> >

Extension Proposal

VK_HUAWEI_invocation_mask

Other Extension Metadata

Last Modified Date

2021-05-27

Interactions and External Dependencies

• This extension requires VK_KHR_ray_tracing_pipeline, which allow to bind an invocation mask image before the ray tracing command
• This extension requires VK_KHR_synchronization2, which allows new pipeline stage for the invocation mask image

Contributors

• Yunpeng Zhu, HuaWei

Description

The rays to trace may be sparse in some use cases. For example, the scene only have a few regions to reflect. Providing an invocation mask image to the ray tracing commands could potentially give the hardware the hint to do certain optimization without invoking an additional pass to compact the ray buffer.

New Commands

• cmdBindInvocationMaskHUAWEI

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceInvocationMaskFeaturesHUAWEI

New Enum Constants

• HUAWEI_INVOCATION_MASK_EXTENSION_NAME

• HUAWEI_INVOCATION_MASK_SPEC_VERSION

• Extending AccessFlagBits2:

  • ACCESS_2_INVOCATION_MASK_READ_BIT_HUAWEI

• Extending ImageUsageFlagBits:

  • IMAGE_USAGE_INVOCATION_MASK_BIT_HUAWEI

• Extending PipelineStageFlagBits2:

  • PIPELINE_STAGE_2_INVOCATION_MASK_BIT_HUAWEI

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_INVOCATION_MASK_FEATURES_HUAWEI

Examples

RT mask is updated before each traceRay.

Step 1. Generate InvocationMask.

//the rt mask image bind as color attachment in the fragment shader
Layout(location = 2) out vec4 outRTmask
vec4 mask = vec4(x,x,x,x);
outRTmask = mask;

Step 2. traceRay with InvocationMask

vkCmdBindPipeline(
    commandBuffers[imageIndex],
    VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR, m_rtPipeline);
    vkCmdBindDescriptorSets(commandBuffers[imageIndex],
    VK_PIPELINE_BIND_POINT_RAY_TRACING_NV,
    m_rtPipelineLayout, 0, 1, &m_rtDescriptorSet,
    0, nullptr);

vkCmdBindInvocationMaskHUAWEI(
    commandBuffers[imageIndex],
    InvocationMaskimageView,
    InvocationMaskimageLayout);
    vkCmdTraceRaysKHR(commandBuffers[imageIndex],
    pRaygenShaderBindingTable,
    pMissShaderBindingTable,
    swapChainExtent.width,
    swapChainExtent.height, 1);

Version History

• Revision 1, 2021-05-27 (Yunpeng Zhu)

  • Initial draft.

See Also

PhysicalDeviceInvocationMaskFeaturesHUAWEI, cmdBindInvocationMaskHUAWEI

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

cmdBindInvocationMaskHUAWEI

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ImageView

imageView is an image view handle specifying the invocation mask image imageView may be set to NULL_HANDLE, which is equivalent to specifying a view of an image filled with ones value.

-> ImageLayout

imageLayout is the layout that the image subresources accessible from imageView will be in when the invocation mask image is accessed

-> io ()

vkCmdBindInvocationMaskHUAWEI - Bind an invocation mask image on a command buffer

Valid Usage

• The invocation mask image feature must be enabled

• If imageView is not NULL_HANDLE, it must be a valid ImageView handle of type IMAGE_VIEW_TYPE_2D
• If imageView is not NULL_HANDLE, it must have a format of FORMAT_R8_UINT
• If imageView is not NULL_HANDLE, it must have been created with IMAGE_USAGE_INVOCATION_MASK_BIT_HUAWEI set
• If imageView is not NULL_HANDLE, imageLayout must be IMAGE_LAYOUT_GENERAL
• Thread mask image resolution must match the width and height in cmdTraceRaysKHR
• Each element in the invocation mask image must have the value 0 or 1. The value 1 means the invocation is active
• width in cmdTraceRaysKHR should be 1

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support compute operations
• This command must only be called outside of a render pass instance
• Both of commandBuffer, and imageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

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	Supported Queue Types
Primary Secondary	Outside	Compute

See Also

VK_HUAWEI_invocation_mask, CommandBuffer, ImageLayout, ImageView

data PhysicalDeviceInvocationMaskFeaturesHUAWEI

VkPhysicalDeviceInvocationMaskFeaturesHUAWEI - Structure describing invocation mask features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceInvocationMaskFeaturesHUAWEI 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. PhysicalDeviceInvocationMaskFeaturesHUAWEI can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_HUAWEI_invocation_mask, Bool32, StructureType

Constructors

PhysicalDeviceInvocationMaskFeaturesHUAWEI

Fields

• invocationMask :: Bool

  invocationMask indicates that the implementation supports the use of an invocation mask image to optimize the ray dispatch.

Instances

Eq PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

(==) :: PhysicalDeviceInvocationMaskFeaturesHUAWEI -> PhysicalDeviceInvocationMaskFeaturesHUAWEI -> Bool

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

Show PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

showsPrec :: Int -> PhysicalDeviceInvocationMaskFeaturesHUAWEI -> ShowS

show :: PhysicalDeviceInvocationMaskFeaturesHUAWEI -> String

showList :: [PhysicalDeviceInvocationMaskFeaturesHUAWEI] -> ShowS

Storable PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

sizeOf :: PhysicalDeviceInvocationMaskFeaturesHUAWEI -> Int

alignment :: PhysicalDeviceInvocationMaskFeaturesHUAWEI -> Int

peekElemOff :: Ptr PhysicalDeviceInvocationMaskFeaturesHUAWEI -> Int -> IO PhysicalDeviceInvocationMaskFeaturesHUAWEI

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

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

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

peek :: Ptr PhysicalDeviceInvocationMaskFeaturesHUAWEI -> IO PhysicalDeviceInvocationMaskFeaturesHUAWEI

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

FromCStruct PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

peekCStruct :: Ptr PhysicalDeviceInvocationMaskFeaturesHUAWEI -> IO PhysicalDeviceInvocationMaskFeaturesHUAWEI

ToCStruct PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

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

pokeCStruct :: Ptr PhysicalDeviceInvocationMaskFeaturesHUAWEI -> PhysicalDeviceInvocationMaskFeaturesHUAWEI -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceInvocationMaskFeaturesHUAWEI -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceInvocationMaskFeaturesHUAWEI

Defined in Vulkan.Extensions.VK_HUAWEI_invocation_mask

Methods

zero :: PhysicalDeviceInvocationMaskFeaturesHUAWEI

type HUAWEI_INVOCATION_MASK_SPEC_VERSION = 1

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

type HUAWEI_INVOCATION_MASK_EXTENSION_NAME = "VK_HUAWEI_invocation_mask"

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