mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-19 02:41:51 +00:00
5abf83f95d
* Update release number to 107.
Public Issues:
* Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix
(public issue 617).
* Make <<synchronization-pipeline-barriers-subpass-self-dependencies,
subpass self-dependencies>> less restrictive (public issue 777).
* Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on
`<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849).
* Remove single-page (`apispec.html`) refpage sub-targets from the
Makefile `allman` target and the build instructions. The target is still
present in the Makefile, but we have not been actively maintaining the
single-page document and do not promise it will work. The full
Specification and the individual API reference pages are what we support
and publish at present (public issue 949).
Internal Issues:
* De-duplicate common valid usage statements shared by multiple commands
or structures by using asciidoctor includes and dynamically assigning
part of the valid usage ID based on which command or structure they're
being applied to (internal issue 779).
* Add reference pages for constructs not part of the formal API, such as
platform calling convention macros, and script changes supporting them
This required suppressing some check_spec_links warning classes in order
to pass CI, until a more sophisticated fix can be done (internal issue
888).
* Change math notation for the elink:VkPrimitiveTopology descriptions to
use short forms `v` and `p` instead of `vertex` and `primitive`,
increasing legibility (internal issue 1611).
* Rewrite generated file includes relative to a globally specified path,
fixing some issues with refpage generation (internal issue 1630).
* Update contributor list for `<<VK_EXT_calibrated_timestamps>>`.
* Fix use of pathlin in `scripts/generator.py` so the script will work on
Windows under Python 3.5 (internal merge request 3107).
* Add missing conditionals around the
<<descriptorsets-accelerationstructure, Acceleration Structure>>
section (internal merge request 3108).
* More script synchronization with OpenXR spec repository (internal merge
request 3109).
* Mark the `<<VK_AMD_gpu_shader_half_float>>` and
`<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and
the corresponding extension appendices (internal merge request 3112).
New Extensions:
* `<<VK_EXT_headless_surface>>`
90 lines
3.6 KiB
Plaintext
90 lines
3.6 KiB
Plaintext
// Copyright (c) 2014-2019 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::{generated}/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::{generated}/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::{generated}/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::{generated}/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.
|