mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-13 06:46:33 +00:00
933a3a3c4a
* Update release number to 78.
Public Issues:
* Change markup so parameter descriptions include links to structures,
instead of just their names (public issue 697).
* Resume publishing updated Vulkan 1.0 + KHR extensions and Vulkan 1.0 +
all extensions versions of the specification (public issue 722).
* Reapply fixes from public pull request 698 for
`VK_ANDROID_external_memory_android_hardware_buffer`, which accidentally
were reverted at some point (public pull request 724).
* Fix undefined format valid usage statements for slink:VkImageCreateInfo
in the presence of the
`VK_ANDROID_external_memory_android_hardware_buffer` extension (public
pull request 725).
* Miscellaneous markup consistency fixes (public pull request 728).
Internal Issues:
* When building specifications containing vendor extensions, add terms to
the Khronos spec copyright specifying that the result is not a ratified
specification (internal issue 739).
* Change the value of the
pname:maxDescriptorSetUpdateAfterBindUniformBuffers minimum limit to 72
(6 times pname:maxPerStageDescriptorUpdateAfterBindUniformBuffers) in
the <<features-limits-required, Required Limits>> table (internal issue
1300).
Other Issues:
* Fix link to resource image view compatibility table in the valid usage
statements for slink:VkImageFormatListCreateInfoKHR (internal pull
request 2711).
90 lines
3.5 KiB
Plaintext
90 lines
3.5 KiB
Plaintext
// Copyright (c) 2014-2018 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
[[platformCreateSurface_xlib,platformCreateSurface_xlib]]
|
|
|
|
=== Xlib Platform
|
|
|
|
[open,refpage='vkCreateXlibSurfaceKHR',desc='Create a slink:VkSurfaceKHR object for an X11 window, using the Xlib client-side library',type='protos']
|
|
--
|
|
|
|
To create a sname:VkSurfaceKHR object for an X11 window, using the Xlib
|
|
client-side library, call:
|
|
|
|
include::../../api/protos/vkCreateXlibSurfaceKHR.txt[]
|
|
|
|
* pname:instance is the instance to associate the surface with.
|
|
* pname:pCreateInfo is a pointer to an instance of the
|
|
sname:VkXlibSurfaceCreateInfoKHR structure containing the 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
|
|
<<memory-allocation,Memory Allocation>>).
|
|
* pname:pSurface points to a slink:VkSurfaceKHR handle in which the
|
|
created surface object is returned.
|
|
|
|
include::../../validity/protos/vkCreateXlibSurfaceKHR.txt[]
|
|
--
|
|
|
|
[open,refpage='VkXlibSurfaceCreateInfoKHR',desc='Structure specifying parameters of a newly created Xlib surface object',type='structs']
|
|
--
|
|
|
|
The sname:VkXlibSurfaceCreateInfoKHR structure is defined as:
|
|
|
|
include::../../api/structs/VkXlibSurfaceCreateInfoKHR.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:flags is reserved for future use.
|
|
* pname:dpy is a pointer to an Xlib code:Display connection to the X
|
|
server.
|
|
* pname:window is an Xlib code:Window to associate the surface with.
|
|
|
|
.Valid Usage
|
|
****
|
|
* [[VUID-VkXlibSurfaceCreateInfoKHR-dpy-01313]]
|
|
pname:dpy must: point to a valid Xlib code:Display.
|
|
* [[VUID-VkXlibSurfaceCreateInfoKHR-window-01314]]
|
|
pname:window must: be a valid Xlib code:Window.
|
|
****
|
|
|
|
include::../../validity/structs/VkXlibSurfaceCreateInfoKHR.txt[]
|
|
--
|
|
|
|
With Xlib, pname:minImageExtent, pname:maxImageExtent, and
|
|
pname:currentExtent must: always equal the window size.
|
|
|
|
The pname:currentExtent of an Xlib surface must: have both pname:width and
|
|
pname:height greater than 0, or both of them 0.
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
Due to above restrictions, it is only possible to create a new swapchain on
|
|
this platform with pname:imageExtent being equal to the current size of the
|
|
window.
|
|
|
|
The window size may: become [eq]#(0, 0)# on this platform (e.g. when the
|
|
window is minimized), and so a swapchain cannot: be created until the size
|
|
changes.
|
|
====
|
|
|
|
Some Vulkan functions may: send protocol over the specified Xlib
|
|
code:Display connection when using a swapchain or presentable images created
|
|
from a slink:VkSurfaceKHR referring to an Xlib window.
|
|
Applications must: therefore ensure the display connection is available to
|
|
Vulkan for the duration of any functions that manipulate such swapchains or
|
|
their presentable images, and any functions that build or queue command
|
|
buffers that operate on such presentable images.
|
|
Specifically, applications using Vulkan with Xlib-based swapchains must:
|
|
|
|
* Avoid holding a server grab on a display connection while waiting for
|
|
Vulkan operations to complete using a swapchain derived from a different
|
|
display connection referring to the same X server instance.
|
|
Failing to do so may: result in deadlock.
|
|
|
|
Some implementations may require threads to implement some presentation
|
|
modes so applications must: call code:XInitThreads() before calling any
|
|
other Xlib functions.
|