VulkanHub
Function Prototype

vkCmdSetSampleMaskEXT

Specify the sample mask dynamically for a command buffer
primary / secondary
both
graphics
state

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.

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:

Valid Usage (Implicit)

VUID-vkCmdSetSampleMaskEXT-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetSampleMaskEXT-samples-parameter

samples must be a valid VkSampleCountFlagBits value

VUID-vkCmdSetSampleMaskEXT-pSampleMask-parameter

pSampleMask must be a valid pointer to an array of ⌈samples32⌉\lceil{\mathit{samples} \over 32}\rceil VkSampleMask values

VUID-vkCmdSetSampleMaskEXT-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetSampleMaskEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics 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 ::