vkCmdSetRasterizerDiscardEnable(3)

# vkCmdSetRasterizerDiscardEnable(3) Manual Page

## Name

vkCmdSetRasterizerDiscardEnable - Control whether primitives are discarded before the rasterization stage dynamically for a command buffer

Loading… please wait.

## C Specification

To dynamically enable whether primitives are discarded before the rasterization stage, call:

    // Provided by VK_VERSION_1_3
    void vkCmdSetRasterizerDiscardEnable(
        VkCommandBuffer                             commandBuffer,
        VkBool32                                    rasterizerDiscardEnable);

or the equivalent command

    // Provided by VK_EXT_extended_dynamic_state2, VK_EXT_shader_object
    void vkCmdSetRasterizerDiscardEnableEXT(
        VkCommandBuffer                             commandBuffer,
        VkBool32                                    rasterizerDiscardEnable);

## Parameters

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

- `rasterizerDiscardEnable` controls whether primitives are discarded immediately before the rasterization stage.

## Description

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

Valid Usage

- VUID-vkCmdSetRasterizerDiscardEnable-None-08970
  At least one of the following must be true:

  - the `extendedDynamicState2` feature is enabled

  - the `shaderObject` feature is enabled

  - the value of VkApplicationInfo::`apiVersion` used to create the VkInstance parent of `commandBuffer` is greater than or equal to Version 1.3

Valid Usage (Implicit)

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

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

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

- VUID-vkCmdSetRasterizerDiscardEnable-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_state2, VK_EXT_shader_object, VK_VERSION_1_3, 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-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0