mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-26 14:20:33 +00:00
1ca0ea1ef0
* Bump API patch number and header version number to 22 for this update. Github Issues: * Translate the subpass self-dependency language into concrete validity statements, and added a validity statement about the restrictions on layout parameters (public issue 267). * Add validity requirement that slink:VkAttachmentDescription::pname:finalLayout and slink:VkAttachmentReference::pname:layout must not be ename:VK_IMAGE_LAYOUT_UNDEFINED or ename:VK_IMAGE_LAYOUT_PREINITIALIZED (public issue 268). * Clarify that slink:VkSubpassDescription::pname:pResolveAttachments layouts are used. Make language consistent with other attachment arrays (public issue 270). * Changed 64-bit definition for dname:VK_DEFINE_NON_DISPATCHABLE_HANDLE to work for x32 platform in +vk.xml+ and the resulting +vulkan.h+ (public issue 282). * Add missing error return code for flink:vkEnumerateInstanceExtensionProperties and flink:vkEnumerateDeviceExtensionProperties (public issue 285) * Fix several cases of stext::VkStructName.memberName markup to stext::VkStructName::pname:memberName, to match other usage in the spec, and describe this markup in the style guide (public issue 286). * Modified validity language generation script to avoid redundant common ancestor language if covered by generic parent language, and used `Both' instead of `Each' when appropriate (public issue 288). Internal Issues: * Add language about behavior of flink:vkAllocateDescriptorSets when allocation fails due to fragmentation, a new error ename:VK_ERROR_FRAGMENTED_POOL, and a Note explaining the situation (internal issue 309). * For the features of code:PointSize, code:ClipDistance, and code:CullDistance, the SPIR-V capability is required to be declared on use (read or write) rather than on decoration (internal issue 359). * Have desktop versions of GLSL respect precision qualification (code:mediump and code:lowp) when compiling for Vulkan. These will get translated to SPIR-V's code:RelaxedPrecision decoration as they do with OpenGL ES versions of GLSL (ESSL). The default precision of all types is code:highp when using a desktop version (internal issue 360). * Add validity statement for slink:VkImageCreateInfo specifying that multisampled images must be two-dimensional, optimally tiled, and with a single mipmap level (internal issue 369). * Add validity statements to slink:VkImageViewCreateInfo disallowing creation of images or image views with no supported features. Made some slink:VkImageViewCreateInfo validity statements more precise and consistent. Added a Note to the <<features,features>> chapter about formats with no features (internal issue 371). * Remove +manpages+ from default build targets. Nroff outputs containing imbedded latexmath will not render properly. Fixing this is a lot of work for limited use cases (internal issue 401). Other Commits: * Fix flink:vkRenderPassBeginInfo::pname:clearValueCount validity statement to be based on attachment indices rather than the number of cleared attachments (Vulkan-LoaderAndValidationLayers/issues/601). * Convert registry documentation from LaTeX to asciidoc source and rename from +src/spec/readme.tex+ to +src/spec/registry.txt+. * Fix lack of Oxford commas in validity language. * Lots of cleanup of generator scripts and Makefiles to move extension list for generator into the script arguments instead of the body of genvk.py, and express better dependencies between XML, scripts, and generated files.
106 lines
3.9 KiB
Plaintext
106 lines
3.9 KiB
Plaintext
// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
VkSharingMode(3)
|
|
================
|
|
|
|
Name
|
|
----
|
|
VkSharingMode - Buffer and image sharing modes
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin VkSharingMode - Buffer and image sharing modes
|
|
|
|
Buffer and image objects are created with a _sharing mode_ controlling how
|
|
they can: be accessed from queues. The supported sharing modes are:
|
|
|
|
include::../api/enums/VkSharingMode.txt[]
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
* ename:VK_SHARING_MODE_EXCLUSIVE specifies that access to any range or
|
|
image subresource of the object will be exclusive to a single queue
|
|
family at a time.
|
|
* ename:VK_SHARING_MODE_CONCURRENT specifies that concurrent access to any
|
|
range or image subresource of the object from multiple queue families is
|
|
supported.
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
ename:VK_SHARING_MODE_CONCURRENT may: result in lower performance access to
|
|
the buffer or image than ename:VK_SHARING_MODE_EXCLUSIVE.
|
|
====
|
|
|
|
Ranges of buffers and image subresources of image objects created using
|
|
ename:VK_SHARING_MODE_EXCLUSIVE must: only be accessed by queues in the same
|
|
queue family at any given time. In order for a different queue family to be
|
|
able to interpret the memory contents of a range or image subresource, the
|
|
application must: transfer exclusive ownership of the range or image
|
|
subresource between the source and destination queue families with the
|
|
following sequence of operations:
|
|
|
|
1. Release exclusive ownership from the source queue family to the
|
|
destination queue family.
|
|
2. Use semaphores to ensure proper execution control for the ownership
|
|
transfer.
|
|
3. Acquire exclusive ownership for the destination queue family from the
|
|
source queue family.
|
|
|
|
To release exclusive ownership of a range of a buffer or image subresource
|
|
of an image object, the application must: execute a buffer or image memory
|
|
barrier, respectively (see slink:VkBufferMemoryBarrier and
|
|
slink:VkImageMemoryBarrier) on a queue from the source queue family. The
|
|
pname:srcQueueFamilyIndex parameter of the barrier must: be set to the
|
|
source queue family index, and the pname:dstQueueFamilyIndex parameter to
|
|
the destination queue family index.
|
|
|
|
To acquire exclusive ownership, the application must: execute the same
|
|
buffer or image memory barrier on a queue from the destination queue family.
|
|
|
|
Upon creation, resources using ename:VK_SHARING_MODE_EXCLUSIVE are not owned
|
|
by any queue family. A buffer or image memory barrier is not required to
|
|
acquire ownership when no queue family owns the resource - it is implicitly
|
|
acquired upon first use within a queue. However, images still require a
|
|
<<resources-image-layouts,layout transition>> from
|
|
ename:VK_IMAGE_LAYOUT_UNDEFINED or ename:VK_IMAGE_LAYOUT_PREINITIALIZED
|
|
before being used on the first queue. This layout transition can: either be
|
|
accomplished by an image memory barrier or by use in a render pass instance.
|
|
|
|
Once a queue family has used a range or image subresource of an
|
|
ename:VK_SHARING_MODE_EXCLUSIVE resource, its contents are undefined to
|
|
other queue families unless ownership is transferred. The contents may: also
|
|
become undefined for other reasons, e.g. as a result of writes to an image
|
|
subresource that aliases the same memory. A queue family can: take ownership
|
|
of a range or image subresource without an ownership transfer in the same
|
|
way as for a resource that was just created, however doing so means any
|
|
contents written by other queue families or via incompatible aliases are
|
|
undefined.
|
|
|
|
// refEnd VkSharingMode
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
slink:VkBufferCreateInfo, slink:VkImageCreateInfo
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkSharingMode
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|