public Class KHRDeviceGroup

Extends VkDependencyFlagBits.

Extends VkImageCreateFlagBits.

The extension name.

The extension specification version.

Extends VkMemoryAllocateFlagBits.

Extends VkPeerMemoryFeatureFlagBits.

Enum values:

• PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR

Extends VkPeerMemoryFeatureFlagBits.

Enum values:

• PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR

Extends VkPeerMemoryFeatureFlagBits.

Enum values:

• PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR

Extends VkPeerMemoryFeatureFlagBits.

Enum values:

• PEER_MEMORY_FEATURE_COPY_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_COPY_DST_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_SRC_BIT_KHR
• PEER_MEMORY_FEATURE_GENERIC_DST_BIT_KHR

Extends VkPipelineCreateFlagBits.

Enum values:

• PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
• PIPELINE_CREATE_DISPATCH_BASE_KHR

Extends VkPipelineCreateFlagBits.

Enum values:

• PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHR
• PIPELINE_CREATE_DISPATCH_BASE_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHR
• 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

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Extends VkStructureType.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHR
• STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHR
• STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHR

Extends VkSwapchainCreateFlagBitsKHR.

Unsafe version of: AcquireNextImage2KHR

Unsafe version of: GetDeviceGroupPeerMemoryFeaturesKHR

Unsafe version of: GetDeviceGroupPresentCapabilitiesKHR

Unsafe version of: GetDeviceGroupSurfacePresentModesKHR

Unsafe version of: GetPhysicalDevicePresentRectanglesKHR

Parameters

pRectCount:long

a pointer to an integer related to the number of rectangles available or queried, as described below.

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);

Description

If the swapchain has been created with the SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT flag, the image whose index is returned in pImageIndex will be fully backed by memory before this call returns to the application.

Valid Usage

• If forward progress cannot be guaranteed for 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:VkDevice

the device associated with swapchain.

pAcquireInfo:VkAcquireNextImageInfoKHR

a pointer to a VkAcquireNextImageInfoKHR structure containing parameters of the acquire.

pImageIndex:IntBuffer

a pointer to a uint32_t that is set to the index of the next image to use.

Annotations

@NativeType:VkResult

Array version of: AcquireNextImage2KHR

Annotations

@NativeType:VkResult

See CmdDispatchBase.

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

baseGroupX:int

the start value for the X component of WorkgroupId.

baseGroupY:int

the start value for the Y component of WorkgroupId.

baseGroupZ:int

the start value for the Z component of WorkgroupId.

groupCountX:int

the number of local workgroups to dispatch in the X dimension.

groupCountY:int

the number of local workgroups to dispatch in the Y dimension.

groupCountZ:int

the number of local workgroups to dispatch in the Z dimension.

See CmdSetDeviceMask.

Parameters

commandBuffer:VkCommandBuffer

command buffer whose current device mask is modified.

deviceMask:int

the new value of the current device mask.

See GetDeviceGroupPeerMemoryFeatures.

Parameters

device:VkDevice

the logical device that owns the memory.

heapIndex:int

the index of the memory heap from which the memory is allocated.

localDeviceIndex:int

the device index of the physical device that performs the memory access.

remoteDeviceIndex:int

the device index of the physical device that the memory is allocated for.

pPeerMemoryFeatures:IntBuffer

a pointer to a VkPeerMemoryFeatureFlags bitmask indicating which types of memory accesses are supported for the combination of heap, local, and remote devices.

Array version of: GetDeviceGroupPeerMemoryFeaturesKHR

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:VkDevice

the logical device.

pDeviceGroupPresentCapabilities:VkDeviceGroupPresentCapabilitiesKHR

a pointer to a VkDeviceGroupPresentCapabilitiesKHR structure in which the device’s capabilities are returned.

Annotations

@NativeType:VkResult

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

• surface must be supported by all physical devices associated with device, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

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:VkDevice

the logical device.

surface:long

the surface.

pModes:IntBuffer

a pointer to a VkDeviceGroupPresentModeFlagsKHR in which the supported device group present modes for the surface are returned.

Annotations

@NativeType:VkResult

Array version of: GetDeviceGroupSurfacePresentModesKHR

Annotations

@NativeType:VkResult

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, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available rectangles 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

• surface must be a valid VkSurfaceKHR handle
• surface must be supported by physicalDevice, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

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:VkPhysicalDevice

the physical device.

surface:long

the surface.

pRectCount:IntBuffer

a pointer to an integer related to the number of rectangles available or queried, as described below.

pRects:VkRect2D.Buffer

either NULL or a pointer to an array of VkRect2D structures.

Annotations

@NativeType:VkResult

Array version of: GetPhysicalDevicePresentRectanglesKHR

Annotations

@NativeType:VkResult