KHRDeviceGroup (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.vulkan.KHRDeviceGroup

```
public class KHRDeviceGroup
extends java.lang.Object
```
This extension provides functionality to use a logical device that consists of multiple physical devices, as created with the VK_KHR_device_group_creation extension. A device group can allocate memory across the subdevices, bind memory from one subdevice to a resource on another subdevice, record command buffers where some work executes on an arbitrary subset of the subdevices, and potentially present a swapchain image from one or more subdevices.
Promotion to Vulkan 1.1

The following enums, types and commands are included as interactions with VK_KHR_swapchain:
If Vulkan 1.1 and VK_KHR_swapchain are supported, these are included by VK_KHR_swapchain.

The base functionality in this extension is included in core Vulkan 1.1, with the KHR suffix omitted. The original type, enum and command names are still available as aliases of the core functionality.

Examples

TODO
Name String

VK_KHR_device_group

Extension Type

Device extension

Registered Extension Number

61

Revision

4

Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires VK_KHR_device_group_creation
Deprecation state
- Promoted to Vulkan 1.1
Contact
- Jeff Bolz jeffbolznv
Last Modified Date

2017-10-10

IP Status

No known IP claims.

Interactions and External Dependencies
- Promoted to Vulkan 1.1 Core
Contributors
- Jeff Bolz, NVIDIA
- Tobias Hector, Imagination Technologies

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`VK_DEPENDENCY_DEVICE_GROUP_BIT_KHR` Extends `VkDependencyFlagBits`.
`static int`	`VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR` Extends `VkImageCreateFlagBits`.
`static java.lang.String`	`VK_KHR_DEVICE_GROUP_EXTENSION_NAME` The extension name.
`static int`	`VK_KHR_DEVICE_GROUP_SPEC_VERSION` The extension specification version.
`static int`	`VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR` Extends `VkMemoryAllocateFlagBits`.
`static int`	`VK_PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR` Extends `VkPeerMemoryFeatureFlagBits`.
`static int`	`VK_PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR` Extends `VkPeerMemoryFeatureFlagBits`.
`static int`	`VK_PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR` Extends `VkPeerMemoryFeatureFlagBits`.
`static int`	`VK_PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR` Extends `VkPeerMemoryFeatureFlagBits`.
`static int`	`VK_PIPELINE_CREATE_DISPATCH_BASE_KHR` Extends `VkPipelineCreateFlagBits`.
`static int`	`VK_PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR` Extends `VkPipelineCreateFlagBits`.
`static int`	`VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR` Extends `VkStructureType`.
`static int`	`VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR` Extends `VkSwapchainCreateFlagBitsKHR`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`nvkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device, long pAcquireInfo, long pImageIndex)` Unsafe version of: `AcquireNextImage2KHR`
`static void`	`nvkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device, int heapIndex, int localDeviceIndex, int remoteDeviceIndex, long pPeerMemoryFeatures)` Unsafe version of: `GetDeviceGroupPeerMemoryFeaturesKHR`
`static int`	`nvkGetDeviceGroupPresentCapabilitiesKHR(org.lwjgl.vulkan.VkDevice device, long pDeviceGroupPresentCapabilities)` Unsafe version of: `GetDeviceGroupPresentCapabilitiesKHR`
`static int`	`nvkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device, long surface, long pModes)` Unsafe version of: `GetDeviceGroupSurfacePresentModesKHR`
`static int`	`nvkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long surface, long pRectCount, long pRects)` Unsafe version of: `GetPhysicalDevicePresentRectanglesKHR`
`static int`	`vkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device, VkAcquireNextImageInfoKHR pAcquireInfo, int[] pImageIndex)` Array version of: `AcquireNextImage2KHR`
`static int`	`vkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device, VkAcquireNextImageInfoKHR pAcquireInfo, java.nio.IntBuffer pImageIndex)` Retrieve the index of the next available presentable image.
`static void`	`vkCmdDispatchBaseKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int baseGroupX, int baseGroupY, int baseGroupZ, int groupCountX, int groupCountY, int groupCountZ)` See `CmdDispatchBase`.
`static void`	`vkCmdSetDeviceMaskKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int deviceMask)` See `CmdSetDeviceMask`.
`static void`	`vkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device, int heapIndex, int localDeviceIndex, int remoteDeviceIndex, int[] pPeerMemoryFeatures)` Array version of: `GetDeviceGroupPeerMemoryFeaturesKHR`
`static void`	`vkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device, int heapIndex, int localDeviceIndex, int remoteDeviceIndex, java.nio.IntBuffer pPeerMemoryFeatures)` See `GetDeviceGroupPeerMemoryFeatures`.
`static int`	`vkGetDeviceGroupPresentCapabilitiesKHR(org.lwjgl.vulkan.VkDevice device, VkDeviceGroupPresentCapabilitiesKHR pDeviceGroupPresentCapabilities)` Query present capabilities from other physical devices.
`static int`	`vkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device, long surface, int[] pModes)` Array version of: `GetDeviceGroupSurfacePresentModesKHR`
`static int`	`vkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device, long surface, java.nio.IntBuffer pModes)` Query present capabilities for a surface.
`static int`	`vkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long surface, int[] pRectCount, VkRect2D.Buffer pRects)` Array version of: `GetPhysicalDevicePresentRectanglesKHR`
`static int`	`vkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long surface, java.nio.IntBuffer pRectCount, VkRect2D.Buffer pRects)` Query present rectangles for a surface on a physical device.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VK_KHR_DEVICE_GROUP_SPEC_VERSION
```
public static final int VK_KHR_DEVICE_GROUP_SPEC_VERSION
```
    The extension specification version.
    
    See Also:
    
    Constant Field Values
  - VK_KHR_DEVICE_GROUP_EXTENSION_NAME
```
public static final java.lang.String VK_KHR_DEVICE_GROUP_EXTENSION_NAME
```
    The extension name.
    
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
```
public static final int VK_PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
```
    Extends VkPeerMemoryFeatureFlagBits.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
```
public static final int VK_PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
```
    Extends VkPeerMemoryFeatureFlagBits.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
```
public static final int VK_PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
```
    Extends VkPeerMemoryFeatureFlagBits.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR
```
public static final int VK_PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR
```
    Extends VkPeerMemoryFeatureFlagBits.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR
```
public static final int VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR
```
    Extends VkMemoryAllocateFlagBits.
    
    See Also:
    
    Constant Field Values
  - VK_PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
```
public static final int VK_PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
```
    Extends VkPipelineCreateFlagBits.
    Enum values:
    - PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
    - PIPELINE_CREATE_DISPATCH_BASE_KHR
    See Also:
    
    Constant Field Values
  - VK_PIPELINE_CREATE_DISPATCH_BASE_KHR
```
public static final int VK_PIPELINE_CREATE_DISPATCH_BASE_KHR
```
    Extends VkPipelineCreateFlagBits.
    Enum values:
    - PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
    - PIPELINE_CREATE_DISPATCH_BASE_KHR
    See Also:
    
    Constant Field Values
  - VK_DEPENDENCY_DEVICE_GROUP_BIT_KHR
```
public static final int VK_DEPENDENCY_DEVICE_GROUP_BIT_KHR
```
    Extends VkDependencyFlagBits.
    
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    - STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
    - STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    - STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
    - STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR
    See Also:
    
    Constant Field Values
  - VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
```
public static final int VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
```
    Extends VkImageCreateFlagBits.
    
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR
```
    Extends VkStructureType.
    
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR
```
public static final int VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR
```
    Extends VkStructureType.
    Enum values:
    See Also:
    
    Constant Field Values
  - VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
```
public static final int VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR
```
    Extends VkSwapchainCreateFlagBitsKHR.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - nvkGetDeviceGroupPeerMemoryFeaturesKHR
```
public static void nvkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device,
                                                          int heapIndex,
                                                          int localDeviceIndex,
                                                          int remoteDeviceIndex,
                                                          long pPeerMemoryFeatures)
