vulkano - Rust

<!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="Safe and rich Rust wrapper around the Vulkan API."><title>vulkano - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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="/-/rustdoc.static/${f}">`).join(""))</script><link rel="stylesheet" href="/-/rustdoc.static/normalize-9960930a.css"><link rel="stylesheet" href="/-/static/vendored.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /><link rel="stylesheet" href="/-/rustdoc.static/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="/-/rustdoc.static/" data-current-crate="vulkano" data-themes="" data-resource-suffix="-20250328-1.87.0-nightly-920d95eaf" data-rustdoc-version="1.87.0-nightly (920d95eaf 2025-03-28)" data-channel="nightly" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="/-/rustdoc.static/storage-82c7156e.js"></script><script defer src="../crates-20250328-1.87.0-nightly-920d95eaf.js"></script><script defer src="/-/rustdoc.static/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="/-/rustdoc.static/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="/-/rustdoc.static/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="/-/rustdoc.static/favicon-044be391.svg"><link rel="stylesheet" href="/-/static/rustdoc-2021-12-05.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /><link rel="stylesheet" href="/-/static/font-awesome.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /> <link rel="search" href="/-/static/opensearch.xml" type="application/opensearchdescription+xml" title="Docs.rs" /> <script type="text/javascript">(function() { function applyTheme(theme) { if (theme) { document.documentElement.dataset.docsRsTheme = theme; } } window.addEventListener("storage", ev => { if (ev.key === "rustdoc-theme") { applyTheme(ev.newValue); } }); // see ./storage-change-detection.html for details window.addEventListener("message", ev => { if (ev.data && ev.data.storage && ev.data.storage.key === "rustdoc-theme") { applyTheme(ev.data.storage.value); } }); applyTheme(window.localStorage.getItem("rustdoc-theme")); })();</script></head><body class="rustdoc-page"> <div class="nav-container"> <div class="container"> <div class="pure-menu pure-menu-horizontal" role="navigation" aria-label="Main navigation"> <form action="/releases/search" method="GET" id="nav-search-form" class="landing-search-form-nav "> <a href="/" class="pure-menu-heading pure-menu-link docsrs-logo" aria-label="Docs.rs"> <span title="Docs.rs"><span class="fa fa-solid fa-cubes " aria-hidden="true"></span></span> <span class="title">Docs.rs</span> </a><ul class="pure-menu-list"> <script id="crate-metadata" type="application/json"> { "name": "vulkano", "version": "0.35.1" } </script><li class="pure-menu-item pure-menu-has-children"> <a href="#" class="pure-menu-link crate-name" title="Safe wrapper for the Vulkan graphics API"> <span class="fa fa-solid fa-cube " aria-hidden="true"></span> <span class="title">vulkano-0.35.1</span> </a><div class="pure-menu-children package-details-menu"> <ul class="pure-menu-list menu-item-divided"> <li class="pure-menu-heading" id="crate-title"> vulkano 0.35.1 <span id="clipboard" class="svg-clipboard" title="Copy crate name and version information"></span> </li><li class="pure-menu-item"> <a href="/vulkano/0.35.1/vulkano/index.html" class="pure-menu-link description" id="permalink" title="Get a link to this specific version"> <span class="fa fa-solid fa-link " aria-hidden="true"></span> Permalink </a> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest" class="pure-menu-link description" title="See vulkano in docs.rs"> <span class="fa fa-solid fa-cube " aria-hidden="true"></span> Docs.rs crate page </a> </li><li class="pure-menu-item"> <span class="pure-menu-link description"><span class="fa fa-solid fa-scale-unbalanced-flip " aria-hidden="true"></span> <a href="https://spdx.org/licenses/MIT" class="pure-menu-sublink">MIT</a> OR <a href="https://spdx.org/licenses/Apache-2.0" class="pure-menu-sublink">Apache-2.0</a></span> </li></ul> <div class="pure-g menu-item-divided"> <div class="pure-u-1-2 right-border"> <ul class="pure-menu-list"> <li class="pure-menu-heading">Links</li> <li class="pure-menu-item"> <a href="https://vulkano.rs" class="pure-menu-link"> <span class="fa fa-solid fa-house " aria-hidden="true"></span> Homepage </a> </li><li class="pure-menu-item"> <a href="https://github.com/vulkano-rs/vulkano/tree/master/vulkano" class="pure-menu-link"> <span class="fa fa-solid fa-code-branch " aria-hidden="true"></span> Repository </a> </li><li class="pure-menu-item"> <a href="https://crates.io/crates/vulkano" class="pure-menu-link" title="See vulkano in crates.io"> <span class="fa fa-solid fa-cube " aria-hidden="true"></span> crates.io </a> </li> <li class="pure-menu-item"> <a href="/crate/vulkano/latest/source/" title="Browse source of vulkano-0.35.1" class="pure-menu-link"> <span class="fa fa-solid fa-folder-open " aria-hidden="true"></span> Source </a> </li> </ul> </div><div class="pure-u-1-2"> <ul class="pure-menu-list" id="topbar-owners"> <li class="pure-menu-heading">Owners</li><li class="pure-menu-item"> <a href="https://crates.io/users/tomaka" class="pure-menu-link"> <span class="fa fa-solid fa-user " aria-hidden="true"></span> tomaka </a> </li><li class="pure-menu-item"> <a href="https://crates.io/users/AustinJ235" class="pure-menu-link"> <span class="fa fa-solid fa-user " aria-hidden="true"></span> AustinJ235 </a> </li><li class="pure-menu-item"> <a href="https://crates.io/teams/github:vulkano-rs:publishers" class="pure-menu-link"> <span class="fa fa-solid fa-user " aria-hidden="true"></span> github:vulkano-rs:publishers </a> </li><li class="pure-menu-item"> <a href="https://crates.io/users/marc0246" class="pure-menu-link"> <span class="fa fa-solid fa-user " aria-hidden="true"></span> marc0246 </a> </li><li class="pure-menu-item"> <a href="https://crates.io/users/Rua" class="pure-menu-link"> <span class="fa fa-solid fa-user " aria-hidden="true"></span> Rua </a> </li></ul> </div> </div> <div class="pure-g menu-item-divided"> <div class="pure-u-1-2 right-border"> <ul class="pure-menu-list"> <li class="pure-menu-heading">Dependencies</li> <li class="pure-menu-item"> <div class="pure-menu pure-menu-scrollable sub-menu" tabindex="-1"> <ul class="pure-menu-list"> <li class="pure-menu-item"><a href="/ash/^0.38.0" class="pure-menu-link"> ash ^0.38.0 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/bytemuck/^1.9" class="pure-menu-link"> bytemuck ^1.9 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/crossbeam-queue/^0.3" class="pure-menu-link"> crossbeam-queue ^0.3 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/foldhash/^0.1" class="pure-menu-link"> foldhash ^0.1 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/half/^2.0" class="pure-menu-link"> half ^2.0 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/libloading/^0.8" class="pure-menu-link"> libloading ^0.8 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/once_cell/^1.17" class="pure-menu-link"> once_cell ^1.17 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/parking_lot/^0.12" class="pure-menu-link"> parking_lot ^0.12 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/raw-window-handle/^0.6" class="pure-menu-link"> raw-window-handle ^0.6 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/serde/^1.0" class="pure-menu-link"> serde ^1.0 <i class="dependencies normal">normal</i> <i>optional</i> </a> </li> <li class="pure-menu-item"><a href="/slabbin/^1.1" class="pure-menu-link"> slabbin ^1.1 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/smallvec/^1.8" class="pure-menu-link"> smallvec ^1.8 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/thread_local/^1.1" class="pure-menu-link"> thread_local ^1.1 <i class="dependencies normal">normal</i> </a> </li> <li class="pure-menu-item"><a href="/vulkano-macros/^0.35" class="pure-menu-link"> vulkano-macros ^0.35 <i class="dependencies normal">normal</i> <i>optional</i> </a> </li> <li class="pure-menu-item"><a href="/libc/^0.2.153" class="pure-menu-link"> libc ^0.2.153 <i class="dependencies dev">dev</i> </a> </li> <li class="pure-menu-item"><a href="/foldhash/^0.1" class="pure-menu-link"> foldhash ^0.1 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/heck/^0.4" class="pure-menu-link"> heck ^0.4 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/indexmap/^2.0" class="pure-menu-link"> indexmap ^2.0 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/nom/^7.1" class="pure-menu-link"> nom ^7.1 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/once_cell/^1.17" class="pure-menu-link"> once_cell ^1.17 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/proc-macro2/^1.0" class="pure-menu-link"> proc-macro2 ^1.0 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/quote/^1.0" class="pure-menu-link"> quote ^1.0 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/serde/^1.0" class="pure-menu-link"> serde ^1.0 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/serde_json/^1.0" class="pure-menu-link"> serde_json ^1.0 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/vk-parse/^0.15" class="pure-menu-link"> vk-parse ^0.15 <i class="dependencies build">build</i> </a> </li> <li class="pure-menu-item"><a href="/x11-dl/^2.0" class="pure-menu-link"> x11-dl ^2.0 <i class="dependencies normal">normal</i> <i>optional</i> </a> </li> <li class="pure-menu-item"><a href="/x11rb/^0.13" class="pure-menu-link"> x11rb ^0.13 <i class="dependencies normal">normal</i> <i>optional</i> </a> </li> <li class="pure-menu-item"><a href="/raw-window-metal/^1.0" class="pure-menu-link"> raw-window-metal ^1.0 <i class="dependencies normal">normal</i> </a> </li> </ul> </div> </li> </ul> </div> <div class="pure-u-1-2"> <ul class="pure-menu-list"> <li class="pure-menu-heading">Versions</li> <li class="pure-menu-item"> <div class="pure-menu pure-menu-scrollable sub-menu" id="releases-list" tabindex="-1" data-url="/crate/vulkano/latest/menus/releases/x86_64-unknown-linux-gnu/vulkano/index.html"> <span class="rotate"><span class="fa fa-solid fa-spinner " aria-hidden="true"></span></span> </div> </li> </ul> </div> </div> <div class="pure-g"> <div class="pure-u-1"> <ul class="pure-menu-list"> <li> <a href="/crate/vulkano/latest" class="pure-menu-link"> <b>100%</b> of the crate is documented </a> </li> </ul> </div> </div></div> </li><li class="pure-menu-item pure-menu-has-children"> <a href="#" class="pure-menu-link" aria-label="Platform"> <span class="fa fa-solid fa-gears " aria-hidden="true"></span> <span class="title">Platform</span> </a> <ul class="pure-menu-children" id="platforms" data-url="/crate/vulkano/latest/menus/platforms/x86_64-unknown-linux-gnu/vulkano/index.html"><li class="pure-menu-item"> <a href="/crate/vulkano/latest/target-redirect/i686-pc-windows-msvc/vulkano/index.html" class="pure-menu-link" data-fragment="retain" rel="nofollow">i686-pc-windows-msvc</a> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest/target-redirect/i686-unknown-linux-gnu/vulkano/index.html" class="pure-menu-link" data-fragment="retain" rel="nofollow">i686-unknown-linux-gnu</a> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest/target-redirect/x86_64-apple-darwin/vulkano/index.html" class="pure-menu-link" data-fragment="retain" rel="nofollow">x86_64-apple-darwin</a> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest/target-redirect/x86_64-pc-windows-msvc/vulkano/index.html" class="pure-menu-link" data-fragment="retain" rel="nofollow">x86_64-pc-windows-msvc</a> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest/target-redirect/x86_64-unknown-linux-gnu/vulkano/index.html" class="pure-menu-link current" data-fragment="retain" rel="nofollow">x86_64-unknown-linux-gnu</a> </li></ul> </li><li class="pure-menu-item"> <a href="/crate/vulkano/latest/features" title="Browse available feature flags of vulkano-0.35.1" class="pure-menu-link"> <span class="fa fa-solid fa-flag " aria-hidden="true"></span> <span class="title">Feature flags</span> </a> </li> </ul><div class="spacer"></div> <ul class="pure-menu-list"> <li class="pure-menu-item pure-menu-has-children"> <a href="#" class="pure-menu-link" aria-label="Rust">Rust</a> <ul class="pure-menu-children"> <li class="pure-menu-item"> <a class="pure-menu-link" href="/about" > About docs.rs </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs" target="_blank"> Privacy policy </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://www.rust-lang.org/" target="_blank"> Rust website </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/book/" target="_blank"> The Book </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/std/" target="_blank"> Standard Library API Reference </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/rust-by-example/" target="_blank"> Rust by Example </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/cargo/guide/" target="_blank"> The Cargo Guide </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/nightly/clippy" target="_blank"> Clippy Documentation </a> </li> </ul> </li> </ul> <div id="search-input-nav"> <label for="nav-search"> <span class="fa fa-solid fa-magnifying-glass " aria-hidden="true"></span> </label> <input id="nav-search" name="query" type="text" aria-label="Find crate by search query" tabindex="-1" placeholder="Find crate" > </div> </form> </div> </div> </div><div class="rustdoc mod crate container-rustdoc" id="rustdoc_body_wrapper" tabindex="-1"><script async src="/-/static/menu.js?0-6-0-ee9a3fe6-2025-03-28"></script> <script async src="/-/static/index.js?0-6-0-ee9a3fe6-2025-03-28"></script> <iframe src="/-/storage-change-detection.html" width="0" height="0" style="display: none"></iframe><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../vulkano/index.html"><img src="https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../vulkano/index.html"><img src="https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png" alt="logo"></a><h2><a href="../vulkano/index.html">vulkano</a><span class="version">0.35.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="#">Sections</a></h3><ul class="block top-toc"><li><a href="#starting-off-with-vulkano" title="Starting off with Vulkano">Starting off with Vulkano</a></li><li><a href="#_unchecked-functions" title="`_unchecked` functions"><code>_unchecked</code> functions</a></li><li><a href="#cargo-features" title="Cargo features">Cargo features</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><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><li><a href="#types" title="Type Aliases">Type Aliases</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>vulkano</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/vulkano/lib.rs.html#1-693">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Safe and rich Rust wrapper around the Vulkan API.</p> <h2 id="starting-off-with-vulkano"><a class="doc-anchor" href="#starting-off-with-vulkano">搂</a>Starting off with Vulkano</h2> <p>The steps for using Vulkan through Vulkano are in principle not any different from using the raw Vulkan API, but the details may be different for the sake of idiomaticity, safety and convenience.</p> <ol> <li> <p>Create a <a href="library/struct.VulkanLibrary.html" title="struct vulkano::library::VulkanLibrary"><code>VulkanLibrary</code></a>. This represents a Vulkan library on the system, which must be loaded before you can do anything with Vulkan.</p> </li> <li> <p>Create an <a href="instance/struct.Instance.html" title="struct vulkano::instance::Instance"><code>Instance</code></a>. This is the API entry point, and represents an initialised Vulkan library.</p> </li> <li> <p>If you intend to show graphics to the user on a window or a screen, create a <a href="swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface"><code>Surface</code></a>. A <code>Surface</code> is created from a window identifier or handle, that is specific to the display or windowing system being used. Vulkano uses <code>raw-window-handle</code> to abstract over the different windowing systems. Note that you have to make sure that the <code>raw-window-handle</code> that your windowing library uses is compatible with the <code>raw-window-handle</code> that vulkano uses. For example, if you use a <code>winit</code> version that uses a different version from the one vulkano uses, you can add one of the <a href="https://docs.rs/crate/winit/latest/features">features</a> that starts with <code>rwh</code> to <code>winit</code>. Currently, vulkano is compatible with <code>rwh_06</code>.</p> </li> <li> <p><a href="instance/struct.Instance.html#method.enumerate_physical_devices" title="method vulkano::instance::Instance::enumerate_physical_devices">Enumerate the physical devices</a> that are available on the <code>Instance</code>, and choose one that is suitable for your program. A <a href="device/physical/struct.PhysicalDevice.html" title="struct vulkano::device::physical::PhysicalDevice"><code>PhysicalDevice</code></a> represents a Vulkan-capable device that is available on the system, such as a graphics card, a software implementation, etc.</p> </li> <li> <p>Create a <a href="device/struct.Device.html" title="struct vulkano::device::Device"><code>Device</code></a> and accompanying <a href="device/struct.Queue.html" title="struct vulkano::device::Queue"><code>Queue</code></a>s from the selected <code>PhysicalDevice</code>. The <code>Device</code> is the most important object of Vulkan, and you need one to create almost every other object. <code>Queue</code>s are created together with the <code>Device</code>, and are used to submit work to the device to make it do something.</p> </li> <li> <p>If you created a <code>Surface</code> earlier, create a <a href="swapchain/struct.Swapchain.html" title="struct vulkano::swapchain::Swapchain"><code>Swapchain</code></a>. This object contains special images that correspond to the contents of the surface. Whenever you want to change the contents (show something new to the user), you must first <em>acquire</em> one of these images from the swapchain, fill it with the new contents (by rendering, copying or any other means), and then <em>present</em> it back to the swapchain. A swapchain can become outdated if the properties of the surface change, such as when the size of the window changes. It then becomes necessary to create a new swapchain.</p> </li> <li> <p>Record a <a href="command_buffer/index.html" title="mod vulkano::command_buffer"><em>command buffer</em></a>, containing commands that the device must execute. Then build the command buffer and submit it to a <code>Queue</code>.</p> </li> </ol> <p>Many different operations can be recorded to a command buffer, such as <em>draw</em>, <em>compute</em> and <em>transfer</em> operations. To do any of these things, you will need to create several other objects, depending on your specific needs. This includes:</p> <ul> <li> <p><a href="buffer/index.html" title="mod vulkano::buffer"><em>Buffers</em></a> store general-purpose data on memory accessible by the device. This can include mesh data (vertices, texture coordinates etc.), lighting information, matrices, and anything else you can think of.</p> </li> <li> <p><a href="image/index.html" title="mod vulkano::image"><em>Images</em></a> store texel data, arranged in a grid of one or more dimensions. They can be used as textures, depth/stencil buffers, framebuffers and as part of a swapchain.</p> </li> <li> <p><a href="pipeline/index.html" title="mod vulkano::pipeline"><em>Pipelines</em></a> describe operations on the device. They include one or more <a href="shader/index.html" title="mod vulkano::shader"><em>shader</em></a>s, small programs that the device will execute as part of a pipeline. Pipelines come in several types:</p> <ul> <li>A <a href="pipeline/compute/struct.ComputePipeline.html" title="struct vulkano::pipeline::compute::ComputePipeline"><code>ComputePipeline</code></a> describes how <em>dispatch</em> commands are to be performed.</li> <li>A <a href="pipeline/graphics/struct.GraphicsPipeline.html" title="struct vulkano::pipeline::graphics::GraphicsPipeline"><code>GraphicsPipeline</code></a> describes how <em>draw</em> commands are to be performed.</li> </ul> </li> <li> <p><a href="descriptor_set/index.html" title="mod vulkano::descriptor_set"><em>Descriptor sets</em></a> make buffers, images and other objects available to shaders. The arrangement of these resources in shaders is described by a <a href="descriptor_set/layout/index.html" title="mod vulkano::descriptor_set::layout"><code>DescriptorSetLayout</code></a>. One or more of these layouts in turn forms a <a href="pipeline/layout/index.html" title="mod vulkano::pipeline::layout"><code>PipelineLayout</code></a>, which is used when creating a pipeline object.</p> </li> <li> <p>For more complex, multi-stage draw operations, you can create a <a href="render_pass/struct.RenderPass.html" title="struct vulkano::render_pass::RenderPass"><code>RenderPass</code></a> object. This object describes the stages, known as subpasses, that draw operations consist of, how they interact with one another, and which types of images are available in each subpass. You must also create a <a href="render_pass/struct.Framebuffer.html" title="struct vulkano::render_pass::Framebuffer"><code>Framebuffer</code></a>, which contains the image objects that are to be used in a render pass.</p> </li> </ul> <h2 id="_unchecked-functions"><a class="doc-anchor" href="#_unchecked-functions">搂</a><code>_unchecked</code> functions</h2> <p>Many functions in Vulkano have two versions: the normal function, which is usually safe to call, and another function with <code>_unchecked</code> added onto the end of the name, which is unsafe to call. The <code>_unchecked</code> functions skip all validation checks, so they are usually more efficient, but you must ensure that you meet the validity/safety requirements of the function.</p> <p>For all <code>_unchecked</code> functions, a call to the function is valid, if a call to the corresponding normal function with the same arguments would return without any error. This includes following all the valid usage requirements of the Vulkan specification, but may also include additional requirements specific to Vulkano. <strong>All other usage of <code>_unchecked</code> functions may be undefined behavior.</strong></p> <p>Because there are potentially many <code>_unchecked</code> functions, and because their name and operation can be straightforwardly understood based on the corresponding normal function, they are hidden from the Vulkano documentation by default. You can unhide them by enabling the <code>document_unchecked</code> cargo feature, and then generating the documentation with the command <code>cargo doc --open</code>.</p> <h2 id="cargo-features"><a class="doc-anchor" href="#cargo-features">搂</a>Cargo features</h2><div><table><thead><tr><th>Feature</th><th>Description</th></tr></thead><tbody> <tr><td><code>macros</code></td><td>Include reexports from <a href="https://docs.rs/vulkano-macros/0.35.0/x86_64-unknown-linux-gnu/vulkano_macros/index.html" title="mod vulkano_macros"><code>vulkano-macros</code></a>. Enabled by default.</td></tr> <tr><td><code>x11</code></td><td>Support for X11 platforms. Enabled by default.</td></tr> <tr><td><code>document_unchecked</code></td><td>Include <code>_unchecked</code> functions in the generated documentation.</td></tr> <tr><td><code>serde</code></td><td>Enables (de)serialization of certain types using <a href="https://crates.io/crates/serde"><code>serde</code></a>.</td></tr> </tbody></table> </div></div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">搂</a></h2><dl class="item-table reexports"><dt id="reexport.LoadingError"><code>pub use library::<a class="enum" href="library/enum.LoadingError.html" title="enum vulkano::library::LoadingError">LoadingError</a>;</code></dt><dt id="reexport.VulkanLibrary"><code>pub use library::<a class="struct" href="library/struct.VulkanLibrary.html" title="struct vulkano::library::VulkanLibrary">VulkanLibrary</a>;</code></dt><dt id="reexport.half"><code>pub use <a class="mod" href="https://docs.rs/half/2.4.1/x86_64-unknown-linux-gnu/half/index.html" title="mod half">half</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="mod" href="acceleration_structure/index.html" title="mod vulkano::acceleration_structure">acceleration_<wbr>structure</a></dt><dd>An opaque data structure that is used to accelerate spatial queries on geometry data.</dd><dt><a class="mod" href="buffer/index.html" title="mod vulkano::buffer">buffer</a></dt><dd>Location in memory that contains data.</dd><dt><a class="mod" href="command_buffer/index.html" title="mod vulkano::command_buffer">command_<wbr>buffer</a></dt><dd>Recording commands to execute on the device.</dd><dt><a class="mod" href="deferred/index.html" title="mod vulkano::deferred">deferred</a></dt><dd>Operations on the host that can be deferred.</dd><dt><a class="mod" href="descriptor_set/index.html" title="mod vulkano::descriptor_set">descriptor_<wbr>set</a></dt><dd>Bindings between shaders and the resources they access.</dd><dt><a class="mod" href="device/index.html" title="mod vulkano::device">device</a></dt><dd>Communication channel with a physical device.</dd><dt><a class="mod" href="display/index.html" title="mod vulkano::display">display</a></dt><dd>Control and use of display devices (e.g. monitors).</dd><dt><a class="mod" href="format/index.html" title="mod vulkano::format">format</a></dt><dd>All the formats supported by Vulkan.</dd><dt><a class="mod" href="image/index.html" title="mod vulkano::image">image</a></dt><dd>Image storage (1D, 2D, 3D, arrays, etc.) and image views.</dd><dt><a class="mod" href="instance/index.html" title="mod vulkano::instance">instance</a></dt><dd>API entry point.</dd><dt><a class="mod" href="library/index.html" title="mod vulkano::library">library</a></dt><dd>Vulkan library loading system.</dd><dt><a class="mod" href="memory/index.html" title="mod vulkano::memory">memory</a></dt><dd>Device memory allocation and memory pools.</dd><dt><a class="mod" href="padded/index.html" title="mod vulkano::padded">padded</a></dt><dd>A newtype wrapper for enforcing correct alignment for external types.</dd><dt><a class="mod" href="pipeline/index.html" title="mod vulkano::pipeline">pipeline</a></dt><dd>Describes a processing operation that will execute on the Vulkan device.</dd><dt><a class="mod" href="query/index.html" title="mod vulkano::query">query</a></dt><dd>Gather information about rendering, held in query pools.</dd><dt><a class="mod" href="range_set/index.html" title="mod vulkano::range_set">range_<wbr>set</a></dt><dt><a class="mod" href="render_pass/index.html" title="mod vulkano::render_pass">render_<wbr>pass</a></dt><dd>Description of the steps of the rendering process, and the images used as input or output.</dd><dt><a class="mod" href="shader/index.html" title="mod vulkano::shader">shader</a></dt><dd>A program that is run on the device.</dd><dt><a class="mod" href="swapchain/index.html" title="mod vulkano::swapchain">swapchain</a></dt><dd>Link between Vulkan and a window and/or the screen.</dd><dt><a class="mod" href="sync/index.html" title="mod vulkano::sync">sync</a></dt><dd>Synchronization on the GPU.</dd></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="macro" href="macro.impl_vertex.html" title="macro vulkano::impl_vertex">impl_<wbr>vertex</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>Implements the <code>Vertex</code> trait on a struct.</dd><dt><a class="macro" href="macro.impl_vertex_member.html" title="macro vulkano::impl_vertex_member">impl_<wbr>vertex_<wbr>member</a></dt><dt><a class="macro" href="macro.ordered_passes_renderpass.html" title="macro vulkano::ordered_passes_renderpass">ordered_<wbr>passes_<wbr>renderpass</a></dt><dd>Builds a <code>RenderPass</code> object whose template parameter is of indeterminate type.</dd><dt><a class="macro" href="macro.single_pass_renderpass.html" title="macro vulkano::single_pass_renderpass">single_<wbr>pass_<wbr>renderpass</a></dt><dd>Builds a <code>RenderPass</code> object whose template parameter is of indeterminate type.</dd><dt><a class="macro" href="macro.statically_linked_vulkan_loader.html" title="macro vulkano::statically_linked_vulkan_loader">statically_<wbr>linked_<wbr>vulkan_<wbr>loader</a></dt><dd>Expression that returns a loader that assumes that Vulkan is linked to the executable you鈥檙e compiling.</dd><dt><a class="macro" href="macro.type_for_format.html" title="macro vulkano::type_for_format">type_<wbr>for_<wbr>format</a></dt><dd>Converts a format enum identifier to a standard Rust type that is suitable for representing the format in a buffer or image.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ExtensionProperties.html" title="struct vulkano::ExtensionProperties">Extension<wbr>Properties</a></dt><dd>Properties of an extension in the loader or a physical device.</dd><dt><a class="struct" href="struct.NonExhaustive.html" title="struct vulkano::NonExhaustive">NonExhaustive</a></dt><dd>A helper type for non-exhaustive structs.</dd><dt><a class="struct" href="struct.Packed24_8.html" title="struct vulkano::Packed24_8">Packed24_<wbr>8</a></dt><dd>Holds 24 bits in the least significant bits of memory, and 8 bytes in the most significant bits of that memory, occupying a single <a href="https://doc.rust-lang.org/nightly/std/primitive.u32.html" title="primitive u32"><code>u32</code></a> in total.</dd><dt><a class="struct" href="struct.RequiresAllOf.html" title="struct vulkano::RequiresAllOf">Requires<wbr>AllOf</a></dt><dd>Used in errors to indicate a set of requirements that all need to be available/enabled to allow a given operation.</dd><dt><a class="struct" href="struct.RequiresOneOf.html" title="struct vulkano::RequiresOneOf">Requires<wbr>OneOf</a></dt><dd>Used in errors to indicate a set of alternatives that needs to be available/enabled to allow a given operation.</dd><dt><a class="struct" href="struct.StridedDeviceAddressRegion.html" title="struct vulkano::StridedDeviceAddressRegion">Strided<wbr>Device<wbr>Address<wbr>Region</a></dt><dd>Represents a region of device addresses with a stride.</dd><dt><a class="struct" href="struct.ValidationError.html" title="struct vulkano::ValidationError">Validation<wbr>Error</a></dt><dd>The arguments or other context of a call to a Vulkan function were not valid.</dd><dt><a class="struct" href="struct.Version.html" title="struct vulkano::Version">Version</a></dt><dd>Represents an API version of Vulkan.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Requires.html" title="enum vulkano::Requires">Requires</a></dt><dd>Something that needs to be supported or enabled to allow a particular operation.</dd><dt><a class="enum" href="enum.Validated.html" title="enum vulkano::Validated">Validated</a></dt><dd>A wrapper for error types of functions that can return validation errors.</dd><dt><a class="enum" href="enum.VulkanError.html" title="enum vulkano::VulkanError">Vulkan<wbr>Error</a></dt><dd>An enumeration of runtime errors that can be returned by Vulkan.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Handle.html" title="trait vulkano::Handle">Handle</a></dt><dt><a class="trait" href="trait.SafeDeref.html" title="trait vulkano::SafeDeref">Safe<wbr>Deref</a></dt><dd>Alternative to the <code>Deref</code> trait. Contrary to <code>Deref</code>, must always return the same object.</dd><dt><a class="trait" href="trait.VulkanObject.html" title="trait vulkano::VulkanObject">Vulkan<wbr>Object</a></dt><dd>Gives access to the internal identifier of an object.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">搂</a></h2><dl class="item-table"><dt><a class="type" href="type.DeviceAddress.html" title="type vulkano::DeviceAddress">Device<wbr>Address</a></dt><dd>Represents an address (pointer) on a Vulkan device. <a href="https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDeviceAddress.html">https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDeviceAddress.html</a></dd><dt><a class="type" href="type.DeviceSize.html" title="type vulkano::DeviceSize">Device<wbr>Size</a></dt><dd>Represents memory size and offset values on a Vulkan device. Analogous to the Rust <code>usize</code> type on the host. <a href="https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDeviceSize.html">https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDeviceSize.html</a></dd><dt><a class="type" href="type.NonNullDeviceAddress.html" title="type vulkano::NonNullDeviceAddress">NonNull<wbr>Device<wbr>Address</a></dt><dd>A <a href="type.DeviceAddress.html" title="type vulkano::DeviceAddress"><code>DeviceAddress</code></a> that is known not to equal zero.</dd><dt><a class="type" href="type.NonZeroDeviceSize.html" title="type vulkano::NonZeroDeviceSize">NonZero<wbr>Device<wbr>Size</a></dt><dd>A <a href="type.DeviceSize.html" title="type vulkano::DeviceSize"><code>DeviceSize</code></a> that is known not to equal zero.</dd></dl></section></div></main></div></body></html>

CINXE.COM

vulkano - Rust