Skip to content

Commit

Permalink
build based on 09d1965
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 1, 2023
1 parent b4b9993 commit 5b90a0b
Show file tree
Hide file tree
Showing 10 changed files with 2,188 additions and 2,188 deletions.
4,288 changes: 2,144 additions & 2,144 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions dev/dev/gen/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/dev/next_chains/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/48a9e7d557b239f6ef53b6351ee556153e31521e/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/48a9e7d557b239f6ef53b6351ee556153e31521e/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="Sunday 1 October 2023 23:09">Sunday 1 October 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/09d1965cfed92c33a24e1dc5606c5d5a73314326/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/09d1965cfed92c33a24e1dc5606c5d5a73314326/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="Sunday 1 October 2023 23:09">Sunday 1 October 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
12 changes: 6 additions & 6 deletions dev/dev/spec/index.html
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions dev/howto/handles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@

const instance = Instance([], [])
const pdevice = first(unwrap(enumerate_physical_devices(instance)))
const device = Device(pdevice, [DeviceQueueCreateInfo(0, [1.0])], [], [])</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Device(Ptr{Nothing} @0x0000000007aea990)</code></pre><p>The most convenient way to create a handle is through its constructor</p><pre><code class="language-julia hljs">buffer = Buffer(
const device = Device(pdevice, [DeviceQueueCreateInfo(0, [1.0])], [], [])</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Device(Ptr{Nothing} @0x00000000074632e0)</code></pre><p>The most convenient way to create a handle is through its constructor</p><pre><code class="language-julia hljs">buffer = Buffer(
device,
100,
BUFFER_USAGE_TRANSFER_SRC_BIT,
SHARING_MODE_EXCLUSIVE,
[];
flags = BUFFER_CREATE_SPARSE_ALIASED_BIT,
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x000000000585cf98)</code></pre><p>This is equivalent to</p><pre><code class="language-julia hljs">unwrap(
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x00000000063d9ae8)</code></pre><p>This is equivalent to</p><pre><code class="language-julia hljs">unwrap(
create_buffer(
device,
100,
Expand All @@ -19,7 +19,7 @@
[];
flags = BUFFER_CREATE_SPARSE_ALIASED_BIT,
),
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x0000000004771b68)</code></pre><p><a href="../../tutorial/error_handling/#Error-handling">Error handling</a> can be performed before unwrapping, e.g.</p><pre><code class="language-julia hljs">res = create_buffer(
)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x0000000006bf2318)</code></pre><p><a href="../../tutorial/error_handling/#Error-handling">Error handling</a> can be performed before unwrapping, e.g.</p><pre><code class="language-julia hljs">res = create_buffer(
device,
100,
BUFFER_USAGE_TRANSFER_SRC_BIT,
Expand All @@ -31,21 +31,21 @@
error(&quot;Could not create buffer!&quot;)
else
unwrap(res)
end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x0000000006197098)</code></pre><p>Create info parameters can be built separately, such as</p><pre><code class="language-julia hljs">info = BufferCreateInfo(
end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x000000000413ad28)</code></pre><p>Create info parameters can be built separately, such as</p><pre><code class="language-julia hljs">info = BufferCreateInfo(
100,
BUFFER_USAGE_TRANSFER_SRC_BIT,
SHARING_MODE_EXCLUSIVE,
[];
flags = BUFFER_CREATE_SPARSE_ALIASED_BIT,
)

