<!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 `ArgVal` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ArgVal">
<title>ocl::enums::ArgVal - 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 ArgVal</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.mem">mem</a><a href="#method.mem_null">mem_null</a><a href="#method.sampler">sampler</a><a href="#method.sampler_null">sampler_null</a><a href="#method.primitive">primitive</a><a href="#method.scalar">scalar</a><a href="#method.vector">vector</a><a href="#method.local">local</a><a href="#method.from_raw">from_raw</a><a href="#method.as_raw">as_raw</a><a href="#method.is_null">is_null</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>enums</a></p><script>window.sidebarCurrent = {name: 'ArgVal', 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'>enums</a>::<wbr><a class="struct" href=''>ArgVal</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_core/types/structs.rs.html#32-36' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct ArgVal<'a> { /* fields omitted */ }</pre><div class='docblock'><p>A reference to a kernel argument value.</p>
<h3 id="example" class="section-header"><a href="#example">Example:</a></h3>
<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="kw">let</span> <span class="ident">kernel</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_kernel</span>(<span class="kw-2">&</span><span class="ident">program</span>, <span class="string">"multiply"</span>)<span class="question-mark">?</span>;
<span class="ident">core</span>::<span class="ident">set_kernel_arg</span>(<span class="kw-2">&</span><span class="ident">kernel</span>, <span class="number">0</span>, <span class="ident">ArgVal</span>::<span class="ident">scalar</span>(<span class="kw-2">&</span><span class="number">10.0f32</span>))<span class="question-mark">?</span>;
<span class="ident">core</span>::<span class="ident">set_kernel_arg</span>(<span class="kw-2">&</span><span class="ident">kernel</span>, <span class="number">1</span>, <span class="ident">ArgVal</span>::<span class="ident">mem</span>(<span class="kw-2">&</span><span class="ident">buffer</span>))<span class="question-mark">?</span>;</pre>
</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<'a> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#38-142' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.mem' class="method"><span id='mem.v' class='invisible'><code>pub fn <a href='#method.mem' class='fnname'>mem</a>(mem: &'a <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">Mem</a>) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#40-46' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a <code>Mem</code> object.</p>
</div><h4 id='method.mem_null' class="method"><span id='mem_null.v' class='invisible'><code>pub fn <a href='#method.mem_null' class='fnname'>mem_null</a>() -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#49-55' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> corresponding to a null <code>Mem</code> object.</p>
</div><h4 id='method.sampler' class="method"><span id='sampler.v' class='invisible'><code>pub fn <a href='#method.sampler' class='fnname'>sampler</a>(sampler: &'a <a class="struct" href="../../ocl_core/types/abs/struct.Sampler.html" title="struct ocl_core::types::abs::Sampler">Sampler</a>) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#58-64' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a <code>Sampler</code> object.</p>
</div><h4 id='method.sampler_null' class="method"><span id='sampler_null.v' class='invisible'><code>pub fn <a href='#method.sampler_null' class='fnname'>sampler_null</a>() -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#67-73' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a null <code>Sampler</code> object.</p>
</div><h4 id='method.primitive' class="method"><span id='primitive.v' class='invisible'><code>pub fn <a href='#method.primitive' class='fnname'>primitive</a><T>(prm: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'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>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#80-87' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a scalar or vector primitive.</p>
</div><h4 id='method.scalar' class="method"><span id='scalar.v' class='invisible'><code>pub fn <a href='#method.scalar' class='fnname'>scalar</a><T>(scalar: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'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>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#90-93' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a scalar primitive.</p>
</div><h4 id='method.vector' class="method"><span id='vector.v' class='invisible'><code>pub fn <a href='#method.vector' class='fnname'>vector</a><T>(vector: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'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>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#96-99' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> referring to a vector primitive.</p>
</div><h4 id='method.local' class="method"><span id='local.v' class='invisible'><code>pub fn <a href='#method.local' class='fnname'>local</a><T>(length: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'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>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#105-112' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> corresponding to a <code>__local</code> argument.</p>
<p>To specify a <code>__local</code> argument size in bytes, use <code>::raw</code> instead
(with <code>value</code>: <code>std::ptr::null()</code>).</p>
</div><h4 id='method.from_raw' class="method"><span id='from_raw.v' class='invisible'><code>pub unsafe fn <a href='#method.from_raw' class='fnname'>from_raw</a>(size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="enum" href="../../libc/enum.c_void.html" title="enum libc::c_void">c_void</a>) -> <a class="struct" href="../../ocl/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#122-128' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ArgVal</code> containing the size in bytes and a raw pointer
to the argument value.</p>
<h3 id="safety" class="section-header"><a href="#safety">Safety</a></h3>
<p>Caller must ensure that the value pointed to by <code>value</code> lives until
the call to <code>::set_kernel_arg</code> returns and that <code>size</code> accurately
reflects the total number of bytes that should be read.</p>
</div><h4 id='method.as_raw' class="method"><span id='as_raw.v' class='invisible'><code>pub fn <a href='#method.as_raw' class='fnname'>as_raw</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.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.pointer.html">*const </a><a class="enum" href="../../libc/enum.c_void.html" title="enum libc::c_void">c_void</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#132-134' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the size (in bytes) and raw pointer to the contained kernel
argument value.</p>
</div><h4 id='method.is_null' class="method"><span id='is_null.v' class='invisible'><code>pub fn <a href='#method.is_null' class='fnname'>is_null</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#139-141' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns <code>true</code> if this <code>ArgVal</code> represents a null <code>Mem</code> or <code>Sampler</code>
object.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<'a> <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/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#31' 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/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#31' title='goto source code'>[src]</a></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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></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 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'a> <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/enums/struct.ArgVal.html" title="struct ocl::enums::ArgVal">ArgVal</a><'a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#31' 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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#31' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</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>