Function Prototype

vkCmdSetSampleMaskEXT

Specify the sample mask dynamically for a command buffer

To dynamically set the sample mask, call:

void vkCmdSetSampleMaskEXT(
    VkCommandBuffer commandBuffer,
    VkSampleCountFlagBits  samples,
    const VkSampleMask*    pSampleMask);
  • commandBuffer is the command buffer into which the command will be recorded.
  • samples specifies the number of sample bits in the pSampleMask.
  • pSampleMask is a pointer to an array of VkSampleMask values, where the array size is based on the samples parameter. If the maintenance10 feature is enabled, and this parameter is set to NULL, it is treated as if the mask has all bits set to 1.

This command sets the sample mask for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_SAMPLE_MASK_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineMultisampleStateCreateInfo::pSampleMask value used to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetSampleMaskEXT-None-09423

At least one of the following must be true:

VUID-vkCmdSetSampleMaskEXT-pSampleMask-10999

pSampleMask must not be NULL if the maintenance10 feature is not enabled

Valid Usage (Implicit)

VUID-vkCmdSetSampleMaskEXT-pSampleMask-parameter

If pSampleMask is not NULL, pSampleMask must be a valid pointer to an array of samples32\lceil{\mathit{samples} \over 32}\rceil VkSampleMask values

VUID-vkCmdSetSampleMaskEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_GRAPHICS_BIT operations

VUID-vkCmdSetSampleMaskEXT-videocoding

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 VkCommandPool that commandBuffer was allocated from must be externally synchronized