You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/sfml_rust/vkprocessor/struct.VkProcessor.html

47 lines
42 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `VkProcessor` struct in crate `sfml_rust`."><meta name="keywords" content="rust, rustlang, rust-lang, VkProcessor"><title>sfml_rust::vkprocessor::VkProcessor - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../sfml_rust/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Struct VkProcessor</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.instance">instance</a><a href="#structfield.physical">physical</a><a href="#structfield.device">device</a><a href="#structfield.queues">queues</a><a href="#structfield.queue">queue</a><a href="#structfield.swapchain">swapchain</a><a href="#structfield.swapchain_images">swapchain_images</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.create_swapchain">create_swapchain</a><a href="#method.get_font_handle">get_font_handle</a><a href="#method.get_kernel_handle">get_kernel_handle</a><a href="#method.get_shader_handle">get_shader_handle</a><a href="#method.get_texture_handle">get_texture_handle</a><a href="#method.is_open">is_open</a><a href="#method.new">new</a><a href="#method.new_compute_buffer">new_compute_buffer</a><a href="#method.new_swap_image">new_swap_image</a><a href="#method.preload_fonts">preload_fonts</a><a href="#method.preload_kernels">preload_kernels</a><a href="#method.preload_shaders">preload_shaders</a><a href="#method.preload_textures">preload_textures</a><a href="#method.read_compute_buffer">read_compute_buffer</a><a href="#method.recreate_swapchain">recreate_swapchain</a><a href="#method.run">run</a><a href="#method.write_compute_buffer">write_compute_buffer</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-Content">Content</a><a href="#impl-Erased">Erased</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-SafeBorrow%3CT%3E">SafeBorrow&lt;T&gt;</a><a href="#impl-Same%3CT%3E">Same&lt;T&gt;</a><a href="#impl-SetParameter">SetParameter</a><a href="#impl-SupersetOf%3CSS%3E">SupersetOf&lt;SS&gt;</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><p class='location'><a href='../index.html'>sfml_rust</a>::<wbr><a href='index.html'>vkprocessor</a></p><script>window.sidebarCurrent = {name: 'VkProcessor', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#28-48' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>sfml_rust</a>::<wbr><a href='index.html'>vkprocessor</a>::<wbr><a class="struct" href=''>VkProcessor</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct VkProcessor&lt;'a&gt; {
pub instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Instance&gt;,
pub physical: PhysicalDevice&lt;'a&gt;,
pub device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Device&gt;,
pub queues: QueuesIter,
pub queue: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Queue&gt;,
pub swapchain: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Swapchain&lt;Window&gt;&gt;&gt;,
pub swapchain_images: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;SwapchainImage&lt;Window&gt;&gt;&gt;&gt;,
// some fields omitted
}</pre></div><div class='docblock'><p>VKProcessor holds the vulkan instance information, the swapchain,
and the compute and canvas states</p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.instance" class="structfield small-section-header"><a href="#structfield.instance" class="anchor field"></a><code id="instance.v">instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Instance&gt;</code></span><span id="structfield.physical" class="structfield small-section-header"><a href="#structfield.physical" class="anchor field"></a><code id="physical.v">physical: PhysicalDevice&lt;'a&gt;</code></span><span id="structfield.device" class="structfield small-section-header"><a href="#structfield.device" class="anchor field"></a><code id="device.v">device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Device&gt;</code></span><span id="structfield.queues" class="structfield small-section-header"><a href="#structfield.queues" class="anchor field"></a><code id="queues.v">queues: QueuesIter</code></span><span id="structfield.queue" class="structfield small-section-header"><a href="#structfield.queue" class="anchor field"></a><code id="queue.v">queue: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Queue&gt;</code></span><span id="structfield.swapchain" class="structfield small-section-header"><a href="#structfield.swapchain" class="anchor field"></a><code id="swapchain.v">swapchain: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Swapchain&lt;Window&gt;&gt;&gt;</code></span><span id="structfield.swapchain_images" class="structfield small-section-header"><a href="#structfield.swapchain_images" class="anchor field"></a><code id="swapchain_images.v">swapchain_images: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;SwapchainImage&lt;Window&gt;&gt;&gt;&gt;</code></span><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl&lt;'a&gt; <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#51-319' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;instance: &amp;'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Instance&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;surface: &amp;'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Surface&lt;Window&gt;&gt;<br>) -&gt; <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#55-89' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new VkProcessor from an instance and surface
This includes the physical device, queues, compute and canvas state</p>
</div><h4 id='method.is_open' class="method"><code id='is_open.v'>pub fn <a href='#method.is_open' class='fnname'>is_open</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#92-95' title='goto source code'>[src]</a></h4><div class='docblock'><p>VKProcessor controls the window. So it will let the main loop know when it is done</p>
</div><h4 id='method.create_swapchain' class="method"><code id='create_swapchain.v'>pub fn <a href='#method.create_swapchain' class='fnname'>create_swapchain</a>(&amp;mut self, surface: &amp;'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Surface&lt;Window&gt;&gt;)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#98-131' title='goto source code'>[src]</a></h4><div class='docblock'><p>Using the surface, we calculate the surface capabilities and create the swapchain and swapchain images</p>
</div><h4 id='method.recreate_swapchain' class="method"><code id='recreate_swapchain.v'>pub fn <a href='#method.recreate_swapchain' class='fnname'>recreate_swapchain</a>(&amp;mut self, surface: &amp;'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Surface&lt;Window&gt;&gt;)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#134-152' title='goto source code'>[src]</a></h4><div class='docblock'><p>On screen resizes, the swapchain and images must be recreated</p>
</div><h4 id='method.preload_textures' class="method"><code id='preload_textures.v'>pub fn <a href='#method.preload_textures' class='fnname'>preload_textures</a>(&amp;mut self)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#155-161' title='goto source code'>[src]</a></h4><div class='docblock'><p>A hardcoded list of textures which can be preloaded from this function</p>
</div><h4 id='method.preload_kernels' class="method"><code id='preload_kernels.v'>pub fn <a href='#method.preload_kernels' class='fnname'>preload_kernels</a>(&amp;mut self)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#164-167' title='goto source code'>[src]</a></h4><div class='docblock'><p>A hardcoded list of kernels which can be preloaded from this function</p>
</div><h4 id='method.preload_shaders' class="method"><code id='preload_shaders.v'>pub fn <a href='#method.preload_shaders' class='fnname'>preload_shaders</a>(&amp;mut self)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#170-175' title='goto source code'>[src]</a></h4><div class='docblock'><p>A hardcoded list of shaders which can be preloaded from this function</p>
</div><h4 id='method.preload_fonts' class="method"><code id='preload_fonts.v'>pub fn <a href='#method.preload_fonts' class='fnname'>preload_fonts</a>(&amp;mut self)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#178-180' title='goto source code'>[src]</a></h4><div class='docblock'><p>A hardcoded list of shaders which can be proloaded from this function</p>
</div><h4 id='method.get_texture_handle' class="method"><code id='get_texture_handle.v'>pub fn <a href='#method.get_texture_handle' class='fnname'>get_texture_handle</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;texture_name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CanvasTextureHandle.html" title="struct sfml_rust::canvas::CanvasTextureHandle">CanvasTextureHandle</a>&gt;&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#183-185' title='goto source code'>[src]</a></h4><div class='docblock'><p>O(n) Lookup for the matching texture string</p>
</div><h4 id='method.get_kernel_handle' class="method"><code id='get_kernel_handle.v'>pub fn <a href='#method.get_kernel_handle' class='fnname'>get_kernel_handle</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;kernel_name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/compute/compu_kernel/struct.CompuKernelHandle.html" title="struct sfml_rust::compute::compu_kernel::CompuKernelHandle">CompuKernelHandle</a>&gt;&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#188-190' title='goto source code'>[src]</a></h4><div class='docblock'><p>O(n) Lookup for the matching kernel string</p>
</div><h4 id='method.get_shader_handle' class="method"><code id='get_shader_handle.v'>pub fn <a href='#method.get_shader_handle' class='fnname'>get_shader_handle</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;shader_name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CompiledGraphicsPipelineHandle.html" title="struct sfml_rust::canvas::CompiledGraphicsPipelineHandle">CompiledGraphicsPipelineHandle</a>&gt;&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#193-195' title='goto source code'>[src]</a></h4><div class='docblock'><p>O(n) Lookup for the matching shader string</p>
</div><h4 id='method.get_font_handle' class="method"><code id='get_font_handle.v'>pub fn <a href='#method.get_font_handle' class='fnname'>get_font_handle</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;font_name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CanvasFontHandle.html" title="struct sfml_rust::canvas::CanvasFontHandle">CanvasFontHandle</a>&gt;&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#197-199' title='goto source code'>[src]</a></h4><h4 id='method.new_swap_image' class="method"><code id='new_swap_image.v'>pub fn <a href='#method.new_swap_image' class='fnname'>new_swap_image</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;dimensions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a><br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CanvasImageHandle.html" title="struct sfml_rust::canvas::CanvasImageHandle">CanvasImageHandle</a>&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#202-208' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new image which has the transfer usage</p>
</div><h4 id='method.new_compute_buffer' class="method"><code id='new_compute_buffer.v'>pub fn <a href='#method.new_compute_buffer' class='fnname'>new_compute_buffer</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;data: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;dimensions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CompuBufferHandle.html" title="struct sfml_rust::canvas::CompuBufferHandle">CompuBufferHandle</a>&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#211-213' title='goto source code'>[src]</a></h4><div class='docblock'><p>Builds a compute buffer and returns it's handle</p>
</div><h4 id='method.read_compute_buffer' class="method"><code id='read_compute_buffer.v'>pub fn <a href='#method.read_compute_buffer' class='fnname'>read_compute_buffer</a>(&amp;mut self, handle: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CompuBufferHandle.html" title="struct sfml_rust::canvas::CompuBufferHandle">CompuBufferHandle</a>&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#216-218' title='goto source code'>[src]</a></h4><div class='docblock'><p>Takes a compute buffer handle and returns the read data</p>
</div><h4 id='method.write_compute_buffer' class="method"><code id='write_compute_buffer.v'>pub fn <a href='#method.write_compute_buffer' class='fnname'>write_compute_buffer</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;handle: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../sfml_rust/canvas/struct.CompuBufferHandle.html" title="struct sfml_rust::canvas::CompuBufferHandle">CompuBufferHandle</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;data: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;<br>)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#221-223' title='goto source code'>[src]</a></h4><div class='docblock'><p>Takes a compute buffer handle and writes the received data</p>
</div><h4 id='method.run' class="method"><code id='run.v'>pub fn <a href='#method.run' class='fnname'>run</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;surface: &amp;'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Surface&lt;Window&gt;&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;canvas_frame: <a class="struct" href="../../sfml_rust/canvas/canvas_frame/struct.CanvasFrame.html" title="struct sfml_rust::canvas::canvas_frame::CanvasFrame">CanvasFrame</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;compute_frame: <a class="struct" href="../../sfml_rust/compute/compu_frame/struct.CompuFrame.html" title="struct sfml_rust::compute::compu_frame::CompuFrame">CompuFrame</a><br>)</code><a class='srclink' href='../../src/sfml_rust/vkprocessor.rs.html#226-318' title='goto source code'>[src]</a></h4><div class='docblock'></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../sfml_rust/vkprocessor/struct.VkProcessor.html" title="struct sfml_rust::vkprocessor::VkProcessor">VkProcessor</a>&lt;'a&gt;</code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div><h3 id='impl-SetParameter' class='impl'><code class='in-band'>impl&lt;T&gt; SetParameter for T</code><a href='#impl-SetParameter' class='anchor'></a></h3><div class='impl-items'><h4 id='method.set' class="method hidden"><code id='set.v'>fn <a href='#method.set' class='fnname'>set</a>&lt;T&gt;(&amp;mut self, value: T) -&gt; &lt;T as Parameter&lt;Self&gt;&gt;::Result <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Parameter&lt;Self&gt;,&nbsp;</span></code></h4><div class='docblock hidden'><p>Sets <code>value</code> as a parameter of <code>self</code>.</p>
</div></div><h3 id='impl-Same%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; Same&lt;T&gt; for T</code><a href='#impl-Same%3CT%3E' class='anchor'></a></h3><div class='impl-items'><h4 id='associatedtype.Output' class="type"><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a> = T</code></h4><div class='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3 id='impl-SupersetOf%3CSS%3E' class='impl'><code class='in-band'>impl&lt;SS, SP&gt; SupersetOf&lt;SS&gt; for SP <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;SS: SubsetOf&lt;SP&gt;,&nbsp;</span></code><a href='#impl-SupersetOf%3CSS%3E' class='anchor'></a></h3><div class='impl-items'><h4 id='method.to_subset' class="method hidden"><code id='to_subset.v'>fn <a href='#method.to_subset' class='fnname'>to_subset</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;SS&gt;</code></h4><div class='docblock hidden'><p>The inverse inclusion map: attempts to construct <code>self</code> from the equivalent element of its superset. <a href="#method.to_subset">Read more</a></p>
</div><h4 id='method.is_in_subset' class="method hidden"><code id='is_in_subset.v'>fn <a href='#method.is_in_subset' class='fnname'>is_in_subset</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><div class='docblock hidden'><p>Checks if <code>self</code> is actually part of its subset <code>T</code> (and can be converted to it).</p>
</div><h4 id='method.to_subset_unchecked' class="method hidden"><code id='to_subset_unchecked.v'>unsafe fn <a href='#method.to_subset_unchecked' class='fnname'>to_subset_unchecked</a>(&amp;self) -&gt; SS</code></h4><div class='docblock hidden'><p>Use with care! Same as <code>self.to_subset</code> but without any property checks. Always succeeds.</p>
</div><h4 id='method.from_subset' class="method hidden"><code id='from_subset.v'>fn <a href='#method.from_subset' class='fnname'>from_subset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>SS) -&gt; SP</code></h4><div class='docblock hidden'><p>The inclusion map: converts <code>self</code> to the equivalent element of its superset.</p>
</div></div><h3 id='impl-Content' class='impl'><code class='in-band'>impl&lt;T&gt; Content for T</code><a href='#impl-Content' class='anchor'></a></h3><div class='impl-items'><h4 id='method.ref_from_ptr' class="method hidden"><code id='ref_from_ptr.v'>fn <a href='#method.ref_from_ptr' class='fnname'>ref_from_ptr</a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>&gt;</code></h4><div class='docblock hidden'><p>Builds a pointer to this type from a raw pointer.</p>
</div><h4 id='method.is_size_suitable' class="method hidden"><code id='is_size_suitable.v'>fn <a href='#method.is_size_suitable' class='fnname'>is_size_suitable</a>(size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><div class='docblock hidden'><p>Returns true if the size is suitable to store a type like this.</p>
</div><h4 id='method.indiv_size' class="method hidden"><code id='indiv_size.v'>fn <a href='#method.indiv_size' class='fnname'>indiv_size</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h4><div class='docblock hidden'><p>Returns the size of an individual element.</p>
</div></div><h3 id='impl-Erased' class='impl'><code class='in-band'>impl&lt;T&gt; Erased for T</code><a href='#impl-Erased' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-SafeBorrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; SafeBorrow&lt;T&gt; for T</code><a href='#impl-SafeBorrow%3CT%3E' class='anchor'></a></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "sfml_rust";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>