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>>`
107 lines
3.8 KiB
Plaintext
107 lines
3.8 KiB
Plaintext
=== Alternate Methods to Signal Fences
|
|
|
|
Besides submitting a fence to a queue as part of a
|
|
<<devsandqueues-submission, queue submission>> command, a fence may: also be
|
|
signaled when a particular event occurs on a device or display.
|
|
|
|
[open,refpage='vkRegisterDeviceEventEXT',desc='Signal a fence when a device event occurs',type='protos']
|
|
--
|
|
|
|
To create a fence that will be signaled when an event occurs on a device,
|
|
call:
|
|
|
|
include::{generated}/api/protos/vkRegisterDeviceEventEXT.txt[]
|
|
|
|
* pname:device is a logical device on which the event may: occur.
|
|
* pname:pDeviceEventInfo is a pointer to an instance of the
|
|
slink:VkDeviceEventInfoEXT structure describing the event of interest to
|
|
the application.
|
|
* pname:pAllocator controls host memory allocation as described in the
|
|
<<memory-allocation, Memory Allocation>> chapter.
|
|
* pname:pFence points to a handle in which the resulting fence object is
|
|
returned.
|
|
|
|
include::{generated}/validity/protos/vkRegisterDeviceEventEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='VkDeviceEventInfoEXT',desc='Describe a device event to create',type='structs']
|
|
--
|
|
|
|
The sname:VkDeviceEventInfoEXT structure is defined as:
|
|
|
|
include::{generated}/api/structs/VkDeviceEventInfoEXT.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:device is a elink:VkDeviceEventTypeEXT value specifying when the
|
|
fence will be signaled.
|
|
|
|
include::{generated}/validity/structs/VkDeviceEventInfoEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='VkDeviceEventTypeEXT',desc='Events that can occur on a device object',type='enums']
|
|
--
|
|
|
|
Possible values of slink:VkDeviceEventInfoEXT::pname:device, specifying when
|
|
a fence will be signaled, are:
|
|
|
|
include::{generated}/api/enums/VkDeviceEventTypeEXT.txt[]
|
|
|
|
* ename:VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT specifies that the fence
|
|
is signaled when a display is plugged into or unplugged from the
|
|
specified device.
|
|
Applications can: use this notification to determine when they need to
|
|
re-enumerate the available displays on a device.
|
|
|
|
--
|
|
|
|
[open,refpage='vkRegisterDisplayEventEXT',desc='Signal a fence when a display event occurs',type='protos']
|
|
--
|
|
|
|
To create a fence that will be signaled when an event occurs on a
|
|
slink:VkDisplayKHR object, call:
|
|
|
|
include::{generated}/api/protos/vkRegisterDisplayEventEXT.txt[]
|
|
|
|
* pname:device is a logical device associated with pname:display
|
|
* pname:display is the display on which the event may: occur.
|
|
* pname:pDisplayEventInfo is a pointer to an instance of the
|
|
slink:VkDisplayEventInfoEXT structure describing the event of interest
|
|
to the application.
|
|
* pname:pAllocator controls host memory allocation as described in the
|
|
<<memory-allocation, Memory Allocation>> chapter.
|
|
* pname:pFence points to a handle in which the resulting fence object is
|
|
returned.
|
|
|
|
include::{generated}/validity/protos/vkRegisterDisplayEventEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='VkDisplayEventInfoEXT',desc='Describe a display event to create',type='structs']
|
|
--
|
|
|
|
The sname:VkDisplayEventInfoEXT structure is defined as:
|
|
|
|
include::{generated}/api/structs/VkDisplayEventInfoEXT.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:displayEvent is a elink:VkDisplayEventTypeEXT specifying when the
|
|
fence will be signaled.
|
|
|
|
include::{generated}/validity/structs/VkDisplayEventInfoEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='VkDisplayEventTypeEXT',desc='Events that can occur on a display object',type='enums']
|
|
--
|
|
|
|
Possible values of slink:VkDisplayEventInfoEXT::pname:displayEvent,
|
|
specifying when a fence will be signaled, are:
|
|
|
|
include::{generated}/api/enums/VkDisplayEventTypeEXT.txt[]
|
|
|
|
* ename:VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT specifies that the fence
|
|
is signaled when the first pixel of the next display refresh cycle
|
|
leaves the display engine for the display.
|
|
|
|
--
|