Ana Sayfa Keşfet Yardım
Giriş Yap
RONCC
/
HPC-Tools-for-Quantum-Computing
İzle 1
Yıldızla 0
Çatalla 0
Dosyalar Sorunlar 0 Değişiklik İstekleri 0 Wiki
Ağaç: e971e022d2
Dallar Biçim İmleri
HPC-Tools-fo...
/
doc
/
ocl
/
builders
/
struct.ContextBuilder.html

struct.ContextBuilder.html 14 KB
Geçmiş Ham

12345678910111213141516171819202122232425262728293031323334353637383940 
  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 `ContextBuilder` struct in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, ContextBuilder"><title>ocl::builders::ContextBuilder - 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 ContextBuilder</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.properties">properties</a><a href="#method.property">property</a><a href="#method.platform">platform</a><a href="#method.gl_context">gl_context</a><a href="#method.glx_display">glx_display</a><a href="#method.devices">devices</a><a href="#method.build">build</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>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'ContextBuilder', 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 href='index.html'>builders</a>::<wbr><a class="struct" href=''>ContextBuilder</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/context.rs.html#212-215' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'><div class="docblock attributes">#[must_use = "builders do nothing unless \'::build\' is called"]
    2. 

  2. </div>pub struct ContextBuilder { /* fields omitted */ }</pre></div><div class='docblock'><p>A builder for <code>Context</code>.</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/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</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/context.rs.html#217-322' 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>() -&gt; <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#228-236' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>ContextBuilder</code></p>
    8. 

  8. <p>Use <code>Context::builder().build().unwrap()</code> for defaults.</p>
    9. 

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

  10. <ul>
    11. 

  11. <li>The first avaliable platform</li>
    12. 

  12. <li>All devices associated with the first available platform</li>
    13. 

  13. <li>No notify callback function or user data.</li>
    14. 

  14. </ul>
    15. 

  15. </div><h4 id='method.properties' class="method"><span id='properties.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.properties' class='fnname'>properties</a>&lt;'a&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;properties: <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a><br>) -&gt; &amp;'a mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#242-245' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies all context properties directly.</p>
    16. 

  16. <p>Overwrites all previously specified properties.</p>
    17. 

  17. </div><h4 id='method.property' class="method"><span id='property.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.property' class='fnname'>property</a>&lt;'a&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;prop_val: <a class="enum" href="../../ocl/enums/enum.ContextPropertyValue.html" title="enum ocl::enums::ContextPropertyValue">ContextPropertyValue</a><br>) -&gt; &amp;'a mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#253-256' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a context property.</p>
    18. 

  18. <p>Overwrites any property with the same variant (i.e.: if
    19. 

  19. <code>ContextPropertyValue::Platform</code> was already set, it would be
    20. 

  20. overwritten if <code>prop_val</code> is also <code>ContextPropertyValue::Platform</code>).</p>
    21. 

  21. </div><h4 id='method.platform' class="method"><span id='platform.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.platform' class='fnname'>platform</a>(&amp;mut self, platform: <a class="struct" href="../../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a>) -&gt; &amp;mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#262-265' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a platform.</p>
    22. 

  22. <p>Overwrites any previously specified platform.</p>
    23. 

  23. </div><h4 id='method.gl_context' class="method"><span id='gl_context.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.gl_context' class='fnname'>gl_context</a>(&amp;mut self, gl_handle: <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>) -&gt; &amp;mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#271-274' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies an OpenGL context to associate with.</p>
    24. 

  24. <p>Overwrites any previously specified OpenGL context.</p>
    25. 

  25. </div><h4 id='method.glx_display' class="method"><span id='glx_display.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.glx_display' class='fnname'>glx_display</a>(&amp;mut self, glx_display: <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>) -&gt; &amp;mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#280-283' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a Display pointer for the GLX context.</p>
    26. 

  26. <p>Overwrites any previously specified GLX context.</p>
    27. 

  27. </div><h4 id='method.devices' class="method"><span id='devices.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.devices' class='fnname'>devices</a>&lt;D:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../ocl/builders/enum.DeviceSpecifier.html" title="enum ocl::builders::DeviceSpecifier">DeviceSpecifier</a>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;device_spec: D<br>) -&gt; &amp;mut <a class="struct" href="../../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#299-304' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a list of devices with which to associate the context.</p>
    28. 

  28. <p>Devices may be specified in any number of ways including simply
    29. 

  29. passing a device or slice of devices. See the [<code>impl From</code>] section of
    30. 

  30. <a href="enum.DeviceSpecifier.html"><code>DeviceSpecifier</code></a> for more information.</p>
    31. 

  31. <h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
    32. 

  32. <p>Devices must not have already been specified.</p>
    33. 

  33. </div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>(&amp;self) -&gt; <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../../ocl/struct.Context.html" title="struct ocl::Context">Context</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/context.rs.html#313-321' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a new <code>Context</code> with the parameters hitherinforthto specified (say what?).</p>
    34. 

  34. <p>Returns a newly created context with the specified platform and set of device types.</p>
    35. 

  35. </div></div>
    36. 

  36.                 <h2 id='synthetic-implementations' class='small-section-header'>
    37. 

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

  38.                 </h2>
    39. 

  39.                 <div id='synthetic-implementations-list'>
    40. 

  40.             <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/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</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/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</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>
    41.