build based on 5bb3afd

dev/about/motivations/index.html

@@ -39,4 +39,4 @@
 struct InstanceCreateInfo <: VulkanStruct{true}
     vks::VkInstanceCreateInfo # API struct
     deps::Vector{Any}         # contains all required dependencies
-end</code></pre><p>and every structure exposes a convenient constructor that works perfectly with <code>String</code>s and mutable <code>AbstractArray</code>s. No manual <code>Ref</code>s/<code>cconvert</code>/<code>unsafe_convert</code> needed.</p><p>We hope that the additional <code>Vector{Any}</code> will not introduce too much overhead. In the future, this might be changed to a <code>NTuple{N, Any}</code> or a <code>StaticArrays.SVector{N, Any}</code>. We could also have stored dependencies as additional fields, but this does not scale well with nested structs. It would either require putting an additional field for each dependency (be it direct, or indirect dependencies coming from a pointer to another struct), possibly defining other structures that hold dependencies to avoid having a large number of fields, inducing additional compilation time.</p><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p><code>cconvert</code>/<code>unsafe_convert</code> were extended on wrapper types so that, when using an API function directly, <a href="https://docs.julialang.org/en/v1/base/c/#ccall"><code>ccall</code></a> will convert a struct to its API-compatible version.</p></div></div><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../reference/options/">« Package options</a><a class="docs-footer-nextpage" href="../extension_mechanism/">Extension mechanism »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 17:42">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>and every structure exposes a convenient constructor that works perfectly with <code>String</code>s and mutable <code>AbstractArray</code>s. No manual <code>Ref</code>s/<code>cconvert</code>/<code>unsafe_convert</code> needed.</p><p>We hope that the additional <code>Vector{Any}</code> will not introduce too much overhead. In the future, this might be changed to a <code>NTuple{N, Any}</code> or a <code>StaticArrays.SVector{N, Any}</code>. We could also have stored dependencies as additional fields, but this does not scale well with nested structs. It would either require putting an additional field for each dependency (be it direct, or indirect dependencies coming from a pointer to another struct), possibly defining other structures that hold dependencies to avoid having a large number of fields, inducing additional compilation time.</p><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p><code>cconvert</code>/<code>unsafe_convert</code> were extended on wrapper types so that, when using an API function directly, <a href="https://docs.julialang.org/en/v1/base/c/#ccall"><code>ccall</code></a> will convert a struct to its API-compatible version.</p></div></div><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../reference/options/">« Package options</a><a class="docs-footer-nextpage" href="../extension_mechanism/">Extension mechanism »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 18:14">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/dev/next_chains/index.html

@@ -3,5 +3,5 @@
     T::Union{Type{<:Vulkan.HighLevelStruct}, Type{<:VulkanStruct}},
     args...
 ) -> Any
-</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/Vulkan.jl/blob/462bd7f2bd7be7f96ddfbe2100286096c65bdac7/src/prewrap/pointers.jl#LL102">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Vulkan.initialize_core" href="#Vulkan.initialize_core"><code>Vulkan.initialize_core</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">initialize_core(T, next_refs)</code></pre><p>Initialize a core Vulkan structure, with <code>next</code> chain types specified in <code>refs</code>.</p><p>Every ref in <code>refs</code> will be used to construct an initialized <code>pNext</code> element, and will be filled with the <em>value</em> of the initialized type, acting as the pointer. Note that these references will have to be preserved for the initialized Vulkan structure to remain valid.</p><pre><code class="language-julia hljs">initialize_core(T, refs) -&gt; Any
-</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/Vulkan.jl/blob/462bd7f2bd7be7f96ddfbe2100286096c65bdac7/src/prewrap/pointers.jl#LL64">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gen/">« Generator</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 17:42">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/Vulkan.jl/blob/5bb3afdcda498ac450cabb6cac3023a9bcfe7ac0/src/prewrap/pointers.jl#LL102">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Vulkan.initialize_core" href="#Vulkan.initialize_core"><code>Vulkan.initialize_core</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">initialize_core(T, next_refs)</code></pre><p>Initialize a core Vulkan structure, with <code>next</code> chain types specified in <code>refs</code>.</p><p>Every ref in <code>refs</code> will be used to construct an initialized <code>pNext</code> element, and will be filled with the <em>value</em> of the initialized type, acting as the pointer. Note that these references will have to be preserved for the initialized Vulkan structure to remain valid.</p><pre><code class="language-julia hljs">initialize_core(T, refs) -&gt; Any
+</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/Vulkan.jl/blob/5bb3afdcda498ac450cabb6cac3023a9bcfe7ac0/src/prewrap/pointers.jl#LL64">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gen/">« Generator</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 18:14">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/howto/debugging/index.html

@@ -17,4 +17,4 @@
     DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT,
 )</code></pre><p>You can now create your debug callback:</p><pre><code class="language-julia hljs">messenger = DebugUtilsMessengerEXT(instance, message_severity, message_type, debug_callback_c)</code></pre><p>However, make sure that the messenger stays alive as long as it is used. You should typically put it in a config next to the <code>instance</code> (for scripts, a global variable works as well).</p><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p>To debug the initialization of the instance itself, you can create the DebugUtilsMessengerEXTCreateInfo manually and include it in the <code>next</code> parameter of the <code>Instance</code>:</p><pre><code class="language-julia hljs">create_info = DebugUtilsMessengerCreateInfoEXT(message_severity, message_type, debug_callback_c)
 instance = Instance([&quot;VK_LAYER_KHRONOS_validation&quot;], [&quot;VK_EXT_debug_utils&quot;]; next = create_info)
-messenger = DebugUtilsMessengerEXT(instance, create_info)</code></pre></div></div><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../preferences/">« Specify package options</a><a class="docs-footer-nextpage" href="../handles/">Manipulate handles »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 17:42">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+messenger = DebugUtilsMessengerEXT(instance, create_info)</code></pre></div></div><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../preferences/">« Specify package options</a><a class="docs-footer-nextpage" href="../handles/">Manipulate handles »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 22 August 2023 18:14">Tuesday 22 August 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>