build based on b1980a9

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-07-01T12:25:17","documenter_version":"1.1.0"}}
+{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-07-01T13:00:01","documenter_version":"1.1.0"}}

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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 12:25">Monday 1 July 2024</span>. Using Julia version 1.9.3.</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 13:00">Monday 1 July 2024</span>. Using Julia version 1.9.3.</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/8485a5e8c073d3f2f4e67c829e05e4f4bd8fafc9/src/prewrap/pointers.jl#LL121">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><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/8485a5e8c073d3f2f4e67c829e05e4f4bd8fafc9/src/prewrap/pointers.jl#LL83">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 12:25">Monday 1 July 2024</span>. Using Julia version 1.9.3.</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/b1980a9b6b8959fa4b4243715b665674c777f125/src/prewrap/pointers.jl#LL121">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><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/b1980a9b6b8959fa4b4243715b665674c777f125/src/prewrap/pointers.jl#LL83">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 13:00">Monday 1 July 2024</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/dev/spec/index.html

@@ -8,4 +8,4 @@
 </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/serenity4/VulkanSpec.jl/blob/v0.1.2/src/functions.jl#L182">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VulkanSpec.isalias-Tuple{Any, VulkanSpec.Aliases}" href="#VulkanSpec.isalias-Tuple{Any, VulkanSpec.Aliases}"><code>VulkanSpec.isalias</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Whether this type is an alias for another name.</p><pre><code class="language-julia hljs">isalias(name, aliases::VulkanSpec.Aliases) -&gt; Bool
 </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/serenity4/VulkanSpec.jl/blob/v0.1.2/src/aliases.jl#L29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VulkanSpec.isenabled-Tuple{Any, Extensions}" href="#VulkanSpec.isenabled-Tuple{Any, Extensions}"><code>VulkanSpec.isenabled</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Return whether an extension is enabled for standard Vulkan - that is, a given symbol <code>x</code> is either core or is from an extension that has not been disabled, or is not exclusive to Vulkan SC.</p><pre><code class="language-julia hljs">isenabled(x, extensions::Extensions) -&gt; Any
 </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/serenity4/VulkanSpec.jl/blob/v0.1.2/src/features.jl#L79">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VulkanSpec.len" href="#VulkanSpec.len"><code>VulkanSpec.len</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">len(pCode)</code></pre><p>Return the function parameter or struct member which describes the length of the provided pointer argument. When the length is more complex than a simple argument, i.e. is a function of another parameter, <code>missing</code> is returned. In this case, refer to the <code>.len</code> field of the argument to get the correct <code>Expr</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/serenity4/VulkanSpec.jl/blob/v0.1.2/src/functions.jl#L158">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VulkanSpec.translate_c_type-Tuple{Any}" href="#VulkanSpec.translate_c_type-Tuple{Any}"><code>VulkanSpec.translate_c_type</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Semantically translate C types to their Julia counterpart. Note that since it is a semantic translation, translated types do not necessarily have the same layout, e.g. VkBool32 =&gt; Bool (8 bits).</p><pre><code class="language-julia hljs">translate_c_type(ctype) -&gt; Any
-</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/serenity4/VulkanSpec.jl/blob/v0.1.2/src/utils.jl#L53">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" 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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 12:25">Monday 1 July 2024</span>. Using Julia version 1.9.3.</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/serenity4/VulkanSpec.jl/blob/v0.1.2/src/utils.jl#L53">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" 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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 1 July 2024 13:00">Monday 1 July 2024</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>