<!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 `Kernel` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Kernel">
<title>ocl::Kernel - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Kernel', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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 class="struct" href=''>Kernel</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#174-186' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Kernel { /* fields omitted */ }</pre><div class='docblock'><p>A kernel which represents a 'procedure'.</p>
<p>Corresponds to code which must have already been compiled into a program.</p>
<p>Set arguments using any of the <code>::arg...</code> (builder-style) or
<code>::set_arg...</code> functions or use <code>::set_arg</code> to set arguments by index.</p>
<p><code>Kernel</code> includes features that a raw OpenCL kernel does not, including:</p>
<ol>
<li>Type-checked arguments (not just size-checked)</li>
<li>Named arguments (with a <code>&'static str</code> name)</li>
<li>Prevention of a potential (difficult to debug) segfault if a buffer or
image used by a kernel is dropped prematurely.</li>
<li>Stored defaults for the:
<ul>
<li>Queue</li>
<li>Global Work Offset</li>
<li>Global Work Size</li>
<li>Local Work Size</li>
</ul>
</li>
</ol>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#189-796' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>>>(name: S, program: &<a class="struct" href="../ocl/struct.Program.html" title="struct ocl::Program">Program</a>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>></code></span></h4>
<div class='docblock'><p>Returns a new kernel.</p>
</div><h4 id='method.queue' class="method"><span id='queue.v' class='invisible'><code>fn <a href='#method.queue' class='fnname'>queue</a>(self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Sets the default queue to be used by all subsequent enqueue commands
unless otherwise changed (with <code>::set_default_queue</code>) or overridden
(by <code>::cmd().queue(...)...</code>).</p>
<p>The queue must be associated with a device associated with the
kernel's program.</p>
</div><h4 id='method.gwo' class="method"><span id='gwo.v' class='invisible'><code>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/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Sets the default global work offset (builder-style).</p>
<p>Used when enqueuing kernel commands. Superseded if specified while
making a call to enqueue or building a queue command with <code>::cmd</code>.</p>
</div><h4 id='method.gws' class="method"><span id='gws.v' class='invisible'><code>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/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Sets the default global work size (builder-style).</p>
<p>Used when enqueuing kernel commands. Superseded if specified while
making a call to enqueue or building a queue command with <code>::cmd</code>.</p>
</div><h4 id='method.lws' class="method"><span id='lws.v' class='invisible'><code>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/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Sets the default local work size (builder-style).</p>
<p>Used when enqueuing kernel commands. Superseded if specified while
making a call to enqueue or building a queue command with <code>::cmd</code>.</p>
</div><h4 id='method.arg_buf' class="method"><span id='arg_buf.v' class='invisible'><code>fn <a href='#method.arg_buf' class='fnname'>arg_buf</a><T, M>(self, buffer: M) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Adds a new argument to the kernel specifying the buffer object represented
by 'buffer' (builder-style). Argument is added to the bottom of the argument
order.</p>
</div><h4 id='method.arg_img' class="method"><span id='arg_img.v' class='invisible'><code>fn <a href='#method.arg_img' class='fnname'>arg_img</a><T, M>(self, image: M) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Adds a new argument to the kernel specifying the image object represented
by 'image' (builder-style). Argument is added to the bottom of the argument
order.</p>
</div><h4 id='method.arg_smp' class="method"><span id='arg_smp.v' class='invisible'><code>fn <a href='#method.arg_smp' class='fnname'>arg_smp</a>(self, sampler: &<a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Adds a new argument to the kernel specifying the sampler object represented
by 'sampler' (builder-style). Argument is added to the bottom of the argument
order.</p>
</div><h4 id='method.arg_scl' class="method"><span id='arg_scl.v' class='invisible'><code>fn <a href='#method.arg_scl' class='fnname'>arg_scl</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(self, scalar: T) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Adds a new argument specifying the value: <code>scalar</code> (builder-style). Argument
is added to the bottom of the argument order.</p>
</div><h4 id='method.arg_vec' class="method"><span id='arg_vec.v' class='invisible'><code>fn <a href='#method.arg_vec' class='fnname'>arg_vec</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(self, vector: T) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Adds a new argument specifying the value: <code>vector</code> (builder-style). Argument
is added to the bottom of the argument order.</p>
</div><h4 id='method.arg_loc' class="method"><span id='arg_loc.v' class='invisible'><code>fn <a href='#method.arg_loc' class='fnname'>arg_loc</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(self, length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Adds a new argument specifying the allocation of a local variable of size
<code>length * sizeof(T)</code> bytes (builder_style).</p>
<p>Local variables are used to share data between work items in the same
workgroup.</p>
</div><h4 id='method.arg_scl_named' class="method"><span id='arg_scl_named.v' class='invisible'><code>fn <a href='#method.arg_scl_named' class='fnname'>arg_scl_named</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(<br> self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> scalar_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T><br>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Adds a new named argument (in order) specifying the value: <code>scalar</code>
(builder-style).</p>
<p>Named arguments can be easily modified later using <code>::set_arg_scl_named()</code>.</p>
</div><h4 id='method.arg_vec_named' class="method"><span id='arg_vec_named.v' class='invisible'><code>fn <a href='#method.arg_vec_named' class='fnname'>arg_vec_named</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(<br> self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> vector_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T><br>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Adds a new named argument (in order) specifying the value: <code>vector</code>
(builder-style).</p>
<p>Named arguments can be easily modified later using <code>::set_arg_vec_named()</code>.</p>
</div><h4 id='method.arg_buf_named' class="method"><span id='arg_buf_named.v' class='invisible'><code>fn <a href='#method.arg_buf_named' class='fnname'>arg_buf_named</a><T, M>(<br> self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> buffer_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><M><br>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Adds a new named argument specifying the buffer object represented by
'buffer' (builder-style). Argument is added to the bottom of the argument order.</p>
<p>Named arguments can be easily modified later using <code>::set_arg_buf_named()</code>.</p>
</div><h4 id='method.arg_img_named' class="method"><span id='arg_img_named.v' class='invisible'><code>fn <a href='#method.arg_img_named' class='fnname'>arg_img_named</a><T, M>(self, name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, image_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><M>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Adds a new named argument specifying the image object represented by
'image' (builder-style). Argument is added to the bottom of the argument order.</p>
<p>Named arguments can be easily modified later using <code>::set_arg_img_named()</code>.</p>
</div><h4 id='method.arg_smp_named' class="method"><span id='arg_smp_named.v' class='invisible'><code>fn <a href='#method.arg_smp_named' class='fnname'>arg_smp_named</a>(<br> self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> sampler_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a>><br>) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Adds a new named argument specifying the sampler object represented by
'sampler' (builder-style). Argument is added to the bottom of the argument order.</p>
<p>Named arguments can be easily modified later using <code>::set_arg_smp_named()</code>.</p>
</div><h4 id='method.set_arg_scl_named' class="method"><span id='set_arg_scl_named.v' class='invisible'><code>fn <a href='#method.set_arg_scl_named' class='fnname'>set_arg_scl_named</a><'a, T>(<br> &'a mut self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> scalar: T<br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><&'a mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Modifies the kernel argument named: <code>name</code>.</p>
<h2 id="panics-fixme" class="section-header"><a href="#panics-fixme">Panics [FIXME]</a></h2></div><h4 id='method.set_arg_vec_named' class="method"><span id='set_arg_vec_named.v' class='invisible'><code>fn <a href='#method.set_arg_vec_named' class='fnname'>set_arg_vec_named</a><'a, T>(<br> &'a mut self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> vector: T<br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><&'a mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Modifies the kernel argument named: <code>name</code>.</p>
<h2 id="panics-fixme-1" class="section-header"><a href="#panics-fixme-1">Panics [FIXME]</a></h2></div><h4 id='method.set_arg_buf_named' class="method"><span id='set_arg_buf_named.v' class='invisible'><code>fn <a href='#method.set_arg_buf_named' class='fnname'>set_arg_buf_named</a><'a, T, M>(<br> &'a mut self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> buffer_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><M><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><&'a mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Modifies the kernel argument named: <code>name</code>.</p>
<h2 id="panics-fixme-2" class="section-header"><a href="#panics-fixme-2">Panics [FIXME]</a></h2></div><h4 id='method.set_arg_img_named' class="method"><span id='set_arg_img_named.v' class='invisible'><code>fn <a href='#method.set_arg_img_named' class='fnname'>set_arg_img_named</a><'a, T, M>(<br> &'a mut self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> image_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><M><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><&'a mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + 'static,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></code></span></h4>
<div class='docblock'><p>Modifies the kernel argument named: <code>name</code>.</p>
<h2 id="panics-fixme-3" class="section-header"><a href="#panics-fixme-3">Panics [FIXME]</a></h2></div><h4 id='method.set_arg_smp_named' class="method"><span id='set_arg_smp_named.v' class='invisible'><code>fn <a href='#method.set_arg_smp_named' class='fnname'>set_arg_smp_named</a><'a, T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(<br> &'a mut self, <br> name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> sampler_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../ocl/struct.Sampler.html" title="struct ocl::Sampler">Sampler</a>><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><&'a mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a>></code></span></h4>
<div class='docblock'><p>Sets the value of a named sampler argument.</p>
<h2 id="panics-fixme-4" class="section-header"><a href="#panics-fixme-4">Panics [FIXME]</a></h2></div><h4 id='method.cmd' class="method"><span id='cmd.v' class='invisible'><code>fn <a href='#method.cmd' class='fnname'>cmd</a>(&self) -> <a class="struct" href="../ocl/builders/struct.KernelCmd.html" title="struct ocl::builders::KernelCmd">KernelCmd</a></code></span></h4>
<div class='docblock'><p>Returns a command builder which is used to chain parameters of an
'enqueue' command together.</p>
</div><h4 id='method.enq' class="method"><span id='enq.v' class='invisible'><code>fn <a href='#method.enq' class='fnname'>enq</a>(&self) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
<div class='docblock'><p>Enqueues this kernel on the default queue and returns the result.</p>
<p>Shorthand for <code>.cmd().enq()</code></p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<p>All kernel code must be considered unsafe. Therefore the act of
calling this function contains implied unsafety even though the API
itself is safe. How best to express that without the ambiguity of
being marked <code>unsafe</code> while maintaining zero extra runtime overhead is
still under consideration. Please provide feedback by filing an issue
if you have any thoughts on the matter.</p>
</div><h4 id='method.set_default_queue' class="method"><span id='set_default_queue.v' class='invisible'><code>fn <a href='#method.set_default_queue' class='fnname'>set_default_queue</a>(&mut self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> &mut <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span></h4>
<div class='docblock'><p>Changes the default queue.</p>
<p>Returns a ref for chaining i.e.:</p>
<p><code>kernel.set_default_queue(queue).enqueue(....);</code></p>
<p>Even when used as above, the queue is changed permanently,
not just for the one call. Changing the queue is cheap so feel free
to change as often as needed.</p>
<p>If you want to change the queue for only a single call, use:
<code>::cmd.queue(...)...enq()...</code></p>
<p>The new queue must be associated with a device associated with the
kernel's program.</p>
</div><h4 id='method.default_queue' class="method"><span id='default_queue.v' class='invisible'><code>fn <a href='#method.default_queue' class='fnname'>default_queue</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>></code></span></h4>
<div class='docblock'><p>Returns the default queue for this kernel.</p>
</div><h4 id='method.get_gwo' class="method"><span id='get_gwo.v' class='invisible'><code>fn <a href='#method.get_gwo' class='fnname'>get_gwo</a>(&self) -> <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span></h4>
<div class='docblock'><p>Returns the default global work offset.</p>
</div><h4 id='method.get_gws' class="method"><span id='get_gws.v' class='invisible'><code>fn <a href='#method.get_gws' class='fnname'>get_gws</a>(&self) -> <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span></h4>
<div class='docblock'><p>Returns the default global work size.</p>
</div><h4 id='method.get_lws' class="method"><span id='get_lws.v' class='invisible'><code>fn <a href='#method.get_lws' class='fnname'>get_lws</a>(&self) -> <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span></h4>
<div class='docblock'><p>Returns the default local work size.</p>
</div><h4 id='method.new_arg_count' class="method"><span id='new_arg_count.v' class='invisible'><code>fn <a href='#method.new_arg_count' class='fnname'>new_arg_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h4>
<div class='docblock'><p>Returns the number of arguments specified for this kernel.</p>
</div><h4 id='method.core_as_ref' class="method"><span id='core_as_ref.v' class='invisible'><code>fn <a href='#method.core_as_ref' class='fnname'>core_as_ref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a></code></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 0.13.0<p>: Use <code>::core</code> instead.</p>
</div></div><div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</p>
</div><h4 id='method.core' class="method"><span id='core.v' class='invisible'><code>fn <a href='#method.core' class='fnname'>core</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a></code></span></h4>
<div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>fn <a href='#method.info' class='fnname'>info</a>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.KernelInfo.html" title="enum ocl::enums::KernelInfo">KernelInfo</a>) -> <a class="enum" href="../ocl/enums/enum.KernelInfoResult.html" title="enum ocl::enums::KernelInfoResult">KernelInfoResult</a></code></span></h4>
<div class='docblock'><p>Returns information about this kernel.</p>
</div><h4 id='method.arg_info' class="method"><span id='arg_info.v' class='invisible'><code>fn <a href='#method.arg_info' class='fnname'>arg_info</a>(<br> &self, <br> arg_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> info_kind: <a class="enum" href="../ocl/enums/enum.KernelArgInfo.html" title="enum ocl::enums::KernelArgInfo">KernelArgInfo</a><br>) -> <a class="enum" href="../ocl/enums/enum.KernelArgInfoResult.html" title="enum ocl::enums::KernelArgInfoResult">KernelArgInfoResult</a></code></span></h4>
<div class='docblock'><p>Returns argument information for this kernel.</p>
</div><h4 id='method.wg_info' class="method"><span id='wg_info.v' class='invisible'><code>fn <a href='#method.wg_info' class='fnname'>wg_info</a>(<br> &self, <br> device: <a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a>, <br> info_kind: <a class="enum" href="../ocl/enums/enum.KernelWorkGroupInfo.html" title="enum ocl::enums::KernelWorkGroupInfo">KernelWorkGroupInfo</a><br>) -> <a class="enum" href="../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a></code></span></h4>
<div class='docblock'><p>Returns work group information for this kernel.</p>
</div><h4 id='method.name' class="method"><span id='name.v' class='invisible'><code>fn <a href='#method.name' class='fnname'>name</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the name of this kernel.</p>
</div><h4 id='method.num_args' class="method"><span id='num_args.v' class='invisible'><code>fn <a href='#method.num_args' class='fnname'>num_args</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h4>
<div class='docblock'><p>Returns the number of arguments this kernel has.</p>
</div><h4 id='method.named_arg_idx' class="method"><span id='named_arg_idx.v' class='invisible'><code>fn <a href='#method.named_arg_idx' class='fnname'>named_arg_idx</a>(&self, name: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
<div class='docblock'><p>Returns the argument index of a named argument if it exists.</p>
</div><h4 id='method.verify_arg_type' class="method"><span id='verify_arg_type.v' class='invisible'><code>fn <a href='#method.verify_arg_type' class='fnname'>verify_arg_type</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>>(&self, arg_index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
<div class='docblock'><p>Verifies that a type matches the kernel arg info:</p>
</div><h4 id='method.set_arg_unchecked' class="method"><span id='set_arg_unchecked.v' class='invisible'><code>unsafe fn <a href='#method.set_arg_unchecked' class='fnname'>set_arg_unchecked</a><T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>>(<br> &mut self, <br> arg_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> arg: <a class="enum" href="../ocl/enums/enum.KernelArg.html" title="enum ocl::enums::KernelArg">KernelArg</a><T><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
<div class='docblock'><p>Sets an argument by index without checks of any kind.</p>
<p>Setting buffer or image (<code>cl_mem</code>) arguments this way may cause
segfaults or errors if the buffer goes out of scope at any point
before this kernel is dropped.</p>
<p>This method also bypasses the check to determine if the type you are
passing matches the type defined in your kernel.</p>
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a><Target = <a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a>></h2><div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <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></h4>
<div class='docblock'><p>Returns a pointer, do not store it.</p>
</div><h4 id='method.program' class="method"><span id='program.v' class='invisible'><code>fn <a href='#method.program' class='fnname'>program</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../ocl_core/types/abs/struct.Program.html" title="struct ocl_core::types::abs::Program">Program</a>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Returns the program associated with this kernel.</p>
</div><h4 id='method.devices' class="method"><span id='devices.v' class='invisible'><code>fn <a href='#method.devices' class='fnname'>devices</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="../ocl_core/types/abs/struct.DeviceId.html" title="struct ocl_core::types::abs::DeviceId">DeviceId</a>>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><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.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#173' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><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.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#798-817' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></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>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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>
</div></div><h3 class='impl'><span class='in-band'><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.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#819-825' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></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>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#827-833' title='goto source code'>[src]</a></span></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/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a></code></span></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Kernel.html" title="struct ocl::Kernel">Kernel</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/kernel.rs.html#835-839' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../ocl_core/types/abs/struct.Kernel.html" title="struct ocl_core::types::abs::Kernel">KernelCore</a></code></span></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>