RFC: const-ref based inline helper functions

appendices/boilerplate.adoc

@@ -312,6 +312,32 @@ endif::VKSC_VERSION_1_0[]
 
 ==== Vulkan Helper Macros
 
+[open,refpage='VK_CPP11_FEATURES',desc='Define set to 1 if C++11 features are available',type='defines']
+--
+dname:VK_CPP11_FEATURES defines an object-like macro that indicates whether C++11
+features are enabled and can be used by the application.
+
+include::{generated}/api/defines/VK_CPP11_FEATURES.adoc[]
+
+By default the dname:VK_CPP11_FEATURES macro is '1' if the module is
+compiled with a '__cplusplus' value of '201103L' or larger, or '0' otherwise.
+C++11 features can be disabled by the application by defining the VK_CPP11_FEATURES macro
+to '0'.
+--
+
+[open,refpage='VK_CPP20_FEATURES',desc='Define set to 1 if C++11 features are available',type='defines']
+--
+dname:VK_CPP20_FEATURES defines an object-like macro that indicates whether C++11
+features are enabled and can be used by the application.
+
+include::{generated}/api/defines/VK_CPP20_FEATURES.adoc[]
+
+By default the dname:VK_CPP20_FEATURES macro is '1' if the module is
+compiled with a '__cplusplus' value of '202002L' or larger, or '0' otherwise.
+C++11 features can be disabled by the application by defining the VK_CPP20_FEATURES macro
+to '0'.
+--
+
 [open,refpage='VK_CPP11_DEFAULT',desc='Function macro to allow optional C++11 default member initializers',type='defines']
 --
 dname:VK_CPP11_DEFAULT defines a function macro to allow optional structure default

build_tests/expectations/all-1.0.html

@@ -163,7 +163,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_KHR_copy_commands2</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">
@@ -673,7 +680,14 @@ <h2 id="hic"><a class="anchor" href="#hic"></a>3. Host Image Copy</h2>
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_EXT_host_image_copy</span>
 <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span>
     <span class="n">VkDevice</span>                                    <span class="n">device</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">VkDevice</span> <span class="n">device</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">&amp;</span> <span class="n">pCopyMemoryToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">

build_tests/expectations/all.html

@@ -163,7 +163,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_VERSION_1_3</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div id="vkCmdCopyBufferToImage2KHR" class="listingblock">
@@ -172,7 +179,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <span class="c1">// Equivalent to vkCmdCopyBufferToImage2</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">
@@ -706,7 +720,14 @@ <h2 id="hic"><a class="anchor" href="#hic"></a>3. Host Image Copy</h2>
 <span class="c1">// Equivalent to vkCopyMemoryToImage</span>
 <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span>
     <span class="n">VkDevice</span>                                    <span class="n">device</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">VkDevice</span> <span class="n">device</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">&amp;</span> <span class="n">pCopyMemoryToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">

build_tests/expectations/copy2-1.0.html

@@ -161,7 +161,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_KHR_copy_commands2</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">

build_tests/expectations/core.html

@@ -161,7 +161,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_VERSION_1_3</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">

build_tests/expectations/hic-1.0.html

@@ -163,7 +163,14 @@ <h3 id="lorem-subchapter"><a class="anchor" href="#lorem-subchapter"></a>2.1. Lo
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_KHR_copy_commands2</span>
 <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span>
     <span class="n">VkCommandBuffer</span>                             <span class="n">commandBuffer</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">*</span>             <span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="kt">void</span> <span class="nf">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">VkCommandBuffer</span> <span class="n">commandBuffer</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyBufferToImageInfo2</span><span class="o">&amp;</span> <span class="n">pCopyBufferToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCmdCopyBufferToImage2KHR</span><span class="p">(</span><span class="n">commandBuffer</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyBufferToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">
@@ -631,7 +638,14 @@ <h2 id="hic"><a class="anchor" href="#hic"></a>3. Host Image Copy</h2>
 <pre class="rouge highlight"><code data-lang="c++"><span class="c1">// Provided by VK_EXT_host_image_copy</span>
 <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span>
     <span class="n">VkDevice</span>                                    <span class="n">device</span><span class="p">,</span>
-    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span></code></pre>
+    <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">*</span>              <span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+
+<span class="cp">#if VK_CPP20_FEATURES
+</span><span class="k">extern</span> <span class="s">"C++"</span> <span class="kr">inline</span> <span class="n">VkResult</span> <span class="nf">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">VkDevice</span> <span class="n">device</span><span class="p">,</span> <span class="k">const</span> <span class="n">VkCopyMemoryToImageInfo</span><span class="o">&amp;</span> <span class="n">pCopyMemoryToImageInfo</span><span class="p">)</span>
+<span class="p">{</span>
+    <span class="k">return</span> <span class="n">vkCopyMemoryToImageEXT</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">pCopyMemoryToImageInfo</span><span class="p">);</span>
+<span class="p">}</span>
+<span class="cp">#endif</span></code></pre>
 </div>
 </div>
 <div class="ulist">