vkCmdSetSampleMaskEXT(3)

# vkCmdSetSampleMaskEXT(3) Manual Page

## Name

vkCmdSetSampleMaskEXT - Specify the sample mask dynamically for a command buffer

Loading… please wait.

## 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. 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`.

## 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

- 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 ⌈32 samples​⌉ 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 `commandBuffer` must be externally synchronized

- Host access to the `VkCommandPool` that `commandBuffer` was allocated from must be externally synchronized

Command Properties

Command Buffer Levels | Render Pass Scope | Video Coding Scope | Supported Queue Types | Command Type
--- | --- | --- | --- | ---
Primary Secondary | Both | Outside | VK_QUEUE_GRAPHICS_BIT | State

Conditional Rendering

vkCmdSetSampleMaskEXT is not affected by conditional rendering

## See Also

VK_EXT_extended_dynamic_state3, VK_EXT_shader_object, VkCommandBuffer, VkSampleCountFlagBits, VkSampleMask

## Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0