```
    Unsafe version of: GetDeviceGroupPeerMemoryFeaturesKHR
  - vkGetDeviceGroupPeerMemoryFeaturesKHR
```
public static void vkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device,
                                                         int heapIndex,
                                                         int localDeviceIndex,
                                                         int remoteDeviceIndex,
                                                         java.nio.IntBuffer pPeerMemoryFeatures)
```
    See GetDeviceGroupPeerMemoryFeatures.
    
    Parameters:
    
    device - the logical device that owns the memory.
    
    heapIndex - the index of the memory heap from which the memory is allocated.
    
    localDeviceIndex - the device index of the physical device that performs the memory access.
    
    remoteDeviceIndex - the device index of the physical device that the memory is allocated for.
    
    pPeerMemoryFeatures - a pointer to a VkPeerMemoryFeatureFlags bitmask indicating which types of memory accesses are supported for the combination of heap, local, and remote devices.
  - vkCmdSetDeviceMaskKHR
```
public static void vkCmdSetDeviceMaskKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                         int deviceMask)
```
    See CmdSetDeviceMask.
    
    Parameters:
    
    commandBuffer - command buffer whose current device mask is modified.
    
    deviceMask - the new value of the current device mask.
  - vkCmdDispatchBaseKHR
```
public static void vkCmdDispatchBaseKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                        int baseGroupX,
                                        int baseGroupY,
                                        int baseGroupZ,
                                        int groupCountX,
                                        int groupCountY,
                                        int groupCountZ)
