|
|
|
|
|
<!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 `VertexDefinition` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, VertexDefinition"><title>vulkano::pipeline::vertex::VertexDefinition - 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 VertexDefinition</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.BuffersIter">BuffersIter</a><a href="#associatedtype.AttribsIter">AttribsIter</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.definition">definition</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'>pipeline</a>::<wbr><a href='index.html'>vertex</a></p><script>window.sidebarCurrent = {name: 'VertexDefinition', 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/pipeline/vertex/definition.rs.html#21-33' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>pipeline</a>::<wbr><a href='index.html'>vertex</a>::<wbr><a class="trait" href=''>VertexDefinition</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait VertexDefinition<I>: <a class="trait" href="../../../vulkano/pipeline/vertex/trait.VertexSource.html" title="trait vulkano::pipeline::vertex::VertexSource">VertexSource</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" tit
|
|
|
|
|
|
type <a href='#associatedtype.BuffersIter' class="type">BuffersIter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.InputRate.html" title="enum vulkano::pipeline::vertex::InputRate">InputRate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|
|
|
|
|
type <a href='#associatedtype.AttribsIter' class="type">AttribsIter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="../../../vulkano/pipeline/vertex/struct.AttributeInfo.html" title="struct vulkano::pipeline::vertex::AttributeInfo">AttributeInfo</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|
|
|
|
|
fn <a href='#tymethod.definition' class='fnname'>definition</a>(<br> &self, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>I<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.BuffersIter" title="type vulkano::pipeline::vertex::VertexDefinition::BuffersIter">BuffersIter</a>, Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.AttribsIter" title="type vulkano::pipeline::vertex::VertexDefinition::AttribsIter">AttribsIter</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.IncompatibleVertexDefinitionError.html" title="enum vulkano::pipeline::vertex::IncompatibleVertexDefinitionError">IncompatibleVertexDefinitionError</a>>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait for types that describe the definition of the vertex input used by a graphics pipeline.</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.BuffersIter' class='method'><code id='BuffersIter.t'>type <a href='#associatedtype.BuffersIter' class="type">BuffersIter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.InputRate.html" title="enum vulkano::pipeline::vertex::InputRate">InputRate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h3><div class='docblock'><p>Iterator that returns the offset, the stride (in bytes) and input rate of each buffer.</p>
|
|
|
|
|
|
</div><h3 id='associatedtype.AttribsIter' class='method'><code id='AttribsIter.t'>type <a href='#associatedtype.AttribsIter' class="type">AttribsIter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="../../../vulkano/pipeline/vertex/struct.AttributeInfo.html" title="struct vulkano::pipeline::vertex::AttributeInfo">AttributeInfo</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h3><div class='docblock'><p>Iterator that returns the attribute location, buffer id, and infos.</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.definition' class='method'><code id='definition.v'>fn <a href='#tymethod.definition' class='fnname'>definition</a>(<br> &self, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>I<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.BuffersIter" title="type vulkano::pipeline::vertex::VertexDefinition::BuffersIter">BuffersIter</a>, Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.AttribsIter" title="type vulkano::pipeline::vertex::VertexDefinition::AttribsIter">AttribsIter</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.IncompatibleVertexDefinitionError.html" title="enum vulkano::pipeline::vertex::IncompatibleVertexDefinitionError">IncompatibleVertexDefinitionError</a>></code></h3><div class='docblock'><p>Builds the vertex definition to use to link this definition to a vertex shader's input
|
|
|
|
|
|
interface.</p>
|
|
|
|
|
|
</div></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'><h3 id='impl-VertexDefinition%3CI%3E' class='impl'><code class='in-band'>impl<I> VertexDefinition<I> for <a class="struct" href="../../../vulkano/pipeline/vertex/struct.BufferlessDefinition.html" title="struct vulkano::pipeline::vertex::BufferlessDefinition">BufferlessDefinition</a></code><a href='#impl-VertexDefinition%3CI%3E' class='anchor'></a><a class='srclink' href='../../../src/vulkano/pipeline/vertex/bufferless.rs.html#48-56' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.BuffersIter-1' class="type"><code id='BuffersIter.t-1'>type <a href='#associatedtype.BuffersIter-1' class="type">BuffersIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/iter/sources/struct.Empty.html" title="struct core::iter::sources::Empty">Empty</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.InputRate.html" title="enum vulkano::pipeline::vertex::InputRate">InputRate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h4><h4 id='associatedtype.AttribsIter-1' class="type"><code id='AttribsIter.t-1'>type <a href='#associatedtype.AttribsIter-1' class="type">AttribsIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/iter/sources/struct.Empty.html" title="struct core::iter::sources::Empty">Empty</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="../../../vulkano/pipeline/vertex/struct.AttributeInfo.html" title="struct vulkano::pipeline::vertex::AttributeInfo">AttributeInfo</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h4><h4 id='method.definition' class="method hidden"><code id='definition.v-1'>fn <a href='#method.definition' class='fnname'>definition</a>(<br> &self, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>I<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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.BuffersIter" title="type vulkano::pipeline::vertex::VertexDefinition::BuffersIter">BuffersIter</a>, Self::<a class="type" href="../../../vulkano/pipeline/vertex/trait.VertexDefinition.html#associatedtype.AttribsIter" title="type vulkano::pipeline::vertex::VertexDefinition::AttribsIter">AttribsIter</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/pipeline/vertex/enum.IncompatibleVertexDefinitionError.html" title="enum vulkano::pipeline::vertex::IncompatibleVertexDefinitionError">IncompatibleVertexDefinitionError</a>></code><a class='srclink' href='../../../src/vulkano/pipeline/vertex/bufferless.rs.html#51-55' title='goto source code'>[src]</a></h4></div><h3 id='impl-VertexDefinition%3CI%3E-1' class='impl'><code class='in-band'>impl<I, T> VertexDefinition<I> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../vulkano/trait.SafeDeref.html" title="trait vulkano::SafeDeref">SafeDeref</a>,<br>
|
|
|
|
|
|
src="../../../implementors/vulkano/pipeline/vertex/trait.VertexDefinition.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>
|
