<!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 `ImageCmd` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ImageCmd">
<title>ocl::builders::ImageCmd - 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="../../main.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 ImageCmd</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.map">map</a><a href="#method.copy">copy</a><a href="#method.copy_to_buffer">copy_to_buffer</a><a href="#method.gl_acquire">gl_acquire</a><a href="#method.gl_release">gl_release</a><a href="#method.fill">fill</a><a href="#method.queue">queue</a><a href="#method.block">block</a><a href="#method.origin">origin</a><a href="#method.region">region</a><a href="#method.pitch_bytes">pitch_bytes</a><a href="#method.ewait">ewait</a><a href="#method.enew">enew</a><a href="#method.enq">enq</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'ImageCmd', 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">
</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=''>ImageCmd</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/image.rs.html#75-87' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[must_use = "commands do nothing unless enqueued"]
</div>pub struct ImageCmd<'c, T: 'c> { /* fields omitted */ }</pre><div class='docblock'><p>An image command builder for enqueuing reads, writes, fills, and copies.</p>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<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">// Copies one image to another:</span>
<span class="ident">src_image</span>.<span class="ident">cmd</span>().<span class="ident">copy</span>(<span class="kw-2">&</span><span class="ident">dst_image</span>, [<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]).<span class="ident">enq</span>().<span class="ident">unwrap</span>();
<span class="comment">// Writes from a vector to an image, waiting on an event:</span>
<span class="ident">image</span>.<span class="ident">write</span>(<span class="kw-2">&</span><span class="ident">src_vec</span>).<span class="ident">ewait</span>(<span class="kw-2">&</span><span class="ident">event</span>).<span class="ident">enq</span>().<span class="ident">unwrap</span>();
<span class="comment">// Reads from a image into a vector, waiting on an event list and</span>
<span class="comment">// filling a new empty event:</span>
<span class="ident">image</span>.<span class="ident">read</span>(<span class="kw-2">&</span><span class="ident">dst_vec</span>).<span class="ident">ewait</span>(<span class="kw-2">&</span><span class="ident">event_list</span>).<span class="ident">enew</span>(<span class="kw-2">&</span><span class="ident">empty_event</span>).<span class="ident">enq</span>().<span class="ident">unwrap</span>();
<span class="comment">// Reads without blocking:</span>
<span class="ident">image</span>.<span class="ident">cmd</span>().<span class="ident">read_async</span>(<span class="kw-2">&</span><span class="ident">dst_vec</span>).<span class="ident">enew</span>(<span class="kw-2">&</span><span class="ident">empty_event</span>).<span class="ident">enq</span>().<span class="ident">unwrap</span>();
</pre>
<p>[FIXME]: Fills not yet implemented.</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'><code>impl<'c, T: 'c + <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#90-464' title='goto source code'>[src]</a></span></h3>
<div class='docblock'><p>[UNSTABLE]: All methods still in a state of adjustifulsomeness.</p>
</div><div class='impl-items'><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a><'d>(self, dst_data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'d mut [T]</a>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#125-132' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a blocking read operation.</p>
<p>After calling this method, the blocking state of this command will
be locked to true and a call to <code>::block</code> will cause a panic.</p>
<h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
<p>The command operation kind must not have already been specified.</p>
<h3 id="more-information" class="section-header"><a href="#more-information">More Information</a></h3>
<p>See <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueReadImage.html">SDK</a> docs for more details.</p>
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a><'d>(self, src_data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'d [T]</a>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#145-151' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a write operation.</p>
<h2 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
<h3 id="more-information-1" class="section-header"><a href="#more-information-1">More Information</a></h3>
<p>See <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueReadBuffer.html">SDK</a> docs for more details.</p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>pub unsafe fn <a href='#method.map' class='fnname'>map</a>(self) -> ImageMapCmd<'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#172-179' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a map operation.</p>
<p>If <code>.block(..)</code> has been set it will be ignored. Non-blocking map
commands are enqueued using <code>::enq_async</code>.</p>
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
<p>The caller must ensure that only one mapping of a particular memory
region exists at a time.</p>
<h2 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
<h3 id="more-information-2" class="section-header"><a href="#more-information-2">More Information</a></h3>
<p>See <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueMapImage.html">SDK</a> docs for more details.</p>
</div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><code>pub fn <a href='#method.copy' class='fnname'>copy</a><'d>(<br> self, <br> dst_image: &'d <a class="struct" href="../../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T>, <br> dst_origin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a><br>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#193-202' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a copy operation.</p>
<p>If <code>.block(..)</code> has been set it will be ignored.</p>
<h2 id="errors" class="section-header"><a href="#errors">Errors</a></h2>
<p>If this is a rectangular copy, <code>dst_origin</code> and <code>len</code> must be zero.</p>
<h2 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
</div><h4 id='method.copy_to_buffer' class="method"><span id='copy_to_buffer.v' class='invisible'><code>pub fn <a href='#method.copy_to_buffer' class='fnname'>copy_to_buffer</a><'d>(<br> self, <br> buffer: &'d <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>, <br> dst_origin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#212-218' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a copy to image.</p>
<p>If <code>.block(..)</code> has been set it will be ignored.</p>
<h2 id="panics-4" class="section-header"><a href="#panics-4">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
</div><h4 id='method.gl_acquire' class="method"><span id='gl_acquire.v' class='invisible'><code>pub fn <a href='#method.gl_acquire' class='fnname'>gl_acquire</a>(self) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#228-233' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will acquire a GL buffer.</p>
<p>If <code>.block(..)</code> has been set it will be ignored.</p>
<h2 id="panics-5" class="section-header"><a href="#panics-5">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
</div><h4 id='method.gl_release' class="method"><span id='gl_release.v' class='invisible'><code>pub fn <a href='#method.gl_release' class='fnname'>gl_release</a>(self) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#243-248' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will release a GL buffer.</p>
<p>If <code>.block(..)</code> has been set it will be ignored.</p>
<h2 id="panics-6" class="section-header"><a href="#panics-6">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
</div><h4 id='method.fill' class="method"><span id='fill.v' class='invisible'><code>pub fn <a href='#method.fill' class='fnname'>fill</a>(self, color: T) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#258-263' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies that this command will be a fill.</p>
<p>If <code>.block(..)</code> has been set it will be ignored.</p>
<h2 id="panics-7" class="section-header"><a href="#panics-7">Panics</a></h2>
<p>The command operation kind must not have already been specified</p>
</div><h4 id='method.queue' class="method"><span id='queue.v' class='invisible'><code>pub fn <a href='#method.queue' class='fnname'>queue</a>(self, queue: &'c <a class="struct" href="../../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#269-272' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies a queue to use for this call only.</p>
<p>Overrides the image's default queue if one is set. If no default queue
is set, this method <strong>must</strong> be called before enqueuing the command.</p>
</div><h4 id='method.block' class="method"><span id='block.v' class='invisible'><code>pub unsafe fn <a href='#method.block' class='fnname'>block</a>(self, block: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#293-296' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Specifies whether or not to block the current thread until completion.</p>
<p>Ignored if this is not a read or write operation.</p>
<p>Default is <code>block = true</code>.</p>
<h2 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h2>
<p>When performing non-blocking reads or writes, the caller must ensure
that the data being read from or written to is not accessed improperly
until the command completes. Use events (<code>Event::wait_for</code>) or the
command queue (<code>Queue::finish</code>) to synchronize.</p>
<p>If possible, prefer instead to use <a href="struct.ImageMapCmd.html"><code>::map</code></a> with <a href="struct.ImageMapCmd.html#method.enq_async"><code>::enq_async</code></a> for
optimal performance and data integrity.</p>
</div><h4 id='method.origin' class="method"><span id='origin.v' class='invisible'><code>pub fn <a href='#method.origin' class='fnname'>origin</a><D>(self, origin: D) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 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>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#306-310' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the three dimensional offset, the origin point, for an operation.</p>
<p>Defaults to [0, 0, 0] if not set.</p>
<h2 id="panics-8" class="section-header"><a href="#panics-8">Panics</a></h2>
<p>The 'shape' may not have already been set to rectangular by the
<code>::rect</code> function.</p>
</div><h4 id='method.region' class="method"><span id='region.v' class='invisible'><code>pub fn <a href='#method.region' class='fnname'>region</a><D>(self, region: D) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 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>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#323-327' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the region size for an operation.</p>
<p>Defaults to the full region size of the image(s) as defined when first
created if not set.</p>
<h2 id="panics-tenative" class="section-header"><a href="#panics-tenative">Panics [TENATIVE]</a></h2>
<p>Panics if the region is out of range on any of the three dimensions.</p>
<p>[FIXME]: Probably delay checking this until enq().</p>
</div><h4 id='method.pitch_bytes' class="method"><span id='pitch_bytes.v' class='invisible'><code>pub unsafe fn <a href='#method.pitch_bytes' class='fnname'>pitch_bytes</a>(<br> self, <br> row_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> slc_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#340-344' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the row and slice pitch for a read or write operation in bytes.</p>
<p><code>row_pitch_bytes</code>: Must be greater than or equal to the region width
in bytes (region[0] * sizeof(T)).</p>
<p><code>slice_pitch: Must be greater than or equal to</code>row_pitch` * region
height in bytes (region[1] * sizeof(T)).</p>
<p>Only needs to be set if region has been set to something other than
the (default) image buffer size.</p>
</div><h4 id='method.ewait' class="method"><span id='ewait.v' class='invisible'><code>pub fn <a href='#method.ewait' class='fnname'>ewait</a><'e, Ewl>(self, ewait: Ewl) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'e: 'c,<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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#374-378' title='goto source code'>[src]</a></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'><code>pub fn <a href='#method.enew' class='fnname'>enew</a><'e, En>(self, enew: En) -> <a class="struct" href="../../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'e: 'c,<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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#411-415' title='goto source code'>[src]</a></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'><code>pub fn <a href='#method.enq' class='fnname'>enq</a>(self) -> <a class="type" href="../../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#421-463' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Enqueues this command.</p>
<ul>
<li>TODO: FOR COPY, FILL, AND COPYTOBUFFER -- ENSURE PITCHES ARE BOTH
UNSET.</li>
</ul>
</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "ocl";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>