HORIZON HASKELLDocslts/ghc-10.0.x8174fa42026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8174fa4 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_ARM_scheduling_controls

Name

VK_ARM_scheduling_controls - device extension

VK_ARM_scheduling_controls

Name String

VK_ARM_scheduling_controls

Extension Type

Device extension

Registered Extension Number

418

Revision

2

Ratification Status

Not ratified

Extension and Version Dependencies

VK_ARM_shader_core_builtins

Contact

Other Extension Metadata

Last Modified Date

2025-09-05

Interactions and External Dependencies

None

IP Status

No known IP claims.

Contributors
  • Kévin Petit, Arm Ltd.

  • Jan-Harald Fredriksen, Arm Ltd.

  • Mikel Garai, Arm Ltd.

Description

This extension exposes a collection of controls to modify the scheduling behavior of Arm Mali devices.

New Commands

New Structures

New Enums

New Bitmasks

New Enum Constants

New SPIR-V Capabilities

None.

Issues

None.

Version History

  • Revision 1, 2023-08-23 (Kévin Petit)

    • Initial revision

See Also

No cross-references are available

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

  • 9 types
  • 1 value
  • Packagevulkan-3.27
  • Exports14
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceVK_ARM_scheduling_controls.hs
valuecmdSetDispatchParametersARM
  1. :: MonadIO io
  2. => CommandBuffer

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

  3. -> DispatchParametersARM

    pDispatchParameters is a pointer to a DispatchParametersARM structure specifying the dispatch parameters to be set.

  4. -> io ()
#

vkCmdSetDispatchParametersARM - Set parameters that affect dispatch commands

Description

Parameters set using cmdSetDispatchParametersARM affect the following dispatch commands:

Valid Usage

Valid Usage (Implicit)

  • pDispatchParameters must be a valid pointer to a valid DispatchParametersARM structure

  • commandBuffer must be in the recording state

  • The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT operations

  • This command must only be called outside of a render pass instance

  • 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 CommandPool 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, CommandBuffer, DispatchParametersARM

VkDeviceQueueShaderCoreControlCreateInfoARM - Control the number of shader cores used by queues

Description

Queues created without specifying DeviceQueueShaderCoreControlCreateInfoARM will default to using all the shader cores available.

Structure Chaining

Extends the structures

See Also

VK_ARM_scheduling_controls, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkPhysicalDeviceSchedulingControlsFeaturesARM - Structure describing scheduling controls features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceSchedulingControlsFeaturesARM structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceSchedulingControlsFeaturesARM, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

See Also

VK_ARM_scheduling_controls, Bool32, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkPhysicalDeviceSchedulingControlsPropertiesARM - Structure containing scheduling control properties of a physical device

Members

  • schedulingControlsFlags specifies the specific scheduling controls that a physical device supports.

Description

If the PhysicalDeviceSchedulingControlsPropertiesARM structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Structure Chaining

Extends the structure

See Also

VK_ARM_scheduling_controls, PhysicalDeviceSchedulingControlsFlagsARM, StructureType

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkPhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM - Structure containing scheduling control dispatch parameters properties of a physical device

Members

  • schedulingControlsMaxWarpsCount specifies the maximum number of warps that a shader core can run concurrently.

  • schedulingControlsMaxQueuedWorkgroupBatchesCount specifies the maximum number of workgroup batches that a shader core can queue.

  • schedulingControlsMaxWorkGroupBatchSize specifies the maximum size of workgroup batches that can be requested using DispatchParametersARM::workGroupBatchSize.

Description

If the PhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

If PhysicalDeviceSchedulingControlsPropertiesARM::schedulingControlsFlags does not contain PHYSICAL_DEVICE_SCHEDULING_CONTROLS_DISPATCH_PARAMETERS_ARM then schedulingControlsMaxWarpCount and schedulingControlsMaxQueuedBatchesCount are undefined.

Structure Chaining

Extends the structure

See Also

VK_ARM_scheduling_controls, StructureType

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkDispatchParametersARM - Structure specifying parameters that affect dispatch commands

Valid Usage (Implicit)

See Also

VK_ARM_scheduling_controls, StructureType, cmdSetDispatchParametersARM

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

VkPhysicalDeviceSchedulingControlsFlagBitsARM - Bitmask specifying scheduling controls supported by a physical device

Description

See Also

VK_ARM_scheduling_controls, PhysicalDeviceSchedulingControlsFlagsARM

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …