mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 20:45:12 +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>>`
71 lines
2.7 KiB
Plaintext
71 lines
2.7 KiB
Plaintext
[[copies-buffer-markers]]
|
|
== Buffer Markers
|
|
|
|
[open,refpage='vkCmdWriteBufferMarkerAMD',desc='Execute a pipelined write of a marker value into a buffer',type='protos']
|
|
--
|
|
|
|
To write a 32-bit marker value into a buffer as a pipelined operation, call:
|
|
|
|
include::{generated}/api/protos/vkCmdWriteBufferMarkerAMD.txt[]
|
|
|
|
* pname:commandBuffer is the command buffer into which the command will be
|
|
recorded.
|
|
* pname:pipelineStage is one of the elink:VkPipelineStageFlagBits values,
|
|
specifying the pipeline stage whose completion triggers the marker
|
|
write.
|
|
* pname:dstBuffer is the buffer where the marker will be written to.
|
|
* pname:dstOffset is the byte offset into the buffer where the marker will
|
|
be written to.
|
|
* pname:marker is the 32-bit value of the marker.
|
|
|
|
The command will write the 32-bit marker value into the buffer only after
|
|
all preceding commands have finished executing up to at least the specified
|
|
pipeline stage.
|
|
This includes the completion of other preceding
|
|
fname:vkCmdWriteBufferMarkerAMD commands so long as their specified pipeline
|
|
stages occur either at the same time or earlier than this command's
|
|
specified pname:pipelineStage.
|
|
|
|
While consecutive buffer marker writes with the same pname:pipelineStage
|
|
parameter are implicitly complete in submission order, memory and execution
|
|
dependencies between buffer marker writes and other operations must still be
|
|
explicitly ordered using synchronization commands.
|
|
The access scope for buffer marker writes falls under the
|
|
ename:VK_ACCESS_TRANSFER_WRITE_BIT, and the pipeline stages for identifying
|
|
the synchronization scope must: include both pname:pipelineStage and
|
|
ename:VK_PIPELINE_STAGE_TRANSFER_BIT.
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
Similar to fname:vkCmdWriteTimestamp, if an implementation is unable to
|
|
write a marker at any specific pipeline stage, it may: instead do so at any
|
|
logically later stage.
|
|
====
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
Implementations may: only support a limited number of pipelined marker write
|
|
operations in flight at a given time, thus excessive number of marker write
|
|
operations may: degrade command execution performance.
|
|
====
|
|
|
|
.Valid Usage
|
|
****
|
|
* [[VUID-vkCmdWriteBufferMarkerAMD-dstOffset-01798]]
|
|
pname:dstOffset must: be less than or equal to the size of
|
|
pname:dstBuffer minus `4`.
|
|
* [[VUID-vkCmdWriteBufferMarkerAMD-dstBuffer-01799]]
|
|
pname:dstBuffer must: have been created with
|
|
ename:VK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag
|
|
* [[VUID-vkCmdWriteBufferMarkerAMD-dstBuffer-01800]]
|
|
If pname:dstBuffer is non-sparse then it must: be bound completely and
|
|
contiguously to a single sname:VkDeviceMemory object
|
|
* [[VUID-vkCmdWriteBufferMarkerAMD-dstOffset-01801]]
|
|
pname:dstOffset must: be a multiple of `4`
|
|
****
|
|
|
|
include::{generated}/validity/protos/vkCmdWriteBufferMarkerAMD.txt[]
|
|
--
|