30 lines
16 KiB
HTML
30 lines
16 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="Vulkan API"><title>ash - 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="ash" 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="../ash/index.html">ash</a><span class="version">0.38.0+1.3.281</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="#">Sections</a></h3><ul class="block top-toc"><li><a href="#vulkan-api" title="Vulkan API">Vulkan API</a><ul><li><a href="#examples" title="Examples">Examples</a></li><li><a href="#getting-started" title="Getting started">Getting started</a></li><li><a href="#crate-features" title="Crate features">Crate features</a></li></ul></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><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>ash</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/ash/lib.rs.html#1-216">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="vulkan-api"><a class="doc-anchor" href="#vulkan-api">§</a>Vulkan API</h2>
|
|
<p><a href="https://registry.khronos.org/vulkan/specs/1.3-extensions/html/index.html">https://registry.khronos.org/vulkan/specs/1.3-extensions/html/index.html</a></p>
|
|
<h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ash::{vk, Entry};
|
|
<span class="kw">let </span>entry = Entry::linked();
|
|
<span class="kw">let </span>app_info = vk::ApplicationInfo {
|
|
api_version: vk::make_api_version(<span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>),
|
|
..Default::default()
|
|
};
|
|
<span class="kw">let </span>create_info = vk::InstanceCreateInfo {
|
|
p_application_info: <span class="kw-2">&</span>app_info,
|
|
..Default::default()
|
|
};
|
|
<span class="kw">let </span>instance = <span class="kw">unsafe </span>{ entry.create_instance(<span class="kw-2">&</span>create_info, <span class="prelude-val">None</span>)<span class="question-mark">? </span>};</code></pre></div>
|
|
<h3 id="getting-started"><a class="doc-anchor" href="#getting-started">§</a>Getting started</h3>
|
|
<p>Load the Vulkan library linked at compile time using [<code>Entry::linked()</code>], or load it at runtime
|
|
using <a href="struct.Entry.html#method.load" title="associated function ash::Entry::load"><code>Entry::load()</code></a>, which uses <code>libloading</code>. If you want to perform entry point loading
|
|
yourself, call <a href="struct.Entry.html#method.from_static_fn" title="associated function ash::Entry::from_static_fn"><code>Entry::from_static_fn()</code></a>.</p>
|
|
<h3 id="crate-features"><a class="doc-anchor" href="#crate-features">§</a>Crate features</h3>
|
|
<ul>
|
|
<li><strong>debug</strong> (default): Whether Vulkan structs should implement <code>Debug</code>.</li>
|
|
<li><strong>loaded</strong> (default): Support searching for the Vulkan loader manually at runtime.</li>
|
|
<li><strong>linked</strong>: Link the Vulkan loader at compile time.</li>
|
|
<li><strong>std</strong> (default): Whether ash depends on the standard library (otherwise <code>alloc</code> is required)</li>
|
|
</ul>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="amd/index.html" title="mod ash::amd">amd</a></div><div class="desc docblock-short">Extensions tagged AMD</div></li><li><div class="item-name"><a class="mod" href="amdx/index.html" title="mod ash::amdx">amdx</a></div><div class="desc docblock-short">Extensions tagged AMDX</div></li><li><div class="item-name"><a class="mod" href="android/index.html" title="mod ash::android">android</a></div><div class="desc docblock-short">Extensions tagged ANDROID</div></li><li><div class="item-name"><a class="mod" href="arm/index.html" title="mod ash::arm">arm</a></div><div class="desc docblock-short">Extensions tagged ARM</div></li><li><div class="item-name"><a class="mod" href="ext/index.html" title="mod ash::ext">ext</a></div><div class="desc docblock-short">Extensions tagged EXT</div></li><li><div class="item-name"><a class="mod" href="fuchsia/index.html" title="mod ash::fuchsia">fuchsia</a></div><div class="desc docblock-short">Extensions tagged FUCHSIA</div></li><li><div class="item-name"><a class="mod" href="ggp/index.html" title="mod ash::ggp">ggp</a></div><div class="desc docblock-short">Extensions tagged GGP</div></li><li><div class="item-name"><a class="mod" href="google/index.html" title="mod ash::google">google</a></div><div class="desc docblock-short">Extensions tagged GOOGLE</div></li><li><div class="item-name"><a class="mod" href="huawei/index.html" title="mod ash::huawei">huawei</a></div><div class="desc docblock-short">Extensions tagged HUAWEI</div></li><li><div class="item-name"><a class="mod" href="img/index.html" title="mod ash::img">img</a></div><div class="desc docblock-short">Extensions tagged IMG</div></li><li><div class="item-name"><a class="mod" href="intel/index.html" title="mod ash::intel">intel</a></div><div class="desc docblock-short">Extensions tagged INTEL</div></li><li><div class="item-name"><a class="mod" href="khr/index.html" title="mod ash::khr">khr</a></div><div class="desc docblock-short">Extensions tagged KHR</div></li><li><div class="item-name"><a class="mod" href="lunarg/index.html" title="mod ash::lunarg">lunarg</a></div><div class="desc docblock-short">Extensions tagged LUNARG</div></li><li><div class="item-name"><a class="mod" href="msft/index.html" title="mod ash::msft">msft</a></div><div class="desc docblock-short">Extensions tagged MSFT</div></li><li><div class="item-name"><a class="mod" href="mvk/index.html" title="mod ash::mvk">mvk</a></div><div class="desc docblock-short">Extensions tagged MVK</div></li><li><div class="item-name"><a class="mod" href="nn/index.html" title="mod ash::nn">nn</a></div><div class="desc docblock-short">Extensions tagged NN</div></li><li><div class="item-name"><a class="mod" href="nv/index.html" title="mod ash::nv">nv</a></div><div class="desc docblock-short">Extensions tagged NV</div></li><li><div class="item-name"><a class="mod" href="nvx/index.html" title="mod ash::nvx">nvx</a></div><div class="desc docblock-short">Extensions tagged NVX</div></li><li><div class="item-name"><a class="mod" href="prelude/index.html" title="mod ash::prelude">prelude</a></div></li><li><div class="item-name"><a class="mod" href="qcom/index.html" title="mod ash::qcom">qcom</a></div><div class="desc docblock-short">Extensions tagged QCOM</div></li><li><div class="item-name"><a class="mod" href="qnx/index.html" title="mod ash::qnx">qnx</a></div><div class="desc docblock-short">Extensions tagged QNX</div></li><li><div class="item-name"><a class="mod" href="sec/index.html" title="mod ash::sec">sec</a></div><div class="desc docblock-short">Extensions tagged SEC</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod ash::util">util</a></div></li><li><div class="item-name"><a class="mod" href="valve/index.html" title="mod ash::valve">valve</a></div><div class="desc docblock-short">Extensions tagged VALVE</div></li><li><div class="item-name"><a class="mod" href="vk/index.html" title="mod ash::vk">vk</a></div><div class="desc docblock-short">Raw Vulkan bindings and types, generated from <code>vk.xml</code></div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.define_handle.html" title="macro ash::define_handle">define_<wbr>handle</a></div></li><li><div class="item-name"><a class="macro" href="macro.handle_nondispatchable.html" title="macro ash::handle_nondispatchable">handle_<wbr>nondispatchable</a></div></li><li><div class="item-name"><a class="macro" href="macro.match_in_struct.html" title="macro ash::match_in_struct">match_<wbr>in_<wbr>struct</a></div><div class="desc docblock-short">Given an immutable raw pointer to a type with an <code>s_type</code> member such as <a href="vk/struct.BaseInStructure.html" title="struct ash::vk::BaseInStructure"><code>vk::BaseInStructure</code></a>,
|
|
match on a set of Vulkan structures. The struct will be rebound to the given variable of the
|
|
type of the given Vulkan structure.</div></li><li><div class="item-name"><a class="macro" href="macro.match_out_struct.html" title="macro ash::match_out_struct">match_<wbr>out_<wbr>struct</a></div><div class="desc docblock-short">Given a mutable raw pointer to a type with an <code>s_type</code> member such as <a href="vk/struct.BaseOutStructure.html" title="struct ash::vk::BaseOutStructure"><code>vk::BaseOutStructure</code></a>,
|
|
match on a set of Vulkan structures. The struct will be rebound to the given variable of the
|
|
type of the given Vulkan structure.</div></li><li><div class="item-name"><a class="macro" href="macro.vk_bitflags_wrapped.html" title="macro ash::vk_bitflags_wrapped">vk_<wbr>bitflags_<wbr>wrapped</a></div></li></ul><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.Device.html" title="struct ash::Device">Device</a></div><div class="desc docblock-short"><a href="https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDevice.html">https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDevice.html</a></div></li><li><div class="item-name"><a class="struct" href="struct.DeviceFnV1_0.html" title="struct ash::DeviceFnV1_0">Device<wbr>FnV1_<wbr>0</a></div><div class="desc docblock-short">Raw Vulkan 1 device-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.DeviceFnV1_1.html" title="struct ash::DeviceFnV1_1">Device<wbr>FnV1_<wbr>1</a></div><div class="desc docblock-short">Raw Vulkan 1.1 device-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.DeviceFnV1_2.html" title="struct ash::DeviceFnV1_2">Device<wbr>FnV1_<wbr>2</a></div><div class="desc docblock-short">Raw Vulkan 1.2 device-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.DeviceFnV1_3.html" title="struct ash::DeviceFnV1_3">Device<wbr>FnV1_<wbr>3</a></div><div class="desc docblock-short">Raw Vulkan 1.3 device-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.Entry.html" title="struct ash::Entry">Entry</a></div><div class="desc docblock-short">Holds the Vulkan functions independent of a particular instance</div></li><li><div class="item-name"><a class="struct" href="struct.EntryFnV1_0.html" title="struct ash::EntryFnV1_0">Entry<wbr>FnV1_<wbr>0</a></div><div class="desc docblock-short">Raw Vulkan 1 entry point function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.EntryFnV1_1.html" title="struct ash::EntryFnV1_1">Entry<wbr>FnV1_<wbr>1</a></div><div class="desc docblock-short">Raw Vulkan 1.1 entry point function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.EntryFnV1_2.html" title="struct ash::EntryFnV1_2">Entry<wbr>FnV1_<wbr>2</a></div><div class="desc docblock-short">Raw Vulkan 1.2 entry point function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.EntryFnV1_3.html" title="struct ash::EntryFnV1_3">Entry<wbr>FnV1_<wbr>3</a></div><div class="desc docblock-short">Raw Vulkan 1.3 entry point function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.Instance.html" title="struct ash::Instance">Instance</a></div><div class="desc docblock-short"><a href="https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkInstance.html">https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkInstance.html</a></div></li><li><div class="item-name"><a class="struct" href="struct.InstanceFnV1_0.html" title="struct ash::InstanceFnV1_0">Instance<wbr>FnV1_<wbr>0</a></div><div class="desc docblock-short">Raw Vulkan 1 instance-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.InstanceFnV1_1.html" title="struct ash::InstanceFnV1_1">Instance<wbr>FnV1_<wbr>1</a></div><div class="desc docblock-short">Raw Vulkan 1.1 instance-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.InstanceFnV1_2.html" title="struct ash::InstanceFnV1_2">Instance<wbr>FnV1_<wbr>2</a></div><div class="desc docblock-short">Raw Vulkan 1.2 instance-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.InstanceFnV1_3.html" title="struct ash::InstanceFnV1_3">Instance<wbr>FnV1_<wbr>3</a></div><div class="desc docblock-short">Raw Vulkan 1.3 instance-level function pointers</div></li><li><div class="item-name"><a class="struct" href="struct.StaticFn.html" title="struct ash::StaticFn">Static<wbr>Fn</a></div><div class="desc docblock-short">Raw Vulkan 1 static function pointers</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.LoadingError.html" title="enum ash::LoadingError">Loading<wbr>Error</a></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.RawPtr.html" title="trait ash::RawPtr">RawPtr</a></div></li></ul></section></div></main></body></html> |