Files
Trac3r-rust/doc/shade_runner/layouts/trait.ShaderInterfaceDef.html
2020-01-23 23:13:36 -08:00

19 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `ShaderInterfaceDef` trait in crate `shade_runner`."><meta name="keywords" content="rust, rustlang, rust-lang, ShaderInterfaceDef"><title>shade_runner::layouts::ShaderInterfaceDef - 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">&#9776;</div><a href='../../shade_runner/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ShaderInterfaceDef</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.Iter">Iter</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.elements">elements</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ShaderInterfaceDef-for-EmptyShaderInterfaceDef">EmptyShaderInterfaceDef</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>shade_runner</a>::<wbr><a href='index.html'>layouts</a></p><script>window.sidebarCurrent = {name: 'ShaderInterfaceDef', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/vulkano/pipeline/shader.rs.html#415-421' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>shade_runner</a>::<wbr><a href='index.html'>layouts</a>::<wbr><a class="trait" href=''>ShaderInterfaceDef</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait ShaderInterfaceDef <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self::<a class="type" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html#associatedtype.Iter" title="type shade_runner::layouts::ShaderInterfaceDef::Iter">Iter</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a> == <a class="struct" href="../../vulkano/pipeline/shader/struct.ShaderInterfaceDefEntry.html" title="struct vulkano::pipeline::shader::ShaderInterfaceDefEntry">ShaderInterfaceDefEntry</a>,&nbsp;</span>{
type <a href='#associatedtype.Iter' class="type">Iter</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>;
fn <a href='#tymethod.elements' class='fnname'>elements</a>(&amp;self) -&gt; Self::<a class="type" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html#associatedtype.Iter" title="type shade_runner::layouts::ShaderInterfaceDef::Iter">Iter</a>;
}</pre></div><div class='docblock'><p>Types that contain the definition of an interface between two shader stages, or between
the outside and a shader stage.</p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<ul>
<li>Must only provide one entry per location.</li>
<li>The format of each element must not be larger than 128 bits.</li>
</ul>
</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.Iter' class='method'><code id='Iter.t'>type <a href='#associatedtype.Iter' class="type">Iter</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></code></h3><div class='docblock'><p>Iterator returned by <code>elements</code>.</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.elements' class='method'><code id='elements.v'>fn <a href='#tymethod.elements' class='fnname'>elements</a>(&amp;self) -&gt; Self::<a class="type" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html#associatedtype.Iter" title="type shade_runner::layouts::ShaderInterfaceDef::Iter">Iter</a></code></h3><div class='docblock'><p>Iterates over the elements of the interface.</p>
</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-ShaderInterfaceDef-for-EmptyShaderInterfaceDef' class='impl'><code class='in-band'>impl <a class="trait" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html" title="trait shade_runner::layouts::ShaderInterfaceDef">ShaderInterfaceDef</a> for <a class="struct" href="../../vulkano/pipeline/shader/struct.EmptyShaderInterfaceDef.html" title="struct vulkano::pipeline::shader::EmptyShaderInterfaceDef">EmptyShaderInterfaceDef</a></code><a href='#impl-ShaderInterfaceDef-for-EmptyShaderInterfaceDef' class='anchor'></a><a class='srclink' href='../../src/vulkano/pipeline/shader.rs.html#438-445' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Iter-1' class="type"><code id='Iter.t-1'>type <a href='#associatedtype.Iter' class="type">Iter</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>&lt;<a class="struct" href="../../vulkano/pipeline/shader/struct.ShaderInterfaceDefEntry.html" title="struct vulkano::pipeline::shader::ShaderInterfaceDefEntry">ShaderInterfaceDefEntry</a>&gt;</code></h4><h4 id='method.elements' class="method hidden"><code id='elements.v-1'>fn <a href='#method.elements' class='fnname'>elements</a>(&amp;self) -&gt; &lt;<a class="struct" href="../../vulkano/pipeline/shader/struct.EmptyShaderInterfaceDef.html" title="struct vulkano::pipeline::shader::EmptyShaderInterfaceDef">EmptyShaderInterfaceDef</a> as <a class="trait" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html" title="trait shade_runner::layouts::ShaderInterfaceDef">ShaderInterfaceDef</a>&gt;::<a class="type" href="../../shade_runner/layouts/trait.ShaderInterfaceDef.html#associatedtype.Iter" title="type shade_runner::layouts::ShaderInterfaceDef::Iter">Iter</a></code><a class='srclink' href='../../src/vulkano/pipeline/shader.rs.html#442-444' 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'><h3 id='impl-ShaderInterfaceDef' class='impl'><code class='in-band'>impl ShaderInterfaceDef for <a class="struct" href="../../shade_runner/layouts/struct.Input.html" title="struct shade_runner::layouts::Input">Input</a></code><a href='#impl-ShaderInterfaceDef' class='anchor'></a><a class='srclink' href='../../src/shade_runner/layouts.rs.html#20-26' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Iter-2' class="type"><code id='Iter.t-2'>type <a href='#associatedtype.Iter-2' class="type">Iter</a> = <a class="type" href="../../shade_runner/layouts/type.InputIter.html" title="type shade_runner::layouts::InputIter">InputIter</a></code></h4><h4 id='method.elements-1' class="method hidden"><code id='elements.v-2'>fn <a href='#method.elements-1' class='fnname'>elements</a>(&amp;self) -&gt; <a class="type" href="../../shade_runner/layouts/type.InputIter.html" title="type shade_runner::layouts::InputIter">InputIter</a></code><a class='srclink' href='../../src/shade_runner/layouts.rs.html#23-25' title='goto source code'>[src]</a></h4></div><h3 id='impl-ShaderInterfaceDef-1' class='impl'><code class='in-band'>impl ShaderInterfaceDef for <a class="struct" href="../../shade_runner/layouts/struct.Output.html" title="struct shade_runner::layouts::Output">Output</a></code><a href='#impl-ShaderInterfaceDef-1' class='anchor'></a><a class='srclink' href='../../src/shade_runner/layouts.rs.html#35-41' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Iter-3' class="type"><code id='Iter.t-3'>type <a href='#associatedtype.Iter-3' class="type">Iter</a> = <a class="type" href="../../shade_runner/layouts/type.OutputIter.html" title="type shade_runner::layouts::OutputIter">OutputIter</a></code></h4><h4 id='method.elements-2' class="method hidden"><code id='elements.v-3'>fn <a href='#method.elements-2' class='fnname'>elements</a>(&amp;self) -&gt; <a class="type" href="../../shade_runner/layouts/type.OutputIter.html" title="type shade_runner::layouts::OutputIter">OutputIter</a></code><a class='srclink' href='../../src/shade_runner/layouts.rs.html#38-40' title='goto source code'>[src]</a></h4></div></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/pipeline/shader/trait.ShaderInterfaceDef.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>&#9166;</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 = "shade_runner";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>