17 lines
6.8 KiB
HTML
17 lines
6.8 KiB
HTML
<!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="Library for Vulkan-like APIs to allocated descriptor sets from descriptor pools fast, with least overhead and zero fragmentation."><title>gpu_descriptor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="gpu_descriptor" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../gpu_descriptor/index.html">gpu_<wbr>descriptor</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>gpu_descriptor</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/gpu_descriptor/lib.rs.html#1-35">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Library for Vulkan-like APIs to allocated descriptor sets
|
|
from descriptor pools fast, with least overhead and zero fragmentation.</p>
|
|
<p>Straightforward usage:</p>
|
|
|
|
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gpu_descriptor::DescriptorAllocator;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>allocator = DescriptorAllocator::new(max_update_after_bind_descriptors_in_all_pools); <span class="comment">// Limit as dictated by API for selected hardware
|
|
|
|
</span><span class="kw">let </span>result = allocator.allocate(
|
|
device, <span class="comment">// Implementation of `gpu_descriptor::DescriptorDevice`. Comes from plugins.
|
|
</span>layout, <span class="comment">// Descriptor set layout recognized by device's type.
|
|
</span>flags, <span class="comment">// Flags specified when layout was created.
|
|
</span>layout_descriptor_count, <span class="comment">// Descriptors count in the layout.
|
|
</span>count, <span class="comment">// count of sets to allocated.
|
|
</span>);</code></pre></div>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.DescriptorAllocator.html" title="struct gpu_descriptor::DescriptorAllocator">Descriptor<wbr>Allocator</a></div><div class="desc docblock-short">Descriptor allocator.
|
|
Can be used to allocate descriptor sets for any layout.</div></li><li><div class="item-name"><a class="struct" href="struct.DescriptorPoolCreateFlags.html" title="struct gpu_descriptor::DescriptorPoolCreateFlags">Descriptor<wbr>Pool<wbr>Create<wbr>Flags</a></div><div class="desc docblock-short">Flags to augment descriptor pool creation.</div></li><li><div class="item-name"><a class="struct" href="struct.DescriptorSet.html" title="struct gpu_descriptor::DescriptorSet">Descriptor<wbr>Set</a></div><div class="desc docblock-short">Descriptor set from allocator.</div></li><li><div class="item-name"><a class="struct" href="struct.DescriptorSetLayoutCreateFlags.html" title="struct gpu_descriptor::DescriptorSetLayoutCreateFlags">Descriptor<wbr>SetLayout<wbr>Create<wbr>Flags</a></div><div class="desc docblock-short">Flags to augment descriptor set allocation.</div></li><li><div class="item-name"><a class="struct" href="struct.DescriptorTotalCount.html" title="struct gpu_descriptor::DescriptorTotalCount">Descriptor<wbr>Total<wbr>Count</a></div><div class="desc docblock-short">Number of descriptors of each type.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AllocationError.html" title="enum gpu_descriptor::AllocationError">Allocation<wbr>Error</a></div><div class="desc docblock-short">AllocationError that may occur during descriptor sets allocation.</div></li><li><div class="item-name"><a class="enum" href="enum.CreatePoolError.html" title="enum gpu_descriptor::CreatePoolError">Create<wbr>Pool<wbr>Error</a></div><div class="desc docblock-short">Memory exhausted error.</div></li><li><div class="item-name"><a class="enum" href="enum.DeviceAllocationError.html" title="enum gpu_descriptor::DeviceAllocationError">Device<wbr>Allocation<wbr>Error</a></div><div class="desc docblock-short">Memory exhausted error.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.DescriptorDevice.html" title="trait gpu_descriptor::DescriptorDevice">Descriptor<wbr>Device</a></div><div class="desc docblock-short">Abstract device that can create pools of type <code>P</code> and allocate sets <code>S</code> with layout <code>L</code>.</div></li></ul></section></div></main></body></html> |