mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 20:45:12 +00:00
194a7f4d0d
* Update release number to 122.
Internal Issues:
* Add style guide language on not using standalone `+` signs (internal
issue 736); not using leading whitespace for markup (internal issue
747); and on keeping descriptions of a single API in a contiguous block
of markup (internal issue 949), and apply them to the specification.
* Add a glossary definition of "`constant integral expression`", pointing
to the SPIR-V "`constant instruction`" definition (internal issue 1225).
* Many minor edits to improve writing style consistency and capture
additional style guidelines (internal issue 1553).
* Clarify that <<fragops-depth-write, depth writes are not performed>> if
there is no depth framebuffer attachment (internal issue 1771).
* Allow implementations to use rectangular line style of interpolation for
<<primsrast-lines-bresenham, wide Bresenham lines>>, though replicating
attributes is still preferred. Clarify that code:FragCoord is not
replicated (internal issue 1772).
* Resolve a contradiction in valid usage statements for
slink:VkImageCreateInfo and slink:VkImageStencilUsageCreateInfoEXT
(internal issue 1773).
* Add style guide discussion of markup for indented equations, and use
markup workaround for asciidoctor 2 compatibility (internal issue 1793).
* Deprecate the `<<VK_EXT_validation_flags>>` extension in `vk.xml` and
the extension appendix (internal issue 1801).
* Add a new checker script `scripts/xml_consistency.py`. This is not
currently run as part of internal CI (internal merge request 3285).
* Correct "`an`" -> "`a`" prepositions where needed (internal merge
request 3334).
* Clarify that the <<features-uniformBufferStandardLayout,
pname:uniformBufferStandardLayout>> feature is only required when the
extension defining it is supported (internal merge request 3341).
* Bring scripts into closer sync with OpenXR, mainly through conversion of
comments to docstrings where appropriate, and add gen-scripts-docs.sh
(internal merge request 3324).
* Correct pname:maxDrawMeshTasksCount to 2^16^-1 in the <<limits-required,
Required Limits>> table (internal merge requests 3361).
New Extensions
* `<<VK_IMG_format_pvrtc>>` (public issue 512).
105 lines
3.8 KiB
Plaintext
105 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 a 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 is a pointer 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 a 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 is a pointer 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.
|
|
|
|
--
|