Package org.lwjgl.vulkan

Class NVCooperativeMatrix

java.lang.Object

org.lwjgl.vulkan.NVCooperativeMatrix

public class NVCooperativeMatrix
extends java.lang.Object

This extension adds support for using cooperative matrix types in SPIR-V. Cooperative matrix types are medium-sized matrices that are primarily supported in compute shaders, where the storage for the matrix is spread across all invocations in some scope (usually a subgroup) and those invocations cooperate to efficiently perform matrix multiplies.

Cooperative matrix types are defined by the SPV_NV_cooperative_matrix SPIR-V extension and can be used with the GL_NV_cooperative_matrix GLSL extension.

This extension includes support for enumerating the matrix types and dimensions that are supported by the implementation.

Name String

VK_NV_cooperative_matrix

Extension Type

Device extension

Registered Extension Number

250

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Jeff Bolz jeffbolznv

Last Modified Data

2019-02-05

Contributors

• Jeff Bolz, NVIDIA
• Markus Tavenrath, NVIDIA
• Daniel Koch, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static int	VK_COMPONENT_TYPE_FLOAT16_NV VK_COMPONENT_TYPE_FLOAT32_NV VK_COMPONENT_TYPE_FLOAT64_NV VK_COMPONENT_TYPE_SINT16_NV VK_COMPONENT_TYPE_SINT32_NV VK_COMPONENT_TYPE_SINT64_NV VK_COMPONENT_TYPE_SINT8_NV VK_COMPONENT_TYPE_UINT16_NV VK_COMPONENT_TYPE_UINT32_NV VK_COMPONENT_TYPE_UINT64_NV VK_COMPONENT_TYPE_UINT8_NV	VkComponentTypeNV - Specify SPIR-V cooperative matrix component type
static java.lang.String	VK_NV_COOPERATIVE_MATRIX_EXTENSION_NAME	The extension name.
static int	VK_NV_COOPERATIVE_MATRIX_SPEC_VERSION	The extension specification version.
static int	VK_SCOPE_DEVICE_NV VK_SCOPE_QUEUE_FAMILY_NV VK_SCOPE_SUBGROUP_NV VK_SCOPE_WORKGROUP_NV	VkScopeNV - Specify SPIR-V scope
static int	VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_NV VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_NV VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_PROPERTIES_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkCooperativeMatrixPropertiesNV.Buffer pProperties)	Array version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkCooperativeMatrixPropertiesNV.Buffer pProperties)	Returns properties describing what cooperative matrix types are supported.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_NV_COOPERATIVE_MATRIX_SPEC_VERSION

The extension specification version.

VK_NV_COOPERATIVE_MATRIX_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_NV, VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_NV, VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_PROPERTIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_NV
• STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_PROPERTIES_NV

VK_COMPONENT_TYPE_FLOAT16_NV, VK_COMPONENT_TYPE_FLOAT32_NV, VK_COMPONENT_TYPE_FLOAT64_NV, VK_COMPONENT_TYPE_SINT8_NV, VK_COMPONENT_TYPE_SINT16_NV, VK_COMPONENT_TYPE_SINT32_NV, VK_COMPONENT_TYPE_SINT64_NV, VK_COMPONENT_TYPE_UINT8_NV, VK_COMPONENT_TYPE_UINT16_NV, VK_COMPONENT_TYPE_UINT32_NV, VK_COMPONENT_TYPE_UINT64_NV

VkComponentTypeNV - Specify SPIR-V cooperative matrix component type

Description

• COMPONENT_TYPE_FLOAT16_NV corresponds to SPIR-V OpTypeFloat 16.
• COMPONENT_TYPE_FLOAT32_NV corresponds to SPIR-V OpTypeFloat 32.
• COMPONENT_TYPE_FLOAT64_NV corresponds to SPIR-V OpTypeFloat 64.
• COMPONENT_TYPE_SINT8_NV corresponds to SPIR-V OpTypeInt 8 1.
• COMPONENT_TYPE_SINT16_NV corresponds to SPIR-V OpTypeInt 16 1.
• COMPONENT_TYPE_SINT32_NV corresponds to SPIR-V OpTypeInt 32 1.
• COMPONENT_TYPE_SINT64_NV corresponds to SPIR-V OpTypeInt 64 1.
• COMPONENT_TYPE_UINT8_NV corresponds to SPIR-V OpTypeInt 8 0.
• COMPONENT_TYPE_UINT16_NV corresponds to SPIR-V OpTypeInt 16 0.
• COMPONENT_TYPE_UINT32_NV corresponds to SPIR-V OpTypeInt 32 0.
• COMPONENT_TYPE_UINT64_NV corresponds to SPIR-V OpTypeInt 64 0.

See Also

VkCooperativeMatrixPropertiesNV

VK_SCOPE_DEVICE_NV, VK_SCOPE_WORKGROUP_NV, VK_SCOPE_SUBGROUP_NV, VK_SCOPE_QUEUE_FAMILY_NV

VkScopeNV - Specify SPIR-V scope

Description

• SCOPE_DEVICE_NV corresponds to SPIR-V Device scope.
• SCOPE_WORKGROUP_NV corresponds to SPIR-V Workgroup scope.
• SCOPE_SUBGROUP_NV corresponds to SPIR-V Subgroup scope.
• SCOPE_QUEUE_FAMILY_NV corresponds to SPIR-V QueueFamilyKHR scope.

All enum values match the corresponding SPIR-V value.

See Also

VkCooperativeMatrixPropertiesNV

Method Detail

nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV

public static int nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice,
                                                                    long pPropertyCount,
                                                                    long pProperties)

Unsafe version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV

Parameters:

pPropertyCount - a pointer to an integer related to the number of cooperative matrix properties available or queried.

vkGetPhysicalDeviceCooperativeMatrixPropertiesNV

public static int vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice,
                                                                   java.nio.IntBuffer pPropertyCount,
                                                                   @Nullable
                                                                   VkCooperativeMatrixPropertiesNV.Buffer pProperties)

Returns properties describing what cooperative matrix types are supported.

C Specification

To enumerate the supported cooperative matrix types and operations, call:

 VkResult vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkCooperativeMatrixPropertiesNV*            pProperties);

Description

If pProperties is NULL, then the number of cooperative matrix properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of cooperative matrix properties available, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of cooperative matrix properties available, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available cooperative matrix properties were returned.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkCooperativeMatrixPropertiesNV structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkCooperativeMatrixPropertiesNV

Parameters:

physicalDevice - the physical device.

pPropertyCount - a pointer to an integer related to the number of cooperative matrix properties available or queried.

pProperties - either NULL or a pointer to an array of VkCooperativeMatrixPropertiesNV structures.

vkGetPhysicalDeviceCooperativeMatrixPropertiesNV

public static int vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(VkPhysicalDevice physicalDevice,
                                                                   int[] pPropertyCount,
                                                                   @Nullable
                                                                   VkCooperativeMatrixPropertiesNV.Buffer pProperties)

Array version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV