|
|
|
|
|
<!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 `MemoryPool` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, MemoryPool"><title>vulkano::memory::pool::MemoryPool - 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 trait"><!--[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">☰</div><a href='../../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Trait MemoryPool</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Alloc">Alloc</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.alloc_generic">alloc_generic</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.alloc_from_requirements">alloc_from_requirements</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-MemoryPool-for-Arc%3CStdMemoryPool%3E">Arc<StdMemoryPool></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>memory</a>::<wbr><a href='index.html'>pool</a></p><script>window.sidebarCurrent = {name: 'MemoryPool', ty: 'trait', 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'>−</span>]</a></span><a class='srclink' href='../../../src/vulkano/memory/pool/mod.rs.html#30-157' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>memory</a>::<wbr><a href='index.html'>pool</a>::<wbr><a class="trait" href=''>MemoryPool</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait MemoryPool: <a class="trait" href="../../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> {
|
|
|
|
|
|
type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/memory/pool/trait.MemoryPoolAlloc.html" title="trait vulkano::memory::pool::MemoryPoolAlloc">MemoryPoolAlloc</a>;
|
|
|
|
|
|
fn <a href='#tymethod.alloc_generic' class='fnname'>alloc_generic</a>(<br> &self, <br> ty: <a class="struct" href="../../../vulkano/instance/struct.MemoryType.html" title="struct vulkano::instance::MemoryType">MemoryType</a>, <br> size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> alignment: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> layout: <a class="enum" href="../../../vulkano/memory/pool/enum.AllocLayout.html" title="enum vulkano::memory::pool::AllocLayout">AllocLayout</a>, <br> map: <a class="enum" href="../../../vulkano/memory/pool/enum.MappingRequirement.html" title="enum vulkano::memory::pool::MappingRequirement">MappingRequirement</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../vulkano/memory/pool/trait.MemoryPool.html#associatedtype.Alloc" title="type vulkano::memory::pool::MemoryPool::Alloc">Alloc</a>, <a class="enum" href="../../../vulkano/memory/enum.DeviceMemoryAllocError.html" title="enum vulkano::memory::DeviceMemoryAllocError">DeviceMemoryAllocError</a>>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.alloc_from_requirements' class='fnname'>alloc_from_requirements</a><F>(<br> &self, <br> requirements: &<a class="struct" href="../../../vulkano/memory/struct.MemoryRequirements.html" title="struct vulkano::memory::MemoryRequirements">MemoryRequirements</a>, <br> layout: <a class="enum" href="../../../vulkano/memory/pool/enum.AllocLayout.html" title="enum vulkano::memory::pool::AllocLayout">AllocLayout</a>, <br> map: <a class="enum" href="../../../vulkano/memory/pool/enum.MappingRequirement.html" title="enum vulkano::memory::pool::MappingRequirement">MappingRequirement</a>, <br> dedicated: <a class="enum" href="../../../vulkano/memory/enum.DedicatedAlloc.html" title="enum vulkano::memory::DedicatedAlloc">DedicatedAlloc</a>, <br> filter: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../../vulkano/memory/pool/enum.PotentialDedicatedAllocation.html" title="enum vulkano::memory::pool::PotentialDedicatedAllocation">PotentialDedicatedAllocation</a><Self::<a class="type" href="../../../vulkano/memory/pool/trait.MemoryPool.html#associatedtype.Alloc" title="type vulkano::memory::pool::MemoryPool::Alloc">Alloc</a>>, <a class="enum" href="../../../vulkano/memory/enum.DeviceMemoryAllocError.html" title="enum vulkano::memory::DeviceMemoryAllocError">DeviceMemoryAllocError</a>><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../../vulkano/instance/struct.MemoryType.html" title="struct vulkano::instance::MemoryType">MemoryType</a>) -> <a class="enum" href="../../../vulkano/memory/pool/enum.AllocFromRequirementsFilter.html" title="enum vulkano::memory::pool::AllocFromRequirementsFilter">AllocFromRequirementsFilter</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Pool of GPU-visible memory that can be allocated from.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Alloc' class='method'><code id='Alloc.t'>type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/memory/pool/trait.MemoryPoolAlloc.html" title="trait vulkano::memory::pool::MemoryPoolAlloc">MemoryPoolAlloc</a></code></h3><div class='docblock'><p>Object that represents a single allocation. Its destructor should free the chunk.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.alloc_generic' class='method'><code id='alloc_generic.v'>fn <a href='#tymethod.alloc_generic' class='fnname'>alloc_generic</a>(<br> &self, <br> ty: <a class="struct" href="../../../vulkano/instance/struct.MemoryType.html" title="struct vulkano::instance::MemoryType">MemoryType</a>, <br> size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> alignment: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> layout: <a class="enum" href="../../../vulkano/memory/pool/enum.AllocLayout.html" title="enum vulkano::memory::pool::AllocLayout">AllocLayout</a>, <br> map: <a class="enum" href="../../../vulkano/memory/pool/enum.MappingRequirement.html" title="enum vulkano::memory::pool::MappingRequirement">MappingRequirement</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../vulkano/memory/pool/trait.MemoryPool.html#associatedtype.Alloc" title="type vulkano::memory::pool::MemoryPool::Alloc">Alloc</a>, <a class="enum" href="../../../vulkano/memory/enum.DeviceMemoryAllocError.html" title="enum vulkano::memory::DeviceMemoryAllocError">DeviceMemoryAllocError</a>></code></h3><div class='docblock'><p>Allocates memory from the pool.</p>
|
|
|
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
|
|
|
<p>Implementation safety:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>The returned object must match the requirements.</li>
|
|
|
|
|
|
<li>When a linear object is allocated next to an optimal object, it is mandatory that
|
|
|
|
|
|
the boundary is aligned to the value of the <code>buffer_image_granularity</code> limit.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>Note that it is not unsafe to <em>call</em> this function, but it is unsafe to bind the memory
|
|
|
|
|
|
returned by this function to a resource.</p>
|
|
|
|
|
|
<h1 id="panic" class="section-header"><a href="#panic">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if <code>memory_type</code> doesn't belong to the same physical device as the device which
|
|
|
|
|
|
was used to create this pool.</li>
|
|
|
|
|
|
<li>Panics if the memory type is not host-visible and <code>map</code> is <code>MappingRequirement::Map</code>.</li>
|
|
|
|
|
|
<li>Panics if <code>size</code> is 0.</li>
|
|
|
|
|
|
<li>Panics if <code>alignment</code> is 0.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.alloc_from_requirements' class='method'><code id='alloc_from_requirements.v'>fn <a href='#method.alloc_from_requirements' class='fnname'>alloc_from_requirements</a><F>(<br> &self, <br> requirements: &<a class="struct" href="../../../vulkano/memory/struct.MemoryRequirements.html" title="struct vulkano::memory::MemoryRequirements">MemoryRequirements</a>, <br> layout: <a class="enum" href="../../../vulkano/memory/pool/enum.AllocLayout.html" title="enum vulkano::memory::pool::AllocLayout">AllocLayout</a>, <br> map: <a class="enum" href="../../../vulkano/memory/pool/enum.MappingRequirement.html" title="enum vulkano::memory::pool::MappingRequirement">MappingRequirement</a>, <br> dedicated: <a class="enum" href="../../../vulkano/memory/enum.DedicatedAlloc.html" title="enum vulkano::memory::DedicatedAlloc">DedicatedAlloc</a>, <br> filter: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../../vulkano/memory/pool/enum.PotentialDedicatedAllocation.html" title="enum vulkano::memory::pool::PotentialDedicatedAllocation">PotentialDedicatedAllocation</a><Self::<a class="type" href="../../../vulkano/memory/pool/trait.MemoryPool.html#associatedtype.Alloc" title="type vulkano::memory::pool::MemoryPool::Alloc">Alloc</a>>, <a class="enum" href="../../../vulkano/memory/enum.DeviceMemoryAllocError.html" title="enum vulkano::memory::DeviceMemoryAllocError">DeviceMemoryAllocError</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../../vulkano/instance/struct.MemoryType.html" title="struct vulkano::instance::MemoryType">MemoryType</a>) -> <a class="enum" href="../../../vulkano/memory/pool/enum.AllocFromRequirementsFilter.html" title="enum vulkano::memory::pool::AllocFromRequirementsFilter">AllocFromRequirementsFilter</a>, </span></code></h3><div class='docblock'><p>Chooses a memory type and allocates memory from it.</p>
|
|
|
|
|
|
<p>Contrary to <code>alloc_generic</code>, this function may allocate a whole new block of memory
|
|
|
|
|
|
dedicated to a resource based on <code>requirements.prefer_dedicated</code>.</p>
|
|
|
|
|
|
<p><code>filter</code> can be used to restrict the memory types and to indicate which are preferred.
|
|
|
|
|
|
If <code>map</code> is <code>MappingRequirement::Map</code>, then non-host-visible memory types will
|
|
|
|
|
|
automatically be filtered out.</p>
|
|
|
|
|
|
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
|
|
|
|
|
<p>Implementation safety:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>The returned object must match the requirements.</li>
|
|
|
|
|
|
<li>When a linear object is allocated next to an optimal object, it is mandatory that
|
|
|
|
|
|
the boundary is aligned to the value of the <code>buffer_image_granularity</code> limit.</li>
|
|
|
|
|
|
<li>If <code>dedicated</code> is not <code>None</code>, the returned memory must either not be dedicated or be
|
|
|
|
|
|
dedicated to the resource that was passed.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>Note that it is not unsafe to <em>call</em> this function, but it is unsafe to bind the memory
|
|
|
|
|
|
returned by this function to a resource.</p>
|
|
|
|
|
|
<h1 id="panic-1" class="section-header"><a href="#panic-1">Panic</a></h1>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Panics if no memory type could be found, which can happen if <code>filter</code> is too restrictive.</li>
|
|
|
|
|
|
<li>Panics if <code>size</code> is 0.</li>
|
|
|
|
|
|
<li>Panics if <code>alignment</code> is 0.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-MemoryPool-for-Arc%3CStdMemoryPool%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../vulkano/memory/pool/trait.MemoryPool.html" title="trait vulkano::memory::pool::MemoryPool">MemoryPool</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/memory/pool/struct.StdMemoryPool.html" title="struct vulkano::memory::pool::StdMemoryPool">StdMemoryPool</a>></code><a href='#impl-MemoryPool-for-Arc%3CStdMemoryPool%3E' class='anchor'></a><a class='srclink' href='../../../src/vulkano/memory/pool/pool.rs.html#55-112' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Alloc-1' class="type"><code id='Alloc.t-1'>type <a href='#associatedtype.Alloc' class="type">Alloc</a> = <a class="struct" href="../../../vulkano/memory/pool/struct.StdMemoryPoolAlloc.html" title="struct vulkano::memory::pool::StdMemoryPoolAlloc">StdMemoryPoolAlloc</a></code></h4><h4 id='method.alloc_generic' class="method hidden"><code id='alloc_generic.v-1'>fn <a href='#method.alloc_generic' class='fnname'>alloc_generic</a>(<br> &self, <br> memory_type: <a class="struct" href="../../../vulkano/instance/struct.MemoryType.html" title="struct vulkano::instance::MemoryType">MemoryType</a>, <br> size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> alignment: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> layout: <a class="enum" href="../../../vulkano/memory/pool/enum.AllocLayout.html" title="enum vulkano::memory::pool::AllocLayout">AllocLayout</a>, <br> map: <a class="enum" href="../../../vulkano/memory/pool/enum.MappingRequirement.html" title="enum vulkano::memory::pool::MappingRequirement">MappingRequirement</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../../vulkano/memory/pool/struct.StdMemoryPoolAlloc.html" title="struct vulkano::memory::pool::StdMemoryPoolAlloc">StdMemoryPoolAlloc</a>, <a class="enum" href="../../../vulkano/memory/enum.DeviceMemoryAllocError.html" title="enum vulkano::memory::DeviceMemoryAllocError">DeviceMemoryAllocError</a>></code><a class='srclink' href='../../../src/vulkano/memory/pool/pool.rs.html#58-111' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../../implementors/vulkano/memory/pool/trait.MemoryPool.js">
|
|
|
|
|
|
</script></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>⏎</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 = "vulkano";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
