VulkanHub
Function Prototype

vkCmdSetSampleLocationsEnableEXT

Specify the samples locations enable state dynamically for a command buffer
primary / secondary
both
graphics
state

To dynamically set the sampleLocationsEnable state, call:

void vkCmdSetSampleLocationsEnableEXT(
    VkCommandBuffer commandBuffer,
    VkBool32 sampleLocationsEnable);
  • commandBuffer is the command buffer into which the command will be recorded.
  • sampleLocationsEnable specifies the sampleLocationsEnable state.

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

Valid Usage

VUID-vkCmdSetSampleLocationsEnableEXT-None-09423

At least one of the following must be true:- The extendedDynamicState3SampleLocationsEnable feature is enabled

Valid Usage (Implicit)

VUID-vkCmdSetSampleLocationsEnableEXT-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetSampleLocationsEnableEXT-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetSampleLocationsEnableEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

VUID-vkCmdSetSampleLocationsEnableEXT-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 ::