|
|
<!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 `sampler` mod in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, sampler"><title>vulkano::sampler - 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 mod"><!--[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'>Module sampler</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>vulkano</a></p><script>window.sidebarCurrent = {name: 'sampler', ty: 'mod', 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/sampler.rs.html#10-956' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>vulkano</a>::<wbr><a class="mod" href=''>sampler</a></span></h1><div class='docblock'><p>How to retrieve data from an image within a shader.</p>
|
|
|
<p>When you retrieve data from an image, you have to pass the coordinates of the pixel you want
|
|
|
to retrieve. The implementation then performs various calculations, and these operations are
|
|
|
what the <code>Sampler</code> struct describes.</p>
|
|
|
<p>Sampling is a very complex topic but that hasn't changed much since the beginnings of 3D
|
|
|
rendering. Documentation here is missing, but any tutorial about OpenGL or DirectX can teach
|
|
|
you how it works.</p>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<p>A simple sampler for most usages:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">sampler</span>::<span class="ident">Sampler</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">_sampler</span> <span class="op">=</span> <span class="ident">Sampler</span>::<span class="ident">simple_repeat_linear_no_mipmap</span>(<span class="ident">device</span>.<span class="ident">clone</span>());</pre></div>
|
|
|
<p>More detailed sampler creation:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">sampler</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">_sampler</span> <span class="op">=</span> <span class="ident">sampler</span>::<span class="ident">Sampler</span>::<span class="ident">new</span>(<span class="ident">device</span>.<span class="ident">clone</span>(), <span class="ident">sampler</span>::<span class="ident">Filter</span>::<span class="ident">Linear</span>,
|
|
|
<span class="ident">sampler</span>::<span class="ident">Filter</span>::<span class="ident">Linear</span>,
|
|
|
<span class="ident">sampler</span>::<span class="ident">MipmapMode</span>::<span class="ident">Nearest</span>,
|
|
|
<span class="ident">sampler</span>::<span class="ident">SamplerAddressMode</span>::<span class="ident">Repeat</span>,
|
|
|
<span class="ident">sampler</span>::<span class="ident">SamplerAddressMode</span>::<span class="ident">Repeat</span>,
|
|
|
<span class="ident">sampler</span>::<span class="ident">SamplerAddressMode</span>::<span class="ident">Repeat</span>, <span class="number">1.0</span>, <span class="number">1.0</span>,
|
|
|
<span class="number">0.0</span>, <span class="number">100.0</span>).<span class="ident">unwrap</span>();;</pre></div>
|
|
|
<h1 id="about-border-colors" class="section-header"><a href="#about-border-colors">About border colors</a></h1>
|
|
|
<p>One of the possible values of <code>SamplerAddressMode</code> and <code>UnnormalizedSamplerAddressMode</code> is
|
|
|
<code>ClampToBorder</code>. This value indicates that accessing an image outside of its range must return
|
|
|
the specified color.</p>
|
|
|
<p>However this comes with restrictions. When using a floating-point border color, the sampler can
|
|
|
only be used with floating-point or depth image views. When using an integer border color, the
|
|
|
sampler can only be used with integer or stencil image views. In addition to this, you can't
|
|
|
use an opaque black border color with an image view that uses components swizzling.</p>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: The reason for this restriction about opaque black borders is that the value of the
|
|
|
alpha is 1.0 while the value of the color components is 0.0. In the other border colors, the
|
|
|
value of all the components is the same.</p>
|
|
|
</blockquote>
|
|
|
<p>Samplers that don't use <code>ClampToBorder</code> are not concerned by these restrictions.</p>
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
<table><tr><td><code>pub use pipeline::depth_stencil::<a class="enum" href="../../vulkano/pipeline/depth_stencil/enum.Compare.html" title="enum vulkano::pipeline::depth_stencil::Compare">Compare</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Sampler.html" title='vulkano::sampler::Sampler struct'>Sampler</a></td><td class='docblock-short'><p>Describes how to retrieve data from an image within a shader.</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.BorderColor.html" title='vulkano::sampler::BorderColor enum'>BorderColor</a></td><td class='docblock-short'><p>The color to use for the border of an image.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Filter.html" title='vulkano::sampler::Filter enum'>Filter</a></td><td class='docblock-short'><p>Describes how the color of each pixel should be determined.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.MipmapMode.html" title='vulkano::sampler::MipmapMode enum'>MipmapMode</a></td><td class='docblock-short'><p>Describes which mipmap from the source to use.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SamplerAddressMode.html" title='vulkano::sampler::SamplerAddressMode enum'>SamplerAddressMode</a></td><td class='docblock-short'><p>How the sampler should behave when it needs to access a pixel that is out of range of the
|
|
|
texture.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SamplerCreationError.html" title='vulkano::sampler::SamplerCreationError enum'>SamplerCreationError</a></td><td class='docblock-short'><p>Error that can happen when creating an instance.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.UnnormalizedSamplerAddressMode.html" title='vulkano::sampler::UnnormalizedSamplerAddressMode enum'>UnnormalizedSamplerAddressMode</a></td><td class='docblock-short'><p>How the sampler should behave when it needs to access a pixel that is out of range of the
|
|
|
texture.</p>
|
|
|
</td></tr></table></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> |
