vkCmdSetSampleMaskEXT
To dynamically set the sample mask, call:
void vkCmdSetSampleMaskEXT(
VkCommandBuffer commandBuffer,
VkSampleCountFlagBits samples,
const VkSampleMask* pSampleMask);
pub fn cmd_set_sample_mask_ext(
command_buffer: vk::CommandBuffer,
samples: vk::SampleCountFlagBits,
p_sample_mask: *const vk::SampleMask,
);
commandBufferis the command buffer into which the command will be recorded.samplesspecifies the number of sample bits in thepSampleMask.pSampleMaskis a pointer to an array of VkSampleMask values, where the array size is based on thesamplesparameter. If themaintenance10feature is enabled, and this parameter is set toNULL, it is treated as if the mask has all bits set to1.
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
extendedDynamicState3SampleMaskfeature is enabled - The
shaderObjectfeature is enabled
VUID-vkCmdSetSampleMaskEXT-pSampleMask-10999
pSampleMask must not be NULL
if the maintenance10 feature is not
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
If pSampleMask is not NULL, pSampleMask must be a valid pointer to an array of 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 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
commandBuffermust be externally synchronized - Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized