ホーム エクスプローラ ヘルプ
サインイン
RONCC
/
HPC-Tools-for-Quantum-Computing
Watch 1
Star 0
Fork 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: e971e022d2
ブランチ タグ
HPC-Tools-fo...
/
doc
/
ocl
/
struct.Sampler.html

struct.Sampler.html 20 KB
履歴 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 
  1. <!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` struct in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, Sampler"><title>ocl::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></head><body class="rustdoc struct"><!--[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><p class='location'>Struct Sampler</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_defaults">with_defaults</a><a href="#method.info">info</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=SamplerCore&gt;</a><div class="sidebar-links"><a href="#method.as_ptr">as_ptr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Sampler', ty: 'struct', 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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Sampler</a></span><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/ocl/standard/sampler.rs.html#13' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'><div class="docblock attributes">#[repr(C)]
    2. 

  2. </div>pub struct Sampler(_);</pre></div><div class='docblock'><p>An image sampler used to process images.</p>
    3. 

  3. </div>
    4. 

  4.                     <h2 id='methods' class='small-section-header'>
    5. 

  5.                       Methods<a href='#methods' class='anchor'></a>
    6. 

  6.                     </h2>
    7. 

  7.                 <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#15-77' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;context: &amp;<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;normalize_coords: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;addressing_mode: <a class="enum" href="../ocl/enums/enum.AddressingMode.html" title="enum ocl::enums::AddressingMode">AddressingMode</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;filter_mode: <a class="enum" href="../ocl/enums/enum.FilterMode.html" title="enum ocl::enums::FilterMode">FilterMode</a><br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#36-42' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates and returns a new sampler.</p>
    8. 

  8. <h2 id="enum-quick-reference" class="section-header"><a href="#enum-quick-reference">Enum Quick Reference</a></h2>
    9. 

  9. <p><code>addressing_mode</code>:</p>
    10. 

  10. <ul>
    11. 

  11. <li>AddressingMode::None</li>
    12. 

  12. <li>AddressingMode::ClampToEdge</li>
    13. 

  13. <li>AddressingMode::Clamp</li>
    14. 

  14. <li>AddressingMode::Repeat</li>
    15. 

  15. <li>AddressingMode::MirroredRepeat</li>
    16. 

  16. </ul>
    17. 

  17. <p><code>filter_mode</code>:</p>
    18. 

  18. <ul>
    19. 

  19. <li>FilterMode::Nearest</li>
    20. 

  20. <li>FilterMode::Linear</li>
    21. 

  21. </ul>
    22. 

  22. <p>See <a href="https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSampler.html">SDK Docs</a>
    23. 

  23. for more information.</p>
    24. 

  24. </div><h4 id='method.with_defaults' class="method"><span id='with_defaults.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_defaults' class='fnname'>with_defaults</a>(context: &amp;<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#52-57' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates and returns a new sampler with some default settings.</p>
    25. 

  25. <h2 id="defaults" class="section-header"><a href="#defaults">Defaults</a></h2>
    26. 

  26. <ul>
    27. 

  27. <li><code>normalize_coords</code>: false</li>
    28. 

  28. <li><code>addressing_mode</code>: <code>AddressingMode::None</code></li>
    29. 

  29. <li><code>filter_mode</code>: <code>FilterMode::Nearest</code></li>
    30. 

  30. </ul>
    31. 

  31. </div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.info' class='fnname'>info</a>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.SamplerInfo.html" title="enum ocl::enums::SamplerInfo">SamplerInfo</a>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.SamplerInfoResult.html" title="enum ocl::enums::SamplerInfoResult">SamplerInfoResult</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#60-66' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns various kinds of information about the sampler.</p>
    32. 

  32. </div></div>
    33. 

  33.                     <h2 id='deref-methods' class='small-section-header'>
    34. 

  34.                       Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../ocl_core/types/abs/struct.Sampler.html" title="struct ocl_core::types::abs::Sampler">SamplerCore</a>&gt;<a href='#deref-methods' class='anchor'></a>
    35. 

  35.                     </h2>
    36. 

  36.                 <div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#1215-1217' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a pointer, do not store it.</p>
    37. 

  37. </div></div>
    38. 

  38.                 <h2 id='implementations' class='small-section-header'>
    39. 

  39.                   Trait Implementations<a href='#implementations' class='anchor'></a>
    40. 

  40.                 </h2>
    41. 

  41.                 <div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#11' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#11' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
    42. 

  42. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
    43. 

  43. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#11' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#11' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
    44. 

  44. </div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#79-83' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#80-82' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
    45. 

  45. </div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Deref' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#85-91' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Sampler.html" title="struct ocl_core::types::abs::Sampler">SamplerCore</a></code></span></h4>
    46. 

  46. <div class='docblock'><p>The resulting type after dereferencing.</p>
    47. 

  47. </div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Sampler.html" title="struct ocl_core::types::abs::Sampler">SamplerCore</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#88-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Dereferences the value.</p>
    48. 

  48. </div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-DerefMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#93-97' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Sampler.html" title="struct ocl_core::types::abs::Sampler">SamplerCore</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/sampler.rs.html#94-96' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably dereferences the value.</p>
    49. 

  49. </div></div></div>
    50. 

  50.                 <h2 id='synthetic-implementations' class='small-section-header'>
    51. 

  51.                   Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
    52. 

  52.                 </h2>
    53. 

  53.                 <div id='synthetic-implementations-list'>
    54. 

  54.             <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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 = "ocl";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
    55.