Package org.lwjgl.vulkan

Class NVCooperativeMatrix

java.lang.Object

org.lwjgl.vulkan.NVCooperativeMatrix

public class NVCooperativeMatrix
extends 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

VK_KHR_get_physical_device_properties2 or Version 1.1

SPIR-V Dependencies

• SPV_NV_cooperative_matrix

Contact

• Jeff Bolz jeffbolznv

Other Extension Metadata

Last Modified Date

2019-02-05

Interactions and External Dependencies

• This extension provides API support for GL_NV_cooperative_matrix

Contributors

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_COMPONENT_TYPE_FLOAT16_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_FLOAT32_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_FLOAT64_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_SINT16_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_SINT32_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_SINT64_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_SINT8_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_UINT16_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_UINT32_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_UINT64_NV	Extends VkComponentTypeKHR.
static final int	VK_COMPONENT_TYPE_UINT8_NV	Extends VkComponentTypeKHR.
static final String	VK_NV_COOPERATIVE_MATRIX_EXTENSION_NAME	The extension name.
static final int	VK_NV_COOPERATIVE_MATRIX_SPEC_VERSION	The extension specification version.
static final int	VK_SCOPE_DEVICE_NV	Extends VkScopeKHR.
static final int	VK_SCOPE_QUEUE_FAMILY_NV	Extends VkScopeKHR.
static final int	VK_SCOPE_SUBGROUP_NV	Extends VkScopeKHR.
static final int	VK_SCOPE_WORKGROUP_NV	Extends VkScopeKHR.
static final int	VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_PROPERTIES_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkCooperativeMatrixPropertiesNV.Buffer pProperties)	Array version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV
static int	vkGetPhysicalDeviceCooperativeMatrixPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, @Nullable 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 Details

VK_NV_COOPERATIVE_MATRIX_SPEC_VERSION

public static final int VK_NV_COOPERATIVE_MATRIX_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_NV_COOPERATIVE_MATRIX_EXTENSION_NAME

public static final String VK_NV_COOPERATIVE_MATRIX_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_NV

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_FEATURES_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

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_NV

public static final int VK_STRUCTURE_TYPE_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

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COOPERATIVE_MATRIX_PROPERTIES_NV

public static final int 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

See Also:

• Constant Field Values

VK_SCOPE_DEVICE_NV

public static final int VK_SCOPE_DEVICE_NV

Extends VkScopeKHR.

Enum values:

• SCOPE_DEVICE_NV
• SCOPE_WORKGROUP_NV
• SCOPE_SUBGROUP_NV
• SCOPE_QUEUE_FAMILY_NV

See Also:

• Constant Field Values

VK_SCOPE_WORKGROUP_NV

public static final int VK_SCOPE_WORKGROUP_NV

Extends VkScopeKHR.

Enum values:

• SCOPE_DEVICE_NV
• SCOPE_WORKGROUP_NV
• SCOPE_SUBGROUP_NV
• SCOPE_QUEUE_FAMILY_NV

See Also:

• Constant Field Values

VK_SCOPE_SUBGROUP_NV

public static final int VK_SCOPE_SUBGROUP_NV

Extends VkScopeKHR.

Enum values:

• SCOPE_DEVICE_NV
• SCOPE_WORKGROUP_NV
• SCOPE_SUBGROUP_NV
• SCOPE_QUEUE_FAMILY_NV

See Also:

• Constant Field Values

VK_SCOPE_QUEUE_FAMILY_NV

public static final int VK_SCOPE_QUEUE_FAMILY_NV

Extends VkScopeKHR.

Enum values:

• SCOPE_DEVICE_NV
• SCOPE_WORKGROUP_NV
• SCOPE_SUBGROUP_NV
• SCOPE_QUEUE_FAMILY_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_FLOAT16_NV

public static final int VK_COMPONENT_TYPE_FLOAT16_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_FLOAT32_NV

public static final int VK_COMPONENT_TYPE_FLOAT32_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_FLOAT64_NV

public static final int VK_COMPONENT_TYPE_FLOAT64_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_SINT8_NV

public static final int VK_COMPONENT_TYPE_SINT8_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_SINT16_NV

public static final int VK_COMPONENT_TYPE_SINT16_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_SINT32_NV

public static final int VK_COMPONENT_TYPE_SINT32_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_SINT64_NV

public static final int VK_COMPONENT_TYPE_SINT64_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_UINT8_NV

public static final int VK_COMPONENT_TYPE_UINT8_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_UINT16_NV

public static final int VK_COMPONENT_TYPE_UINT16_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_UINT32_NV

public static final int VK_COMPONENT_TYPE_UINT32_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

VK_COMPONENT_TYPE_UINT64_NV

public static final int VK_COMPONENT_TYPE_UINT64_NV

Extends VkComponentTypeKHR.

Enum values:

• COMPONENT_TYPE_FLOAT16_NV
• COMPONENT_TYPE_FLOAT32_NV
• COMPONENT_TYPE_FLOAT64_NV
• COMPONENT_TYPE_SINT8_NV
• COMPONENT_TYPE_SINT16_NV
• COMPONENT_TYPE_SINT32_NV
• COMPONENT_TYPE_SINT64_NV
• COMPONENT_TYPE_UINT8_NV
• COMPONENT_TYPE_UINT16_NV
• COMPONENT_TYPE_UINT32_NV
• COMPONENT_TYPE_UINT64_NV

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV

public static int nvkGetPhysicalDeviceCooperativeMatrixPropertiesNV(org.lwjgl.vulkan.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(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 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 application 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, and 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(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int[] pPropertyCount,
 @Nullable VkCooperativeMatrixPropertiesNV.Buffer pProperties)

Array version of: GetPhysicalDeviceCooperativeMatrixPropertiesNV