<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `VkProcessor` struct in crate `sfml_rust`."><metaname="keywords"content="rust, rustlang, rust-lang, VkProcessor"><title>sfml_rust::vkprocessor::VkProcessor - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="shortcut icon"href="../../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../sfml_rust/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct VkProcessor</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.instance">instance</a><ahref="#structfield.physical">physical</a><ahref="#structfield.device">device</a><ahref="#structfield.queues">queues</a><ahref="#structfield.queue">queue</a><ahref="#structfield.swapchain">swapchain</a><ahref="#structfield.swapchain_images">swapchain_images</a></div><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.create_swapchain">create_swapchain</a><ahref="#method.get_font_handle">get_font_handle</a><ahref="#method.get_kernel_handle">get_kernel_handle</a><ahref="#method.get_shader_handle">get_shader_handle</a><ahref="#method.get_texture_handle">get_texture_handle</a><ahref="#method.is_open">is_open</a><ahref="#method.new">new</a><ahref="#method.new_compute_buffer">new_compute_buffer</a><ahref="#method.new_swap_image">new_swap_image</a><ahref="#method.preload_fonts">preload_fonts</a><ahref="#method.preload_kernels">preload_kernels</a><ahref="#method.preload_shaders">preload_shaders</a><ahref="#method.preload_textures">preload_textures</a><ahref="#method.read_compute_buffer">read_compute_buffer</a><ahref="#method.recreate_swapchain">recreate_swapchain</a><ahref="#method.run">run</a><ahref="#method.write_compute_buffer">write_compute_buffer</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">!UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-Content">Content</a><ahref="#impl-Erased">Erased</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-SafeBorrow%3CT%3E">SafeBorrow<T></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-SetParameter">SetParameter</a><ahref="#impl-SupersetOf%3CSS%3E">SupersetOf<SS></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><pclass='location'><ahref='../index.html'>sfml_rust</a>::<wbr><ahref='index.html'>vkprocessor</a></p><script>window.sidebarCurrent={name:'VkProcessor',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pickanothe
This includes the physical device, queues, compute and canvas state</p>
</div><h4id='method.is_open'class="method"><codeid='is_open.v'>pub fn <ahref='#method.is_open'class='fnname'>is_open</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#92-95'title='goto source code'>[src]</a></h4><divclass='docblock'><p>VKProcessor controls the window. So it will let the main loop know when it is done</p>
</div><h4id='method.create_swapchain'class="method"><codeid='create_swapchain.v'>pub fn <ahref='#method.create_swapchain'class='fnname'>create_swapchain</a>(&mut self, surface: &'a <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"title="struct alloc::sync::Arc">Arc</a><Surface<Window>>)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#98-131'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Using the surface, we calculate the surface capabilities and create the swapchain and swapchain images</p>
</div><h4id='method.recreate_swapchain'class="method"><codeid='recreate_swapchain.v'>pub fn <ahref='#method.recreate_swapchain'class='fnname'>recreate_swapchain</a>(&mut self, surface: &'a <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html"title="struct alloc::sync::Arc">Arc</a><Surface<Window>>)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#134-152'title='goto source code'>[src]</a></h4><divclass='docblock'><p>On screen resizes, the swapchain and images must be recreated</p>
</div><h4id='method.preload_textures'class="method"><codeid='preload_textures.v'>pub fn <ahref='#method.preload_textures'class='fnname'>preload_textures</a>(&mut self)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#155-161'title='goto source code'>[src]</a></h4><divclass='docblock'><p>A hardcoded list of textures which can be preloaded from this function</p>
</div><h4id='method.preload_kernels'class="method"><codeid='preload_kernels.v'>pub fn <ahref='#method.preload_kernels'class='fnname'>preload_kernels</a>(&mut self)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#164-167'title='goto source code'>[src]</a></h4><divclass='docblock'><p>A hardcoded list of kernels which can be preloaded from this function</p>
</div><h4id='method.preload_shaders'class="method"><codeid='preload_shaders.v'>pub fn <ahref='#method.preload_shaders'class='fnname'>preload_shaders</a>(&mut self)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#170-175'title='goto source code'>[src]</a></h4><divclass='docblock'><p>A hardcoded list of shaders which can be preloaded from this function</p>
</div><h4id='method.preload_fonts'class="method"><codeid='preload_fonts.v'>pub fn <ahref='#method.preload_fonts'class='fnname'>preload_fonts</a>(&mut self)</code><aclass='srclink'href='../../src/sfml_rust/vkprocessor.rs.html#178-180'title='goto source code'>[src]</a></h4><divclass='docblock'><p>A hardcoded list of shaders which can be proloaded from this function</p>
</div></div><h3id='impl-From%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for T</code><ahref='#impl-From%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.from'class="method hidden"><codeid='from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from'class='fnname'>from</a>(t: T) -> T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="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><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div><h3id='impl-SetParameter'class='impl'><codeclass='in-band'>impl<T> SetParameter for T</code><ahref='#impl-SetParameter'class='anchor'></a></h3><divclass='impl-items'><h4id='method.set'class="method hidden"><codeid='set.v'>fn <ahref='#method.set'class='fnname'>set</a><T>(&mut self, value: T) -><T as Parameter<Self>>::Result <spanclass="where fmt-newline">where<br> T: Parameter<Self>, </span></code></h4><divclass='docblock hidden'><p>Sets <code>value</code> as a parameter of <code>self</code>.</p>
</div></div><h3id='impl-Same%3CT%3E'class='impl'><codeclass='in-band'>impl<T> Same<T> for T</code><ahref='#impl-Same%3CT%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='associatedtype.Output'class="type"><codeid='Output.t'>type <ahref='#associatedtype.Output'class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id='impl-SupersetOf%3CSS%3E'class='impl'><codeclass='in-band'>impl<SS, SP> SupersetOf<SS> for SP <spanclass="where fmt-newline">where<br> SS: SubsetOf<SP>, </span></code><ahref='#impl-SupersetOf%3CSS%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='method.to_subset'class="method hidden"><codeid='to_subset.v'>fn <ahref='#method.to_subset'class='fnname'>to_subset</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><SS></code></h4><divclass='docblock hidden'><p>The inverse inclusion map: attempts to construct <code>self</code> from the equivalent element of its superset. <ahref="#method.to_subset">Read more</a></p>
</div><h4id='method.is_in_subset'class="method hidden"><codeid='is_in_subset.v'>fn <ahref='#method.is_in_subset'class='fnname'>is_in_subset</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><divclass='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><h4id='method.to_subset_unchecked'class="method hidden"><codeid='to_subset_unchecked.v'>unsafe fn <ahref='#method.to_subset_unchecked'class='fnname'>to_subset_unchecked</a>(&self) -> SS</code></h4><divclass='docblock hidden'><p>Use with care! Same as <code>self.to_subset</code> but without any property checks. Always succeeds.</p>
</div><h4id='method.from_subset'class="method hidden"><codeid='from_subset.v'>fn <ahref='#method.from_subset'class='fnname'>from_subset</a>(element: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>SS) -> SP</code></h4><divclass='docblock hidden'><p>The inclusion map: converts <code>self</code> to the equivalent element of its superset.</p>
</div></div><h3id='impl-Content'class='impl'><codeclass='in-band'>impl<T> Content for T</code><ahref='#impl-Content'class='anchor'></a></h3><divclass='impl-items'><h4id='method.ref_from_ptr'class="method hidden"><codeid='ref_from_ptr.v'>fn <ahref='#method.ref_from_ptr'class='fnname'>ref_from_ptr</a>(ptr: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><aclass="enum"href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html"title="enum core::ffi::c_void">c_void</a>, size: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>></code></h4><divclass='docblock hidden'><p>Builds a pointer to this type from a raw pointer.</p>
</div><h4id='method.is_size_suitable'class="method hidden"><codeid='is_size_suitable.v'>fn <ahref='#method.is_size_suitable'class='fnname'>is_size_suitable</a>(size: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><divclass='docblock hidden'><p>Returns true if the size is suitable to store a type like this.</p>
</div><h4id='method.indiv_size'class="method hidden"><codeid='indiv_size.v'>fn <ahref='#method.indiv_size'class='fnname'>indiv_size</a>() -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h4><divclass='docblock hidden'><p>Returns the size of an individual element.</p>
</div></div><h3id='impl-Erased'class='impl'><codeclass='in-band'>impl<T> Erased for T</code><ahref='#impl-Erased'class='anchor'></a></h3><divclass='impl-items'></div><h3id='impl-SafeBorrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T> SafeBorrow<T> for T</code><ahref='#impl-SafeBorrow%3CT%3E'class='anchor'></a></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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>⏎</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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
