status-im
/
Vulkan-Docs
mirror of https://github.com/status-im/Vulkan-Docs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge misc. tweaks from private repository.

This commit is contained in:
Jon Leech 2016-04-21 01:12:51 -07:00
parent 36241c4254
commit 947853ef4b
6 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/specs/vulkan/chapters/VK_KHR_wayland_surface/platformCreateSurface_wayland.txt
View File

@ -8,7 +8,7 @@ include::../../protos/vkCreateWaylandSurfaceKHR.txt[]
* pname:instance is the instance to associate the surface with.
* pname:pCreateInfo is a pointer to an instance of the
sname:VkWaylandSurfaceCreateInfoKHR structure containing parameters
slink:VkWaylandSurfaceCreateInfoKHR structure containing parameters
affecting the creation of the surface object.
* pname:pAllocator is the allocator used for host memory allocated for the
surface object when there is no more specific allocator available (see
@ -18,37 +18,34 @@ include::../../protos/vkCreateWaylandSurfaceKHR.txt[]
include::../../validity/protos/vkCreateWaylandSurfaceKHR.txt[]
The definition of sname:VkWaylandSurfaceCreateInfoKHR is:
The sname:VkWaylandSurfaceCreateInfoKHR structure is defined as:
include::../../structs/VkWaylandSurfaceCreateInfoKHR.txt[]
The members of sname:VkWaylandSurfaceCreateInfoKHR have the following
meanings:
* pname:sType is the type of this structure and must: be
ename:VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:flags is reserved for future use.
* pname:display and pname:surface are pointers to the Wayland wl_display and
wl_surface to associate the surface with.
* pname:display and pname:surface are pointers to the Wayland
code:wl_display and code:wl_surface to associate the surface with.
include::../../validity/structs/VkWaylandSurfaceCreateInfoKHR.txt[]
On Wayland, pname:currentExtent is undefined latexmath:[$(0, 0)$]. Whatever
On Wayland, pname:currentExtent is undefined latexmath:[$(0,0)$]. Whatever
the application sets a swapchain's pname:imageExtent to will be the size of
the window, after the first image is presented. pname:minImageExtent is
latexmath:[$(1, 1)$], and pname:maxImageExtent is the maximum supported
the window, after the first image is presented. pname:minImageExtent is
latexmath:[$(1,1)$], and pname:maxImageExtent is the maximum supported
surface size.
Some {apiname} functions may send protocol over the specified
Some {apiname} functions may: send protocol over the specified
code:wl_device connection when using a swapchain or presentable images
created from a slink:VkSurfaceKHR referring to a code:wl_surface.
Applications must therefore ensure that both the code:wl_device and the
Applications must: therefore ensure that both the code:wl_device and the
code:wl_surface remain valid for the lifetime of any slink:VkSwapchainKHR
objects created from a particular code:wl_device and code:wl_surface.
Also, calling flink:vkQueuePresentKHR will result in {apiname} sending
objects created from a particular code:wl_device and code:wl_surface. Also,
calling flink:vkQueuePresentKHR will result in {apiname} sending
code:wl_surface.commit requests to the underlying code:wl_surface of each
slink:VkSwapchainKHR objects referenced by pname:pPresentInfo. Therefore,
if the application wishes to synchronize any window changes with a
particular frame, such requests must be sent to the Wayland display server
prior to calling flink:vkQueuePresentKHR.
slink:VkSwapchainKHR objects referenced by pname:pPresentInfo. Therefore, if
the application wishes to synchronize any window changes with a particular
frame, such requests must: be sent to the Wayland display server prior to
calling flink:vkQueuePresentKHR.

4
doc/specs/vulkan/validity/protos/vkCmdCopyQueryPoolResults.txt
View File

@ -18,8 +18,8 @@ endif::doctype-manpage[]
* pname:dstOffset must: be less than the size of pname:dstBuffer
* pname:firstQuery must: be less than the number of queries in pname:queryPool
* The sum of pname:firstQuery and pname:queryCount must: be less than or equal to the number of queries in pname:queryPool
* If ename:VK_QUERY_RESULT_64_BIT is not set in pname:flags then pname:dstOffset and pname:stride must: be multiples of `4`
* If ename:VK_QUERY_RESULT_64_BIT is set in pname:flags then pname:dstOffset and pname:stride must: be multiples of `8`
* If ename:VK_QUERY_RESULT_64_BIT is not set in pname:flags then pname:dstOffset and pname:stride must be multiples of `4`
* If ename:VK_QUERY_RESULT_64_BIT is set in pname:flags then pname:dstOffset and pname:stride must be multiples of `8`
* pname:dstBuffer must: have enough storage, from pname:dstOffset, to contain the result of each query, as described <<queries-operation-memorylayout,here>>
* pname:dstBuffer must: have been created with ename:VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
* If the pname:queryType used to create pname:queryPool was ename:VK_QUERY_TYPE_TIMESTAMP, pname:flags mustnot: contain ename:VK_QUERY_RESULT_PARTIAL_BIT

4
doc/specs/vulkan/validity/protos/vkGetQueryPoolResults.txt
View File

@ -15,8 +15,8 @@ endif::doctype-manpage[]
* pname:queryPool must: have been created, allocated or retrieved from pname:device
* Each of pname:device and pname:queryPool must: have been created, allocated or retrieved from the same sname:VkPhysicalDevice
* pname:firstQuery must: be less than the number of queries in pname:queryPool
* If ename:VK_QUERY_RESULT_64_BIT is not set in pname:flags then pname:pData and pname:stride must: be multiples of `4`
* If ename:VK_QUERY_RESULT_64_BIT is set in pname:flags then pname:pData and pname:stride must: be multiples of `8`
* If ename:VK_QUERY_RESULT_64_BIT is not set in pname:flags then pname:pData and pname:stride must be multiples of `4`
* If ename:VK_QUERY_RESULT_64_BIT is set in pname:flags then pname:pData and pname:stride must be multiples of `8`
* The sum of pname:firstQuery and pname:queryCount must: be less than or equal to the number of queries in pname:queryPool
* pname:dataSize must: be large enough to contain the result of each query, as described <<queries-operation-memorylayout,here>>
* If the pname:queryType used to create pname:queryPool was ename:VK_QUERY_TYPE_TIMESTAMP, pname:flags mustnot: contain ename:VK_QUERY_RESULT_PARTIAL_BIT

2
doc/specs/vulkan/validity/structs/VkSpecializationInfo.txt
View File

@ -10,7 +10,7 @@ endif::doctype-manpage[]
* If pname:mapEntryCount is not `0`, pname:pMapEntries must: be a pointer to an array of pname:mapEntryCount sname:VkSpecializationMapEntry structures
* If pname:dataSize is not `0`, pname:pData must: be a pointer to an array of pname:dataSize bytes
* The pname:offset member of any given element of pname:pMapEntries must: be less than pname:dataSize
* For any given element of pname:pMapEntries, pname:size must: be less than or equal to pname:dataSize minus pname:offset
* For any given element of pname:pMapEntries, pname:size must be less than or equal to pname:dataSize minus pname:offset
ifndef::doctype-manpage[]
********************************************************************************
endif::doctype-manpage[]

2
doc/specs/vulkan/validity/structs/VkSubpassDescription.txt
View File

@ -25,7 +25,7 @@ endif::doctype-manpage[]
* If any input attachments are ename:VK_ATTACHMENT_UNUSED, then any pipelines bound during the subpass mustnot: accesss those input attachments from the fragment shader
* The pname:attachment member of any element of pname:pPreserveAttachments mustnot: be ename:VK_ATTACHMENT_UNUSED
* Any given element of pname:pPreserveAttachments mustnot: also be an element of any other member of the subpass description
* If any attachment is used as both an input attachment and a color or depth/stencil attachment, then each use must: use the same pname:layout
* If any attachment is used as both an input attachment and a color or depth/stencil attachment, then each use must use the same pname:layout
ifndef::doctype-manpage[]
********************************************************************************
endif::doctype-manpage[]

2
src/vulkan/vulkan.h
View File

@ -3427,7 +3427,7 @@ typedef VkResult (VKAPI_PTR *PFN_vkGetPhysicalDeviceDisplayPropertiesKHR)(VkPhys
typedef VkResult (VKAPI_PTR *PFN_vkGetPhysicalDeviceDisplayPlanePropertiesKHR)(VkPhysicalDevice physicalDevice, uint32_t* pPropertyCount, VkDisplayPlanePropertiesKHR* pProperties);
typedef VkResult (VKAPI_PTR *PFN_vkGetDisplayPlaneSupportedDisplaysKHR)(VkPhysicalDevice physicalDevice, uint32_t planeIndex, uint32_t* pDisplayCount, VkDisplayKHR* pDisplays);
typedef VkResult (VKAPI_PTR *PFN_vkGetDisplayModePropertiesKHR)(VkPhysicalDevice physicalDevice, VkDisplayKHR display, uint32_t* pPropertyCount, VkDisplayModePropertiesKHR* pProperties);
typedef VkResult (VKAPI_PTR *PFN_vkCreateDisplayModeKHR)(VkPhysicalDevice physicalDevice, VkDisplayKHR display, const VkDisplayModeCreateInfoKHR* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDisplayModeKHR* pMode);
typedef VkResult (VKAPI_PTR *PFN_vkCreateDisplayModeKHR)(VkPhysicalDevice physicalDevice, VkDisplayKHR display, const VkDisplayModeCreateInfoKHR*pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDisplayModeKHR* pMode);
typedef VkResult (VKAPI_PTR *PFN_vkGetDisplayPlaneCapabilitiesKHR)(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode, uint32_t planeIndex, VkDisplayPlaneCapabilitiesKHR* pCapabilities);
typedef VkResult (VKAPI_PTR *PFN_vkCreateDisplayPlaneSurfaceKHR)(VkInstance instance, const VkDisplaySurfaceCreateInfoKHR* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkSurfaceKHR* pSurface);