vkCmdSetDispatchParametersARM(3)

# vkCmdSetDispatchParametersARM(3) Manual Page

## Name

vkCmdSetDispatchParametersARM - Set parameters that affect dispatch commands

## C Specification

To set parameters that affect dispatch commands, call:

    // Provided by VK_ARM_scheduling_controls
    void vkCmdSetDispatchParametersARM(
        VkCommandBuffer                             commandBuffer,
        const VkDispatchParametersARM*              pDispatchParameters);

## Parameters

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

- `pDispatchParameters` is a pointer to a VkDispatchParametersARM structure specifying the dispatch parameters to be set.

## Description

Parameters set using `vkCmdSetDispatchParametersARM` affect the following dispatch commands:

- vkCmdDispatch

- vkCmdDispatchBase

- vkCmdDispatchIndirect

Valid Usage

- VUID-vkCmdSetDispatchParametersARM-schedulingControlsFlags-12391
  VkPhysicalDeviceSchedulingControlsPropertiesARM::`schedulingControlsFlags` must contain VK_PHYSICAL_DEVICE_SCHEDULING_CONTROLS_DISPATCH_PARAMETERS_ARM

Valid Usage (Implicit)

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

- VUID-vkCmdSetDispatchParametersARM-pDispatchParameters-parameter
  `pDispatchParameters` must be a valid pointer to a valid VkDispatchParametersARM structure

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

- VUID-vkCmdSetDispatchParametersARM-commandBuffer-cmdpool
  The `VkCommandPool` that `commandBuffer` was allocated from must support VK_QUEUE_COMPUTE_BIT operations

- VUID-vkCmdSetDispatchParametersARM-renderpass
  This command must only be called outside of a render pass instance

- VUID-vkCmdSetDispatchParametersARM-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 | Outside | Outside | VK_QUEUE_COMPUTE_BIT | State

Conditional Rendering

vkCmdSetDispatchParametersARM is not affected by conditional rendering

## See Also

VK_ARM_scheduling_controls, VkCommandBuffer, VkDispatchParametersARM

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