vkCmdSetAlphaToCoverageEnableEXT(3)

# vkCmdSetAlphaToCoverageEnableEXT(3) Manual Page

## Name

vkCmdSetAlphaToCoverageEnableEXT - Specify the alpha to coverage enable state dynamically for a command buffer

Loading… please wait.

## C Specification

To dynamically set the `alphaToOneEnable` state, call:

    // Provided by VK_EXT_extended_dynamic_state3
    void vkCmdSetAlphaToCoverageEnableEXT(
        VkCommandBuffer                             commandBuffer,
        VkBool32                                    alphaToCoverageEnable);

## Parameters

- `commandBuffer` is the command buffer into which the command will be recorded.

- `alphaToCoverageEnable` specifies the `alphaToCoverageEnable` state.

## Description

This command sets the `alphaToCoverageEnable` state for subsequent drawing commands when the graphics pipeline is created with `VK_DYNAMIC_STATE_ALPHA_TO_COVERAGE_ENABLE_EXT` set in VkPipelineDynamicStateCreateInfo::`pDynamicStates`. Otherwise, this state is specified by the VkPipelineMultisampleStateCreateInfo::`alphaToCoverageEnable` value used to create the currently active pipeline.

Valid Usage

- VUID-vkCmdSetAlphaToCoverageEnableEXT-extendedDynamicState3AlphaToCoverageEnable-07343
  The `extendedDynamicState3AlphaToCoverageEnable` feature must be enabled

Valid Usage (Implicit)

- VUID-vkCmdSetAlphaToCoverageEnableEXT-commandBuffer-parameter
  `commandBuffer` must be a valid VkCommandBuffer handle

- VUID-vkCmdSetAlphaToCoverageEnableEXT-commandBuffer-recording
  `commandBuffer` must be in the recording state

- VUID-vkCmdSetAlphaToCoverageEnableEXT-commandBuffer-cmdpool
  The `VkCommandPool` that `commandBuffer` was allocated from must support graphics operations

- VUID-vkCmdSetAlphaToCoverageEnableEXT-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 | Graphics | State

## See Also

VK_EXT_extended_dynamic_state3, `VkBool32`, VkCommandBuffer

## 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-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0