|
|
<!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 `SpecializationConstants` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, SpecializationConstants"><title>vulkano::pipeline::shader::SpecializationConstants - 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 SpecializationConstants</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.descriptors">descriptors</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-SpecializationConstants-for-()">()</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'>shader</a></p><script>window.sidebarCurrent = {name: 'SpecializationConstants', 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/shader.rs.html#619-622' 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'>shader</a>::<wbr><a class="trait" href=''>SpecializationConstants</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait SpecializationConstants {
|
|
|
fn <a href='#tymethod.descriptors' class='fnname'>descriptors</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../../../vulkano/pipeline/shader/struct.SpecializationMapEntry.html" title="struct vulkano::pipeline::shader::SpecializationMapEntry">SpecializationMapEntry</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;
|
|
|
}</pre></div><div class='docblock'><p>Trait for types that contain specialization data for shaders.</p>
|
|
|
<p>Shader modules can contain what is called <em>specialization constants</em>. They are the same as
|
|
|
constants except that their values can be defined when you create a compute pipeline or a
|
|
|
graphics pipeline. Doing so is done by passing a type that implements the
|
|
|
<code>SpecializationConstants</code> trait and that stores the values in question. The <code>descriptors()</code>
|
|
|
method of this trait indicates how to grab them.</p>
|
|
|
<p>Boolean specialization constants must be stored as 32bits integers, where <code>0</code> means <code>false</code> and
|
|
|
any non-zero value means <code>true</code>. Integer and floating-point specialization constants are
|
|
|
stored as their Rust equivalent.</p>
|
|
|
<p>This trait is implemented on <code>()</code> for shaders that don't have any specialization constant.</p>
|
|
|
<p>Note that it is the shader module that chooses which type that implements
|
|
|
<code>SpecializationConstants</code> it is possible to pass when creating the pipeline, through <a href="trait.EntryPointAbstract.html">the
|
|
|
<code>EntryPointAbstract</code> trait</a>. Therefore there is generally no
|
|
|
point to implement this trait yourself, unless you are also writing your own implementation of
|
|
|
<code>EntryPointAbstract</code>.</p>
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">pipeline</span>::<span class="ident">shader</span>::<span class="ident">SpecializationConstants</span>;
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">pipeline</span>::<span class="ident">shader</span>::<span class="ident">SpecializationMapEntry</span>;
|
|
|
|
|
|
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> <span class="comment">// `#[repr(C)]` guarantees that the struct has a specific layout</span>
|
|
|
<span class="kw">struct</span> <span class="ident">MySpecConstants</span> {
|
|
|
<span class="ident">my_integer_constant</span>: <span class="ident">i32</span>,
|
|
|
<span class="ident">a_boolean</span>: <span class="ident">u32</span>,
|
|
|
<span class="ident">floating_point</span>: <span class="ident">f32</span>,
|
|
|
}
|
|
|
|
|
|
<span class="kw">unsafe</span> <span class="kw">impl</span> <span class="ident">SpecializationConstants</span> <span class="kw">for</span> <span class="ident">MySpecConstants</span> {
|
|
|
<span class="kw">fn</span> <span class="ident">descriptors</span>() <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">SpecializationMapEntry</span>] {
|
|
|
<span class="kw">static</span> <span class="ident">DESCRIPTORS</span>: [<span class="ident">SpecializationMapEntry</span>; <span class="number">3</span>] <span class="op">=</span> [
|
|
|
<span class="ident">SpecializationMapEntry</span> {
|
|
|
<span class="ident">constant_id</span>: <span class="number">0</span>,
|
|
|
<span class="ident">offset</span>: <span class="number">0</span>,
|
|
|
<span class="ident">size</span>: <span class="number">4</span>,
|
|
|
},
|
|
|
<span class="ident">SpecializationMapEntry</span> {
|
|
|
<span class="ident">constant_id</span>: <span class="number">1</span>,
|
|
|
<span class="ident">offset</span>: <span class="number">4</span>,
|
|
|
<span class="ident">size</span>: <span class="number">4</span>,
|
|
|
},
|
|
|
<span class="ident">SpecializationMapEntry</span> {
|
|
|
<span class="ident">constant_id</span>: <span class="number">2</span>,
|
|
|
<span class="ident">offset</span>: <span class="number">8</span>,
|
|
|
<span class="ident">size</span>: <span class="number">4</span>,
|
|
|
},
|
|
|
];
|
|
|
|
|
|
<span class="kw-2">&</span><span class="ident">DESCRIPTORS</span>
|
|
|
}
|
|
|
}</pre></div>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The <code>SpecializationMapEntry</code> returned must contain valid offsets and sizes.</li>
|
|
|
<li>The size of each <code>SpecializationMapEntry</code> must match the size of the corresponding constant
|
|
|
(<code>4</code> for booleans).</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.descriptors' class='method'><code id='descriptors.v'>fn <a href='#tymethod.descriptors' class='fnname'>descriptors</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../../../vulkano/pipeline/shader/struct.SpecializationMapEntry.html" title="struct vulkano::pipeline::shader::SpecializationMapEntry">SpecializationMapEntry</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></h3><div class='docblock'><p>Returns descriptors of the struct's layout.</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-SpecializationConstants-for-()' class='impl'><code class='in-band'>impl <a class="trait" href="../../../vulkano/pipeline/shader/trait.SpecializationConstants.html" title="trait vulkano::pipeline::shader::SpecializationConstants">SpecializationConstants</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code><a href='#impl-SpecializationConstants-for-()' class='anchor'></a><a class='srclink' href='../../../src/vulkano/pipeline/shader.rs.html#624-629' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.descriptors' class="method hidden"><code id='descriptors.v-1'>fn <a href='#method.descriptors' class='fnname'>descriptors</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a><a class="struct" href="../../../vulkano/pipeline/shader/struct.SpecializationMapEntry.html" title="struct vulkano::pipeline::shader::SpecializationMapEntry">SpecializationMapEntry</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a class='srclink' href='../../../src/vulkano/pipeline/shader.rs.html#626-628' 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'></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.SpecializationConstants.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> |
