12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576 |
- <!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 `KernelCmd` struct in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, KernelCmd"><title>ocl::builders::KernelCmd - 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">☰</div><p class='location'>Struct KernelCmd</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.queue">queue</a><a href="#method.gwo">gwo</a><a href="#method.gws">gws</a><a href="#method.lws">lws</a><a href="#method.global_work_offset">global_work_offset</a><a href="#method.global_work_size">global_work_size</a><a href="#method.local_work_size">local_work_size</a><a href="#method.ewait">ewait</a><a href="#method.enew">enew</a><a href="#method.enq">enq</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: 'KernelCmd', 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=''>KernelCmd</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'>−</span>]</a></span><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#55-63' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'><div class="docblock attributes">#[must_use = "commands do nothing unless enqueued"]
- </div>pub struct KernelCmd<'k> { /* fields omitted */ }</pre></div><div class='docblock'><p>A kernel command builder used to enqueue a kernel with a mix of default
- and optionally specified arguments.</p>
- </div>
- <h2 id='methods' class='small-section-header'>
- Methods<a href='#methods' class='anchor'></a>
- </h2>
- <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'k> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></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/kernel.rs.html#66-212' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='docblock'><p>A kernel enqueue command.</p>
- </div><div class='impl-items'><h4 id='method.queue' class="method"><span id='queue.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.queue' class='fnname'>queue</a><'q, Q>(self, queue: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'q </a>Q) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k> <span class="where fmt-newline">where<br> 'q: 'k,<br> Q: 'k + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="../../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#72-76' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a queue to use for this call only.</p>
- <p>Overrides the kernel's default queue if one is set. If no default
- queue is set, this method <strong>must</strong> be called before enqueuing the
- kernel.</p>
- </div><h4 id='method.gwo' class="method"><span id='gwo.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.gwo' class='fnname'>gwo</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, gwo: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#80-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated since 0.18.0<p>: Use <code>::global_work_offset</code> instead.</p>
- </div></div><div class='docblock'><p>Specifies a global work offset for this call only.</p>
- </div><h4 id='method.gws' class="method"><span id='gws.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.gws' class='fnname'>gws</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, gws: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#87-90' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated since 0.18.0<p>: Use <code>::global_work_size</code> instead.</p>
- </div></div><div class='docblock'><p>Specifies a global work size for this call only.</p>
- </div><h4 id='method.lws' class="method"><span id='lws.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.lws' class='fnname'>lws</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, lws: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#94-97' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab deprecated'>Deprecated since 0.18.0<p>: Use <code>::local_work_size</code> instead.</p>
- </div></div><div class='docblock'><p>Specifies a local work size for this call only.</p>
- </div><h4 id='method.global_work_offset' class="method"><span id='global_work_offset.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.global_work_offset' class='fnname'>global_work_offset</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, gwo: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#100-103' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a global work offset for this call only.</p>
- </div><h4 id='method.global_work_size' class="method"><span id='global_work_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.global_work_size' class='fnname'>global_work_size</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, gws: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#106-109' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a global work size for this call only.</p>
- </div><h4 id='method.local_work_size' class="method"><span id='local_work_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.local_work_size' class='fnname'>local_work_size</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>>(self, lws: D) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#112-115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies a local work size for this call only.</p>
- </div><h4 id='method.ewait' class="method"><span id='ewait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ewait' class='fnname'>ewait</a><'e, Ewl>(self, ewait: Ewl) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k> <span class="where fmt-newline">where<br> 'e: 'k,<br> Ewl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a><'e>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#145-149' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies an event or list of events to wait on before the command
- will run.</p>
- <p>When events generated using the <code>::enew</code> method of <strong>other</strong>,
- previously enqueued commands are passed here (either individually or
- as part of an <a href="struct.EventList.html"><code>EventList</code></a>), this command will not execute until
- those commands have completed.</p>
- <p>Using events can compliment the use of queues to order commands by
- creating temporal dependencies between them (where commands in one
- queue must wait for the completion of commands in another). Events can
- also supplant queues altogether when, for example, using out-of-order
- queues.</p>
- <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
- <div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
- <span class="comment">// Create an event list:</span>
- <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">event_list</span> <span class="op">=</span> <span class="ident">EventList</span>::<span class="ident">new</span>();
- <span class="comment">// Enqueue a kernel on `queue_1`, creating an event representing the kernel</span>
- <span class="comment">// command in our list:</span>
- <span class="ident">kernel</span>.<span class="ident">cmd</span>().<span class="ident">queue</span>(<span class="kw-2">&</span><span class="ident">queue_1</span>).<span class="ident">enew</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">event_list</span>).<span class="ident">enq</span>()<span class="question-mark">?</span>;
- <span class="comment">// Read from a buffer using `queue_2`, ensuring the read does not begin until</span>
- <span class="comment">// after the kernel command has completed:</span>
- <span class="ident">buffer</span>.<span class="ident">read</span>(<span class="ident">rwvec</span>.<span class="ident">clone</span>()).<span class="ident">queue</span>(<span class="kw-2">&</span><span class="ident">queue_2</span>).<span class="ident">ewait</span>(<span class="kw-2">&</span><span class="ident">event_list</span>).<span class="ident">enq_async</span>()<span class="question-mark">?</span>;</pre>
- </div><h4 id='method.enew' class="method"><span id='enew.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.enew' class='fnname'>enew</a><'e, En>(self, new_event_dest: En) -> <a class="struct" href="../../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k> <span class="where fmt-newline">where<br> 'e: 'k,<br> En: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a><'e>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#182-186' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Specifies the destination to store a new, optionally created event
- associated with this command.</p>
- <p>The destination can be a mutable reference to an empty event (created
- using <a href="struct.Event.html#method.empty"><code>Event::empty</code></a>) or a mutable reference to an event list.</p>
- <p>After this command is enqueued, the event in the destination can be
- passed to the <code>::ewait</code> method of another command. Doing so will cause
- the other command to wait until this command has completed before
- executing.</p>
- <p>Using events can compliment the use of queues to order commands by
- creating temporal dependencies between them (where commands in one
- queue must wait for the completion of commands in another). Events can
- also supplant queues altogether when, for example, using out-of-order
- queues.</p>
- <h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
- <div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
- <span class="comment">// Create an event list:</span>
- <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">event</span> <span class="op">=</span> <span class="ident">Event</span>::<span class="ident">empty</span>();
- <span class="comment">// Enqueue a kernel on `queue_1`, creating an event representing the kernel</span>
- <span class="comment">// command in our list:</span>
- <span class="ident">kernel</span>.<span class="ident">cmd</span>().<span class="ident">queue</span>(<span class="kw-2">&</span><span class="ident">queue_1</span>).<span class="ident">enew</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">event</span>).<span class="ident">enq</span>()<span class="question-mark">?</span>;
- <span class="comment">// Read from a buffer using `queue_2`, ensuring the read does not begin until</span>
- <span class="comment">// after the kernel command has completed:</span>
- <span class="ident">buffer</span>.<span class="ident">read</span>(<span class="ident">rwvec</span>.<span class="ident">clone</span>()).<span class="ident">queue</span>(<span class="kw-2">&</span><span class="ident">queue_2</span>).<span class="ident">ewait</span>(<span class="kw-2">&</span><span class="ident">event</span>).<span class="ident">enq_async</span>()<span class="question-mark">?</span>;</pre>
- </div><h4 id='method.enq' class="method"><span id='enq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.enq' class='fnname'>enq</a>(self) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/kernel.rs.html#195-211' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enqueues this kernel command.</p>
- <h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
- <p>All kernel code must be considered untrusted. Therefore the act of
- calling this function contains implied unsafety even though the API
- itself is safe.</p>
- </div></div>
- <h2 id='synthetic-implementations' class='small-section-header'>
- Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
- </h2>
- <div id='synthetic-implementations-list'>
- <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'k> !<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.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></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<'k> !<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.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a><'k></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>⏎</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>
|