```
    See CmdDispatchBase.
    
    Parameters:
    
    commandBuffer - the command buffer into which the command will be recorded.
    
    baseGroupX - the start value for the X component of WorkgroupId.
    
    baseGroupY - the start value for the Y component of WorkgroupId.
    
    baseGroupZ - the start value for the Z component of WorkgroupId.
    
    groupCountX - the number of local workgroups to dispatch in the X dimension.
    
    groupCountY - the number of local workgroups to dispatch in the Y dimension.
    
    groupCountZ - the number of local workgroups to dispatch in the Z dimension.
  - nvkGetDeviceGroupPresentCapabilitiesKHR
```
public static int nvkGetDeviceGroupPresentCapabilitiesKHR(org.lwjgl.vulkan.VkDevice device,
                                                          long pDeviceGroupPresentCapabilities)
```
    Unsafe version of: GetDeviceGroupPresentCapabilitiesKHR
  - vkGetDeviceGroupPresentCapabilitiesKHR
```
public static int vkGetDeviceGroupPresentCapabilitiesKHR(org.lwjgl.vulkan.VkDevice device,
                                                         VkDeviceGroupPresentCapabilitiesKHR pDeviceGroupPresentCapabilities)
```
    Query present capabilities from other physical devices.
    C Specification
    
    A logical device that represents multiple physical devices may support presenting from images on more than one physical device, or combining images from multiple physical devices.
    
    To query these capabilities, call:
```
 VkResult vkGetDeviceGroupPresentCapabilitiesKHR(
     VkDevice                                    device,
     VkDeviceGroupPresentCapabilitiesKHR*        pDeviceGroupPresentCapabilities);
```
    Valid Usage (Implicit)
    - device must be a valid VkDevice handle
    - pDeviceGroupPresentCapabilities must be a valid pointer to a VkDeviceGroupPresentCapabilitiesKHR structure
    Return Codes
    On success, this command returns
    
    SUCCESS
    
    On failure, this command returns
    
    ERROR_OUT_OF_HOST_MEMORY
    
    ERROR_OUT_OF_DEVICE_MEMORY
    See Also
    
    VkDeviceGroupPresentCapabilitiesKHR
    Parameters:
    
    device - the logical device.
    
    pDeviceGroupPresentCapabilities - a pointer to a VkDeviceGroupPresentCapabilitiesKHR structure in which the device’s capabilities are returned.
  - nvkGetDeviceGroupSurfacePresentModesKHR
```
public static int nvkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device,
                                                          long surface,
                                                          long pModes)
```
    Unsafe version of: GetDeviceGroupSurfacePresentModesKHR
  - vkGetDeviceGroupSurfacePresentModesKHR
```
public static int vkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device,
                                                         long surface,
                                                         java.nio.IntBuffer pModes)
```
    Query present capabilities for a surface.
    C Specification
    
    Some surfaces may not be capable of using all the device group present modes.
    
    To query the supported device group present modes for a particular surface, call:
```
 VkResult vkGetDeviceGroupSurfacePresentModesKHR(
     VkDevice                                    device,
     VkSurfaceKHR                                surface,
     VkDeviceGroupPresentModeFlagsKHR*           pModes);
