Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout

Description

Name

VK_KHR_workgroup_memory_explicit_layout - device extension

VK_KHR_workgroup_memory_explicit_layout

Name String: VK_KHR_workgroup_memory_explicit_layout

Extension Type

Device extension

Registered Extension Number

337

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

Contact

Caio Marcelo de Oliveira Filho @cmarcelo%0A*Here describe the issue or question you have about the VK_KHR_workgroup_memory_explicit_layout extension*

Other Extension Metadata

Last Modified Date: 2020-06-01

IP Status

No known IP claims.

Interactions and External Dependencies

This extension requires SPV_KHR_workgroup_memory_explicit_layout
This extension provides API support for GL_EXT_shared_memory_block

Contributors

Caio Marcelo de Oliveira Filho, Intel
Jeff Bolz, NVIDIA
Graeme Leese, Broadcom
Faith Ekstrand, Intel
Daniel Koch, NVIDIA

Description

This extension adds Vulkan support for the SPV_KHR_workgroup_memory_explicit_layout SPIR-V extension, which allows shaders to explicitly define the layout of Workgroup storage class memory and create aliases between variables from that storage class in a compute shader.

The aliasing feature allows different “views” on the same data, so the shader can bulk copy data from another storage class using one type (e.g. an array of large vectors), and then use the data with a more specific type. It also enables reducing the amount of workgroup memory consumed by allowing the shader to alias data whose lifetimes do not overlap.

The explicit layout support and some form of aliasing is also required for layering OpenCL on top of Vulkan.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

New Enum Constants

KHR_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_EXTENSION_NAME

New SPIR-V Capabilities

WorkgroupMemoryExplicitLayoutKHR

Version History

Revision 1, 2020-06-01 (Caio Marcelo de Oliveira Filho)
- Initial version

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.

Synopsis

data PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR = PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR {
}
type KHR_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_SPEC_VERSION = 1
pattern KHR_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_SPEC_VERSION :: forall a. Integral a => a
type KHR_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_EXTENSION_NAME = "VK_KHR_workgroup_memory_explicit_layout"
pattern KHR_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #

VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR - Structure describing the workgroup storage explicit layout features that can be supported by an implementation

Members

This structure describes the following features:

Description

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

Valid Usage (Implicit)

workgroupMemoryExplicitLayout :: Bool
workgroupMemoryExplicitLayout indicates whether the implementation supports the SPIR-V WorkgroupMemoryExplicitLayoutKHR capability.
workgroupMemoryExplicitLayoutScalarBlockLayout :: Bool
workgroupMemoryExplicitLayoutScalarBlockLayout indicates whether the implementation supports scalar alignment for laying out Workgroup Blocks.
workgroupMemoryExplicitLayout8BitAccess :: Bool
workgroupMemoryExplicitLayout8BitAccess indicates whether objects in the Workgroup storage class with the Block decoration can have 8-bit integer members. If this feature is not enabled, 8-bit integer members must not be used in such objects. This also indicates whether shader modules can declare the WorkgroupMemoryExplicitLayout8BitAccessKHR capability.
workgroupMemoryExplicitLayout16BitAccess :: Bool
workgroupMemoryExplicitLayout16BitAccess indicates whether objects in the Workgroup storage class with the Block decoration can have 16-bit integer and 16-bit floating-point members. If this feature is not enabled, 16-bit integer or 16-bit floating-point members must not be used in such objects. This also indicates whether shader modules can declare the WorkgroupMemoryExplicitLayout16BitAccessKHR capability.

Instances

Instances details

Storable PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods sizeOf :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Int # alignment :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Int # peekElemOff :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Int -> IO PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR # pokeElemOff :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Int -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO () # peek :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR # poke :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO () #
Show PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods showsPrec :: Int -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> ShowS # show :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> String # showList :: [PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR] -> ShowS #
Eq PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods (==) :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Bool # (/=) :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> Bool #
FromCStruct PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods peekCStruct :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
ToCStruct PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods withCStruct :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> (Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_workgroup_memory_explicit_layout Methods zero :: PhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR Source #