Vulkan.Extensions.VK_ARM_shader_core_builtins

Name

VK_ARM_shader_core_builtins - device extension

VK_ARM_shader_core_builtins

Name String

VK_ARM_shader_core_builtins

Extension Type

Device extension

Registered Extension Number

498

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Contact

• Kevin Petit @kevinpetit%0A*Here describe the issue or question you have about the VK_ARM_shader_core_builtins extension*

Other Extension Metadata

Last Modified Date

2022-10-05

Interactions and External Dependencies

• This extension requires SPV_ARM_core_builtins.
• This extension provides API support for GL_ARM_shader_core_builtins

Contributors

• Kevin Petit, Arm Ltd.
• Jan-Harald Fredriksen, Arm Ltd.

Description

This extension provides the ability to determine device-specific properties on Arm GPUs. It exposes properties for the number of shader cores, the maximum number of warps that can run on a shader core, and shader builtins to enable invocations to identify which core and warp a shader invocation is executing on.

This extension enables support for the SPIR-V CoreBuiltinsARM capability.

These properties and built-ins can be used for debugging or performance optimisation purposes. A typical optimisation example would be to use CoreIDARM to select a per-shader-core instance of a data structure in algorithms that use atomics so as to reduce contention.

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceShaderCoreBuiltinsFeaturesARM

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceShaderCoreBuiltinsPropertiesARM

New Enum Constants

• ARM_SHADER_CORE_BUILTINS_EXTENSION_NAME

• ARM_SHADER_CORE_BUILTINS_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_CORE_BUILTINS_FEATURES_ARM
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_CORE_BUILTINS_PROPERTIES_ARM

New or Modified Built-In Variables

• CoreCountARM

• CoreMaxIDARM
• CoreIDARM
• WarpsMaxIDARM
• WarpIDARM

New SPIR-V Capabilities

• CoreBuiltinsARM

Issues

None.

Version History

• Revision 1, 2022-10-05 (Kevin Petit)

  • Initial revision

• Revision 2, 2022-10-26 (Kevin Petit)

  • Add shaderCoreMask property

See Also

PhysicalDeviceShaderCoreBuiltinsFeaturesARM, PhysicalDeviceShaderCoreBuiltinsPropertiesARM

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.

Documentation

data PhysicalDeviceShaderCoreBuiltinsPropertiesARM

VkPhysicalDeviceShaderCoreBuiltinsPropertiesARM - Structure describing shader core builtins properties supported by an implementation

Description

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

Valid Usage (Implicit)

See Also

VK_ARM_shader_core_builtins, StructureType

Constructors

PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Fields

• shaderCoreMask :: Word64

  shaderCoreMask is a bitfield where each bit set represents the presence of a shader core whose ID is the bit position. The highest ID for any shader core on the device is the position of the most significant bit set.

• shaderCoreCount :: Word32

  shaderCoreCount is the number of shader cores on the device.

• shaderWarpsPerCore :: Word32

  shaderWarpsPerCore is the maximum number of simultaneously executing warps on a shader core.

Instances

Storable PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

sizeOf :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Int

alignment :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Int

peekElemOff :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Int -> IO PhysicalDeviceShaderCoreBuiltinsPropertiesARM

pokeElemOff :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Int -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceShaderCoreBuiltinsPropertiesARM

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO ()

peek :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO PhysicalDeviceShaderCoreBuiltinsPropertiesARM

poke :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO ()

Show PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

showsPrec :: Int -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> ShowS

show :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> String

showList :: [PhysicalDeviceShaderCoreBuiltinsPropertiesARM] -> ShowS

Eq PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

(==) :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Bool

(/=) :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> Bool

FromCStruct PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

peekCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO PhysicalDeviceShaderCoreBuiltinsPropertiesARM

ToCStruct PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

withCStruct :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> (Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsPropertiesARM -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceShaderCoreBuiltinsPropertiesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

zero :: PhysicalDeviceShaderCoreBuiltinsPropertiesARM

data PhysicalDeviceShaderCoreBuiltinsFeaturesARM

VkPhysicalDeviceShaderCoreBuiltinsFeaturesARM - Structure describing the shader core builtins features that can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceShaderCoreBuiltinsFeaturesARM 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. PhysicalDeviceShaderCoreBuiltinsFeaturesARM can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_ARM_shader_core_builtins, Bool32, StructureType

Constructors

PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Fields

• shaderCoreBuiltins :: Bool

  shaderCoreBuiltins indicates whether the implementation supports the SPIR-V CoreBuiltinsARM capability.

Instances

Storable PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

sizeOf :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Int

alignment :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Int

peekElemOff :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Int -> IO PhysicalDeviceShaderCoreBuiltinsFeaturesARM

pokeElemOff :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Int -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceShaderCoreBuiltinsFeaturesARM

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO ()

peek :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO PhysicalDeviceShaderCoreBuiltinsFeaturesARM

poke :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO ()

Show PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

showsPrec :: Int -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> ShowS

show :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> String

showList :: [PhysicalDeviceShaderCoreBuiltinsFeaturesARM] -> ShowS

Eq PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

(==) :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Bool

(/=) :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> Bool

FromCStruct PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

peekCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO PhysicalDeviceShaderCoreBuiltinsFeaturesARM

ToCStruct PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

withCStruct :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> (Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceShaderCoreBuiltinsFeaturesARM -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceShaderCoreBuiltinsFeaturesARM

Defined in Vulkan.Extensions.VK_ARM_shader_core_builtins

Methods

zero :: PhysicalDeviceShaderCoreBuiltinsFeaturesARM

type ARM_SHADER_CORE_BUILTINS_SPEC_VERSION = 2

pattern ARM_SHADER_CORE_BUILTINS_SPEC_VERSION :: forall a. Integral a => a

type ARM_SHADER_CORE_BUILTINS_EXTENSION_NAME = "VK_ARM_shader_core_builtins"

pattern ARM_SHADER_CORE_BUILTINS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a