diff options
| author | Erik Faye-Lund <erik.faye-lund@collabora.com> | 2022-11-08 12:05:36 +0100 |
|---|---|---|
| committer | Marge Bot <emma+marge@anholt.net> | 2022-11-09 16:10:55 +0000 |
| commit | ba78af66c6c484f6e485ea65d7463c0097716097 (patch) | |
| tree | 483b9dcdb5b0371c2ff856e321c204147149c146 /docs/vulkan | |
| parent | f69560bdcb96ea0fc0e7ec21c1e267afaace5b0c (diff) | |
| download | mesa-ba78af66c6c484f6e485ea65d7463c0097716097.tar.gz | |
docs: use ext-role for GL / VK extensions
This makes sure that we generate proper links to all of these
extensions.
Reviewed-by: Eric Engestrom <eric@igalia.com>
Reviewed-by: Adam Jackson <ajax@redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19594>
Diffstat (limited to 'docs/vulkan')
| -rw-r--r-- | docs/vulkan/dispatch.rst | 3 | ||||
| -rw-r--r-- | docs/vulkan/renderpass.rst | 21 |
2 files changed, 13 insertions, 11 deletions
diff --git a/docs/vulkan/dispatch.rst b/docs/vulkan/dispatch.rst index 3abaab5f02b..1ed093e45e3 100644 --- a/docs/vulkan/dispatch.rst +++ b/docs/vulkan/dispatch.rst @@ -257,7 +257,8 @@ the function pointer: index into the entrypoint table, not the dispatch table, because the rules for when an entrypoint should be exposed are per-entrypoint. For instance, ``vkBindImageMemory2`` is available on Vulkan 1.1 and later but - ``vkBindImageMemory2KHR`` is available if VK_KHR_bind_memory2 is enabled. + ``vkBindImageMemory2KHR`` is available if :ext:`VK_KHR_bind_memory2` is + enabled. 3. A compaction table is used to map from the entrypoint table index to the dispatch table index and the function is finally fetched from the diff --git a/docs/vulkan/renderpass.rst b/docs/vulkan/renderpass.rst index 44d250cc655..758badc5b93 100644 --- a/docs/vulkan/renderpass.rst +++ b/docs/vulkan/renderpass.rst @@ -5,13 +5,14 @@ The Vulkan runtime code in Mesa provides several helpful utilities to make managing render passes easier. -VK_KHR_create_renderpass2 -------------------------- +:ext:`VK_KHR_create_renderpass2` +-------------------------------- -It is strongly recommended that drivers implement VK_KHR_create_renderpass2 -directly and not bother implementing the old Vulkan 1.0 entrypoints. If a -driver does not implement them, the following will be implemented in common -code in terms of their VK_KHR_create_renderpass2 counterparts: +It is strongly recommended that drivers implement +:ext:`VK_KHR_create_renderpass2` directly and not bother implementing the +old Vulkan 1.0 entrypoints. If a driver does not implement them, the +following will be implemented in common code in terms of their +:ext:`VK_KHR_create_renderpass2` counterparts: - :cpp:func:`vkCreateRenderPass` - :cpp:func:`vkCmdBeginRenderPass` @@ -34,12 +35,12 @@ that driver doesn't need to do any additional compilation at of :cpp:func:`vkCreateRenderPass2` and :cpp:func:`vkDestroyRenderPass`. -VK_KHR_dynamic_rendering ------------------------- +:ext:`VK_KHR_dynamic_rendering` +------------------------------- For drivers which don't need to do subpass combining, it is recommended that they skip implementing render passes entirely and implement -VK_KHR_dynamic_rendering instead. If they choose to do so, the runtime +:ext:`VK_KHR_dynamic_rendering` instead. If they choose to do so, the runtime will provide the following, implemented in terms of :cpp:func:`vkCmdBeginRendering` and :cpp:func:`vkCmdEndRendering`: @@ -66,7 +67,7 @@ Because render passes and subpass indices are also passed into :cpp:func:`vkCmdCreateGraphicsPipelines` and :cpp:func:`vkCmdExecuteCommands` which we can't implement on the driver's behalf, we provide a couple of helpers for getting the render pass -information in terms of the relevant VK_KHR_dynamic_rendering: +information in terms of the relevant :ext:`VK_KHR_dynamic_rendering`: .. doxygenfunction:: vk_get_pipeline_rendering_create_info |