```
    Description
    
    The modes returned by this command are not invariant, and may change in response to the surface being moved, resized, or occluded. These modes must be a subset of the modes returned by GetDeviceGroupPresentCapabilitiesKHR.
    
    Valid Usage (Implicit)
    - device must be a valid VkDevice handle
    - surface must be a valid VkSurfaceKHR handle
    - pModes must be a valid pointer to a VkDeviceGroupPresentModeFlagsKHR value
    - Both of device, and surface must have been created, allocated, or retrieved from the same VkInstance
    Host Synchronization
    - Host access to surface must be externally synchronized
    Return Codes
    On success, this command returns
    
    SUCCESS
    
    On failure, this command returns
    
    ERROR_OUT_OF_HOST_MEMORY
    
    ERROR_OUT_OF_DEVICE_MEMORY
    
    ERROR_SURFACE_LOST_KHR
    Parameters:
    
    device - the logical device.
    
    surface - the surface.
    
    pModes - a pointer to a VkDeviceGroupPresentModeFlagsKHR in which the supported device group present modes for the surface are returned.
  - nvkGetPhysicalDevicePresentRectanglesKHR
```
public static int nvkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                           long surface,
                                                           long pRectCount,
                                                           long pRects)
```
    Unsafe version of: GetPhysicalDevicePresentRectanglesKHR
    
    Parameters:
    
    pRectCount - a pointer to an integer related to the number of rectangles available or queried, as described below.
  - vkGetPhysicalDevicePresentRectanglesKHR
```
public static int vkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                          long surface,
                                                          java.nio.IntBuffer pRectCount,
                                                          @Nullable
                                                          VkRect2D.Buffer pRects)
```
    Query present rectangles for a surface on a physical device.
    C Specification
    
    When using DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, the application may need to know which regions of the surface are used when presenting locally on each physical device. Presentation of swapchain images to this surface need only have valid contents in the regions returned by this command.
    
    To query a set of rectangles used in presentation on the physical device, call:
```
 VkResult vkGetPhysicalDevicePresentRectanglesKHR(
     VkPhysicalDevice                            physicalDevice,
     VkSurfaceKHR                                surface,
     uint32_t*                                   pRectCount,
     VkRect2D*                                   pRects);
```
    Description
    
    If pRects is NULL, then the number of rectangles used when presenting the given surface is returned in pRectCount. Otherwise, pRectCount must point to a variable set by the user to the number of elements in the pRects array, and on return the variable is overwritten with the number of structures actually written to pRects. If the value of pRectCount is less than the number of rectangles, at most pRectCount structures will be written. If pRectCount is smaller than the number of rectangles used for the given surface, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.
    
    The values returned by this command are not invariant, and may change in response to the surface being moved, resized, or occluded.
    
    The rectangles returned by this command must not overlap.
    
    Valid Usage (Implicit)
    - physicalDevice must be a valid VkPhysicalDevice handle
    - surface must be a valid VkSurfaceKHR handle
    - pRectCount must be a valid pointer to a uint32_t value
    - If the value referenced by pRectCount is not 0, and pRects is not NULL, pRects must be a valid pointer to an array of pRectCount VkRect2D structures
    - Both of physicalDevice, and surface must have been created, allocated, or retrieved from the same VkInstance
    Host Synchronization
    - Host access to surface must be externally synchronized
    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
    
    VkRect2D
    Parameters:
    
    physicalDevice - the physical device.
    
    surface - the surface.
    
    pRectCount - a pointer to an integer related to the number of rectangles available or queried, as described below.
    
    pRects - either NULL or a pointer to an array of VkRect2D structures.
  - nvkAcquireNextImage2KHR
```
public static int nvkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device,
                                          long pAcquireInfo,
                                          long pImageIndex)
```
    Unsafe version of: AcquireNextImage2KHR
  - vkAcquireNextImage2KHR
```
public static int vkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device,
                                         VkAcquireNextImageInfoKHR pAcquireInfo,
                                         java.nio.IntBuffer pImageIndex)
```
    Retrieve the index of the next available presentable image.
    C Specification
    
    To acquire an available presentable image to use, and retrieve the index of that image, call:
```
 VkResult vkAcquireNextImage2KHR(
     VkDevice                                    device,
     const VkAcquireNextImageInfoKHR*            pAcquireInfo,
     uint32_t*                                   pImageIndex);
