VulkanHub
Function Prototype

vkCmdSetAlphaToOneEnableEXT

Specify the alpha to one enable state dynamically for a command buffer

primary / secondary
both
graphics
state

To dynamically set the alphaToOneEnable state, call:

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

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

Valid Usage

VUID-vkCmdSetAlphaToOneEnableEXT-None-09423

At least one of the following must be true:

VUID-vkCmdSetAlphaToOneEnableEXT-alphaToOne-07607

If the alphaToOne feature is not enabled, alphaToOneEnable must be VK_FALSE

Valid Usage (Implicit)

VUID-vkCmdSetAlphaToOneEnableEXT-commandBuffer-parameter

commandBuffer must be a valid VkCommandBuffer handle

VUID-vkCmdSetAlphaToOneEnableEXT-commandBuffer-recording

commandBuffer must be in the recording state

VUID-vkCmdSetAlphaToOneEnableEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

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