ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Vk: doc++

pull/494/head
Vladimír Vondruš 5 years ago
parent
da85f98c91
commit
ef107e4dad
3 changed files with 8 additions and 8 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      doc/vulkan-mapping.dox
  2. 4
      src/Magnum/Vk/CommandBuffer.h
  3. 10
      src/Magnum/Vk/RenderPassCreateInfo.h

2
doc/vulkan-mapping.dox
Unescape View File

@ -110,7 +110,7 @@ Vulkan function | Matching API
Vulkan function | Matching API Vulkan function | Matching API
--------------------------------------- | ------------ --------------------------------------- | ------------
@fn_vk{CmdBeginQuery}, \n @fn_vk{CmdEndQuery} | | @fn_vk{CmdBeginQuery}, \n @fn_vk{CmdEndQuery} | |
@fn_vk{CmdBeginDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{CmdEndebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | | @fn_vk{CmdBeginDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{CmdEndDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CmdBeginRenderPass}, \n @fn_vk{CmdBeginRenderPass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{CmdNextSubpass}, \n @fn_vk{CmdNextSubpass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{CmdEndRenderpass}, \n @fn_vk{CmdEndRenderpass2} @m_class{m-label m-flat m-success} **KHR, 1.2** | @ref CommandBuffer::beginRenderPass(), \n @ref CommandBuffer::nextSubpass(), \n @ref CommandBuffer::endRenderPass() @fn_vk{CmdBeginRenderPass}, \n @fn_vk{CmdBeginRenderPass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{CmdNextSubpass}, \n @fn_vk{CmdNextSubpass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{CmdEndRenderpass}, \n @fn_vk{CmdEndRenderpass2} @m_class{m-label m-flat m-success} **KHR, 1.2** | @ref CommandBuffer::beginRenderPass(), \n @ref CommandBuffer::nextSubpass(), \n @ref CommandBuffer::endRenderPass()
@fn_vk{CmdBindDescriptorSets} | | @fn_vk{CmdBindDescriptorSets} | |
@fn_vk{CmdBindIndexBuffer} | | @fn_vk{CmdBindIndexBuffer} | |

4
src/Magnum/Vk/CommandBuffer.h
Unescape View File

@ -349,9 +349,9 @@ class MAGNUM_VK_EXPORT CommandBuffer {
* @fn_vk_keyword{CmdEndRenderPass} * @fn_vk_keyword{CmdEndRenderPass}
*/ */
#ifdef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT
CommandBuffer& endRenderPass(const SubpassEndInfo& info = SubpassEndInfo{}); CommandBuffer& endRenderPass(const SubpassEndInfo& endInfo = SubpassEndInfo{});
#else #else
CommandBuffer& endRenderPass(const SubpassEndInfo& info); CommandBuffer& endRenderPass(const SubpassEndInfo& endInfo);
CommandBuffer& endRenderPass(); CommandBuffer& endRenderPass();
#endif #endif

10
src/Magnum/Vk/RenderPassCreateInfo.h
Unescape View File

@ -125,7 +125,7 @@ information.
While the class operates on the @type_vk{AttachmentDescription2} structure While the class operates on the @type_vk{AttachmentDescription2} structure
that's new in Vulkan 1.2 or is provided by the that's new in Vulkan 1.2 or is provided by the
@vk_extension{KHR,create_renderpass2} extenstion, conversion from and to @vk_extension{KHR,create_renderpass2} extension, conversion from and to
@type_vk{AttachmentDescription} is provided to some extent --- you can create @type_vk{AttachmentDescription} is provided to some extent --- you can create
an @ref AttachmentDescription from it, call various methods on the instance and an @ref AttachmentDescription from it, call various methods on the instance and
then get a @type_vk{AttachmentDescription} back again using then get a @type_vk{AttachmentDescription} back again using
@ -333,7 +333,7 @@ inside a @ref SubpassDescription, which is subsequently passed to a
While the class operates on the @type_vk{AttachmentReference2} structure that's While the class operates on the @type_vk{AttachmentReference2} structure that's
new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2} new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2}
extenstion, conversion from and to @type_vk{AttachmentReference} is provided to extension, conversion from and to @type_vk{AttachmentReference} is provided to
some extent --- you can create an @ref AttachmentReference from it, call some extent --- you can create an @ref AttachmentReference from it, call
various methods on the instance and then get a @type_vk{AttachmentReference} various methods on the instance and then get a @type_vk{AttachmentReference}
back again using @ref vkAttachmentReference(). back again using @ref vkAttachmentReference().
@ -458,7 +458,7 @@ information.
While the class operates on the @type_vk{SubpassDescription2} structure that's While the class operates on the @type_vk{SubpassDescription2} structure that's
new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2} new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2}
extenstion, conversion from and to @type_vk{SubpassDescription} is provided to extension, conversion from and to @type_vk{SubpassDescription} is provided to
some extent --- you can create a @ref SubpassDescription from it, call various some extent --- you can create a @ref SubpassDescription from it, call various
methods on the instance and then get a @type_vk{SubpassDescription} back again methods on the instance and then get a @type_vk{SubpassDescription} back again
using @ref vkSubpassDescription(). Note that, because of the nested data using @ref vkSubpassDescription(). Note that, because of the nested data
@ -699,7 +699,7 @@ information.
While the class operates on the @type_vk{SubpassDependency2} structure that's While the class operates on the @type_vk{SubpassDependency2} structure that's
new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2} new in Vulkan 1.2 or is provided by the @vk_extension{KHR,create_renderpass2}
extenstion, conversion from and to @type_vk{SubpassDependency} is provided to extension, conversion from and to @type_vk{SubpassDependency} is provided to
some extent --- you can create a @ref SubpassDependency from it, call various some extent --- you can create a @ref SubpassDependency from it, call various
methods on the instance and then get a @type_vk{SubpassDependency} back again methods on the instance and then get a @type_vk{SubpassDependency} back again
using @ref vkSubpassDependency(). using @ref vkSubpassDependency().
@ -835,7 +835,7 @@ Wraps a @type_vk_keyword{RenderPassCreateInfo2}. See
While the class operates on the @type_vk{RenderPassCreateInfo2} structure While the class operates on the @type_vk{RenderPassCreateInfo2} structure
that's new in Vulkan 1.2 or is provided by the that's new in Vulkan 1.2 or is provided by the
@vk_extension{KHR,create_renderpass2} extenstion, conversion from and to @vk_extension{KHR,create_renderpass2} extension, conversion from and to
@type_vk{RenderPassCreateInfo} is provided to some extent ---- you can create a @type_vk{RenderPassCreateInfo} is provided to some extent ---- you can create a
@ref RenderPassCreateInfo from it, call various methods on the instance and @ref RenderPassCreateInfo from it, call various methods on the instance and
then get a @type_vk{RenderPassCreateInfo} back again using then get a @type_vk{RenderPassCreateInfo} back again using

Write Preview
Loading…
Cancel
Save