vkCmdSetSampleMaskEXT(3)

C Specification

To dynamically set the sample mask, call:

// Provided by VK_EXT_extended_dynamic_state3, VK_EXT_shader_object
void vkCmdSetSampleMaskEXT(
    VkCommandBuffer                             commandBuffer,
    VkSampleCountFlagBits                       samples,
    const VkSampleMask*                         pSampleMask);

Parameters

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.

Description

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:
- The extendedDynamicState3SampleMask feature is enabled
- The shaderObject feature is enabled

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 $⌈ \frac{s a m p l e s}{3 2} ⌉$ 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