Buffer(device, info)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x00000000071e0518)</code></pre><pre><code class="language-julia hljs">create_buffer(device, info)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Result(Buffer(Ptr{Nothing} @0x00000000064af1b8))</code></pre><p>Handles allocated in batches (such as command buffers) do not have a dedicated constructor; you will need to call the corresponding function yourself.</p><pre><code class="language-julia hljs">command_pool = CommandPool(device, 0)
Buffer(device, info)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Buffer(Ptr{Nothing} @0x0000000004b54118)</code></pre><pre><code class="language-julia hljs">create_buffer(device, info)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Result(Buffer(Ptr{Nothing} @0x0000000006bb0918))</code></pre><p>Handles allocated in batches (such as command buffers) do not have a dedicated constructor; you will need to call the corresponding function yourself.</p><pre><code class="language-julia hljs">command_pool = CommandPool(device, 0)
info = CommandBufferAllocateInfo(command_pool, COMMAND_BUFFER_LEVEL_PRIMARY, 5)
res = allocate_command_buffers(device, info)
iserror(res) &amp;&amp; error(&quot;Tried to create 5 command buffers, but failed miserably.&quot;)
cbuffers = unwrap(res)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">5-element Vector{CommandBuffer}:
CommandBuffer(Ptr{Nothing} @0x0000000005d20f40)
CommandBuffer(Ptr{Nothing} @0x0000000004183640)
CommandBuffer(Ptr{Nothing} @0x0000000006ee6e40)
CommandBuffer(Ptr{Nothing} @0x000000000429b250)
CommandBuffer(Ptr{Nothing} @0x0000000004f93500)</code></pre><p>Note that they won&#39;t be freed automatically; forgetting to free them after use would result in a memory leak (see <a href="#Destroying-a-handle">Destroying a handle</a>).</p><h2 id="Destroying-a-handle"><a class="docs-heading-anchor" href="#Destroying-a-handle">Destroying a handle</a><a id="Destroying-a-handle-1"></a><a class="docs-heading-anchor-permalink" href="#Destroying-a-handle" title="Permalink"></a></h2><p>The garbage collector will free most handles automatically with a finalizer (see <a href="../../reference/wrapper_types/#Automatic-finalization">Automatic finalization</a>), but you can force the destruction yourself early with</p><pre><code class="language-julia hljs">finalize(buffer) # calls `destroy_buffer`</code></pre><p>This is most useful when you need to release resources associated to a handle, e.g. a <code>DeviceMemory</code>. Handle types that can be freed in batches don&#39;t register finalizers, such as <code>CommandBuffer</code> and <code>DescriptorSet</code>. They must be freed with</p><pre><code class="language-julia hljs">free_command_buffers(device, command_pool, cbuffers)</code></pre><p>or the corresponding <code>free_descriptor_sets</code> for <code>DescriptorSet</code>s.</p><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="../debugging/">« Debug an application</a><a class="docs-footer-nextpage" href="../shaders/">Compile a SPIR-V shader from Julia »</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="Sunday 1 October 2023 23:09">Sunday 1 October 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
CommandBuffer(Ptr{Nothing} @0x0000000006b06b50)
CommandBuffer(Ptr{Nothing} @0x000000000635b860)
CommandBuffer(Ptr{Nothing} @0x0000000005fbbe90)
CommandBuffer(Ptr{Nothing} @0x000000000517afe0)
CommandBuffer(Ptr{Nothing} @0x0000000005da35c0)</code></pre><p>Note that they won&#39;t be freed automatically; forgetting to free them after use would result in a memory leak (see <a href="#Destroying-a-handle">Destroying a handle</a>).</p><h2 id="Destroying-a-handle"><a class="docs-heading-anchor" href="#Destroying-a-handle">Destroying a handle</a><a id="Destroying-a-handle-1"></a><a class="docs-heading-anchor-permalink" href="#Destroying-a-handle" title="Permalink"></a></h2><p>The garbage collector will free most handles automatically with a finalizer (see <a href="../../reference/wrapper_types/#Automatic-finalization">Automatic finalization</a>), but you can force the destruction yourself early with</p><pre><code class="language-julia hljs">finalize(buffer) # calls `destroy_buffer`</code></pre><p>This is most useful when you need to release resources associated to a handle, e.g. a <code>DeviceMemory</code>. Handle types that can be freed in batches don&#39;t register finalizers, such as <code>CommandBuffer</code> and <code>DescriptorSet</code>. They must be freed with</p><pre><code class="language-julia hljs">free_command_buffers(device, command_pool, cbuffers)</code></pre><p>or the corresponding <code>free_descriptor_sets</code> for <code>DescriptorSet</code>s.</p><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="../debugging/">« Debug an application</a><a class="docs-footer-nextpage" href="../shaders/">Compile a SPIR-V shader from Julia »</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="Sunday 1 October 2023 23:09">Sunday 1 October 2023</span>. Using Julia version 1.9.0-rc3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/howto/shaders/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
&quot;-S&quot;
&quot;vert&quot;
&quot;-o&quot;
&quot;/tmp/jl_CjeP4VAjIN&quot;</code></pre><p>Run <code>glslang</code>.</p><pre><code class="language-julia hljs">run(pipeline(`$glslang $flags`, stdin = _stdin))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Process(`/home/runner/.julia/artifacts/f1fa93f41410326ba4ca250dbf71306ccc966830/bin/glslangValidator --stdin -V -S vert -o /tmp/jl_CjeP4VAjIN`, ProcessExited(0))</code></pre><p>Read the code and clean the temporary file.</p><pre><code class="language-julia hljs">spirv_code = reinterpret(UInt32, read(path))
&quot;/tmp/jl_S74vsVANef&quot;</code></pre><p>Run <code>glslang</code>.</p><pre><code class="language-julia hljs">run(pipeline(`$glslang $flags`, stdin = _stdin))</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Process(`/home/runner/.julia/artifacts/f1fa93f41410326ba4ca250dbf71306ccc966830/bin/glslangValidator --stdin -V -S vert -o /tmp/jl_S74vsVANef`, ProcessExited(0))</code></pre><p>Read the code and clean the temporary file.</p><pre><code class="language-julia hljs">spirv_code = reinterpret(UInt32, read(path))
rm(path)
@assert first(spirv_code) == 0x07230203 # SPIR-V magic number
spirv_code</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">118-element reinterpret(UInt32, ::Vector{UInt8}):
Expand Down
Loading

0 comments on commit 5b90a0b

Please sign in to comment.