```
    Valid Usage
    - If the number of currently acquired images is greater than the difference between the number of images in the swapchain member of pAcquireInfo and the value of VkSurfaceCapabilitiesKHR::minImageCount as returned by a call to GetPhysicalDeviceSurfaceCapabilities2KHR with the surface used to create swapchain, the timeout member of pAcquireInfo must not be UINT64_MAX
    Valid Usage (Implicit)
    - device must be a valid VkDevice handle
    - pAcquireInfo must be a valid pointer to a valid VkAcquireNextImageInfoKHR structure
    - pImageIndex must be a valid pointer to a uint32_t value
    Return Codes
    On success, this command returns
    
    SUCCESS
    
    TIMEOUT
    
    NOT_READY
    
    SUBOPTIMAL_KHR
    
    On failure, this command returns
    
    ERROR_OUT_OF_HOST_MEMORY
    
    ERROR_OUT_OF_DEVICE_MEMORY
    
    ERROR_DEVICE_LOST
    
    ERROR_OUT_OF_DATE_KHR
    
    ERROR_SURFACE_LOST_KHR
    
    ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT
    See Also
    
    VkAcquireNextImageInfoKHR
    Parameters:
    
    device - the device associated with swapchain.
    
    pAcquireInfo - a pointer to a VkAcquireNextImageInfoKHR structure containing parameters of the acquire.
    
    pImageIndex - a pointer to a uint32_t that is set to the index of the next image to use.
  - vkGetDeviceGroupPeerMemoryFeaturesKHR
```
public static void vkGetDeviceGroupPeerMemoryFeaturesKHR(org.lwjgl.vulkan.VkDevice device,
                                                         int heapIndex,
                                                         int localDeviceIndex,
                                                         int remoteDeviceIndex,
                                                         int[] pPeerMemoryFeatures)
```
    Array version of: GetDeviceGroupPeerMemoryFeaturesKHR
  - vkGetDeviceGroupSurfacePresentModesKHR
```
public static int vkGetDeviceGroupSurfacePresentModesKHR(org.lwjgl.vulkan.VkDevice device,
                                                         long surface,
                                                         int[] pModes)
```
    Array version of: GetDeviceGroupSurfacePresentModesKHR
  - vkGetPhysicalDevicePresentRectanglesKHR
```
public static int vkGetPhysicalDevicePresentRectanglesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                          long surface,
                                                          int[] pRectCount,
                                                          @Nullable
                                                          VkRect2D.Buffer pRects)
```
    Array version of: GetPhysicalDevicePresentRectanglesKHR
  - vkAcquireNextImage2KHR
```
public static int vkAcquireNextImage2KHR(org.lwjgl.vulkan.VkDevice device,
                                         VkAcquireNextImageInfoKHR pAcquireInfo,
                                         int[] pImageIndex)
```
    Array version of: AcquireNextImage2KHR

Class KHRDeviceGroup

Promotion to Vulkan 1.1

Examples

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VK_KHR_DEVICE_GROUP_SPEC_VERSION

VK_KHR_DEVICE_GROUP_EXTENSION_NAME

VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Enum values:

VK_PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR

Enum values:

VK_PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR

Enum values:

VK_PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR

Enum values:

VK_PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR

Enum values:

VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHR

VK_PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR

Enum values:

VK_PIPELINE_CREATE_DISPATCH_BASE_KHR

Enum values:

VK_DEPENDENCY_DEVICE_GROUP_BIT_KHR

VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHR

Enum values:

VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR

VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR

VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR

Enum values:

VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Enum values:

VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR

Method Detail

nvkGetDeviceGroupPeerMemoryFeaturesKHR

vkGetDeviceGroupPeerMemoryFeaturesKHR

vkCmdSetDeviceMaskKHR

vkCmdDispatchBaseKHR

nvkGetDeviceGroupPresentCapabilitiesKHR

vkGetDeviceGroupPresentCapabilitiesKHR

C Specification

Valid Usage (Implicit)

Return Codes

See Also

nvkGetDeviceGroupSurfacePresentModesKHR

vkGetDeviceGroupSurfacePresentModesKHR

C Specification

Description

Valid Usage (Implicit)

Host Synchronization

Return Codes

nvkGetPhysicalDevicePresentRectanglesKHR

vkGetPhysicalDevicePresentRectanglesKHR

C Specification

Description

Valid Usage (Implicit)

Host Synchronization

Return Codes

See Also

nvkAcquireNextImage2KHR

vkAcquireNextImage2KHR

C Specification

Valid Usage