Vulkan-Docs/doc/specs/vulkan/appendices/VK_KHX_device_group.txt
Jon Leech 0cc6bba634 Change log for September 15, 2017 Vulkan 1.0.61 spec update:
* Bump API patch number and header version number to 61 for this update.

Github Issues:

  * Provide alternate length attributes (altlen=) in the XML schema, for
    those using length attributes to generate code instead of documentation
    (public issue 555).
  * Fix erroneous references to `latex:` being used for asciidoc math
    markup, rather than `latexmath:` (public pull request 556).
  * Add author ID to XML for Kazan software renderer (public pull request
    557).

Internal Issues:

  * Add the <<fundamentals-abi,Application Binary Interface>> section
    describing platform ABI requirements and recommendations, add examples
    of function and function pointer declarations to the
    <<boilerplate-platform-specific-calling-conventions, Platform-Specific
    Calling Conventions>> section, and remove related language that existed
    elsewhere in the specification (internal issue 64).
  * Describe where to document valid usage interactions of chained
    structures in the style guide, and fix one case now appearing in
    slink:VkBufferCreateInfo instead of the child
    slink:VkDedicatedAllocationBufferCreateInfoNV structure (internal issue
    715).
  * Add example to the style guide of describing enumerated types which are
    empty when the spec is built without relevant extensions enabled, and
    apply it to existing examples for
    elink:VkDescriptorSetLayoutCreateFlagBits and
    elink:VkSubpassDescriptionFlagBits (internal issue 864).
  * Add a note to the <<fundamentals-validusage-enums, Valid Usage for
    Enumerated Types>> section that the special values suffixed with
    etext:_BEGIN_RANGE, etext:_END_RANGE, etext:_RANGE_SIZE and
    etext:_MAX_ENUM are not part of the API and should: not be used by
    applications (internal issue 872).
  * Added note to flink:vkCmdUpdateBuffers explaining the performance
    penalty for copies done in this way, and why the upper copy limit is
    what it is (internal issue 952).
  * Update `VK_KHX_device_group` to split some functionality into the new
    `VK_KHR_bind_memory2` extension, and rename that functionality (internal
    issue 969).
  * Remove *Status* fields from extension appendices, since they are by
    definition published and complete by the time they reach the public
    github repository (internal issue 973).

Other Issues:

  * Update Data Format specification dependency to version 1.2 and change
    references to DF sections accordingly.
  * Update XML to make the pname:pAllocator parameter of
    flink:vkRegisterDeviceEventEXT and flink:vkRegisterDisplayEventEXT in
    the `VK_EXT_display_control` extension as optional.

New Extensions:

  * `VK_KHR_bind_memory2`
  * `VK_KHR_image_format_list`
  * `VK_KHR_maintenance2`
  * `VK_KHR_sampler_ycbcr_conversion`
2017-09-14 22:41:33 -07:00

109 lines
3.7 KiB
Plaintext

// Copyright (c) 2016-2017 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
include::meta/VK_KHX_device_group.txt[]
*Last Modified Date*::
2017-05-19
*IP Status*::
No known IP claims.
*Contributors*::
- Jeff Bolz, NVIDIA
- Tobias Hector, Imagination Technologies
This extension provides functionality to use a logical device that consists
of multiple physical devices, as created with the
+VK_KHX_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.
=== New Object Types
None.
=== New Enum Constants
* Extending elink:VkStructureType:
** ename:VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHX
** ename:VK_STRUCTURE_TYPE_IMAGE_SWAPCHAIN_CREATE_INFO_KHX
** ename:VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_SWAPCHAIN_INFO_KHX
** ename:VK_STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHX
** ename:VK_STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHX
** ename:VK_STRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO_KHX
** ename:VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHX
* Extending elink:VkImageCreateFlagBits
** ename:VK_IMAGE_CREATE_BIND_SFR_BIT_KHX
* Extending elink:VkPipelineCreateFlagBits
** ename:VK_PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT_KHX
** ename:VK_PIPELINE_CREATE_DISPATCH_BASE_KHX
* Extending elink:VkDependencyFlagBits
** ename:VK_DEPENDENCY_DEVICE_GROUP_BIT_KHX
* Extending elink:VkSwapchainCreateFlagBitsKHR
** ename:VK_SWAPCHAIN_CREATE_BIND_SFR_BIT_KHX
=== New Enums
* slink:VkPeerMemoryFeatureFlagBitsKHX
* slink:VkMemoryAllocateFlagBitsKHX
* slink:VkDeviceGroupPresentModeFlagBitsKHX
=== New Structures
* slink:VkMemoryAllocateFlagsInfoKHX
* slink:VkDeviceGroupRenderPassBeginInfoKHX
* slink:VkDeviceGroupCommandBufferBeginInfoKHX
* slink:VkDeviceGroupSubmitInfoKHX
* slink:VkDeviceGroupBindSparseInfoKHX
* slink:VkDeviceGroupPresentCapabilitiesKHX
* slink:VkImageSwapchainCreateInfoKHX
* slink:VkBindImageMemorySwapchainInfoKHX
* slink:VkAcquireNextImageInfoKHX
* slink:VkDeviceGroupPresentInfoKHX
* slink:VkDeviceGroupSwapchainCreateInfoKHX
* slink:VkBindBufferMemoryDeviceGroupInfoKHX
* slink:VkBindImageMemoryDeviceGroupInfoKHX
=== New Functions
* flink:vkGetDeviceGroupPeerMemoryFeaturesKHX
* flink:vkCmdSetDeviceMaskKHX
* flink:vkGetDeviceGroupPresentCapabilitiesKHX
* flink:vkGetDeviceGroupSurfacePresentModesKHX
* flink:vkAcquireNextImage2KHX
* flink:vkCmdDispatchBaseKHX
* flink:vkGetPhysicalDevicePresentRectanglesKHX
=== New Built-In Variables
* <<interfaces-builtin-variables-deviceindex,code:DeviceIndex>>
=== New SPIR-V Capabilities
* <<spirvenv-capabilities-table-devicegroup,code:DeviceGroup>>
=== Issues
None.
=== Examples
TODO
=== Version History
* Revision 2, 2017-05-19 (Tobias Hector)
- Removed extended memory bind functions to VK_KHR_bind_memory2, added
dependency on that extension, and device-group-specific structs for
those functions.
* Revision 1, 2016-10-19 (Jeff Bolz)
- Internal revisions