<!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="Source to the Rust file `C:\Users\Chrilieb\.cargo\registry\src\github.com-1ecc6299db9ec823\ocl-0.14.1\src\lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</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 source">
<nav class="sidebar">
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
</pre><pre class="rust ">
<span class="doccomment">//! # [](https://crates.io/crates/ocl) | [GitHub](https://github.com/cogciprocate/ocl)</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Rust implementation of the [OpenCL&trade; API].</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Some versions of this documentation are built from development branches</span>
<span class="doccomment">//! and may differ slightly between what is on crates.io and the master</span>
<span class="doccomment">//! branch. See the [repo page](https://github.com/cogciprocate/ocl) for links</span>
<span class="doccomment">//! to both versions.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Please report unclear documentation or places where examples would be</span>
<span class="doccomment">//! appreciated by filing an [issue].</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Foundations</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For lower level interfaces and to use `OpenCL` features that have not yet</span>
<span class="doccomment">//! been implemented on the `standard` (high-level) interface types, see the</span>
<span class="doccomment">//! [`ocl-core`] and [`cl-sys`] crates.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Help Wanted</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Please request or help complete any functionality you may need by filing</span>
<span class="doccomment">//! an [issue] or creating a [pull</span>
<span class="doccomment">//! request](https://github.com/cogciprocate/ocl/pulls).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Keep an eye out for places where examples would be useful and let us know!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Feedback appreciated</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Suggestions and nitpicks are most welcome. Don't hesitate to file an</span>
<span class="doccomment">//! [issue] just to offer constructive criticism.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! <br/></span>
<span class="doccomment">//! *“`OpenCL` and the `OpenCL` logo are trademarks of Apple Inc. used by permission by Khronos.”*</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [OpenCL&trade; API]: https://www.khronos.org/registry/OpenCL/</span>
<span class="doccomment">//! [issue]: https://github.com/cogciprocate/ocl/issues</span>
<span class="doccomment">//! [`ocl-core`]: https://github.com/cogciprocate/ocl-core</span>
<span class="doccomment">//! [`cl-sys`]: https://github.com/cogciprocate/cl-sys</span>
<span class="doccomment">//! [`Result`]: /ocl/ocl/type.Result.html</span>
<span class="doccomment">//! [examples]: https://github.com/cogciprocate/ocl/tree/master/examples</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">doc</span>(<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">"https://docs.rs/ocl/0.13"</span>)]</span>
<span class="comment">// #![warn(missing_docs)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">libc</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rand</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">futures</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">crossbeam</span>;
<span class="kw">pub</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ocl_core</span> <span class="kw">as</span> <span class="ident">core</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span>;
<span class="kw">mod</span> <span class="ident">standard</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">async</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">standard</span>::{<span class="ident">Platform</span>, <span class="ident">Device</span>, <span class="ident">Context</span>, <span class="ident">Program</span>, <span class="ident">Queue</span>, <span class="ident">Kernel</span>, <span class="ident">Buffer</span>, <span class="ident">Image</span>, <span class="ident">Event</span>,
<span class="ident">EventList</span>, <span class="ident">EventArray</span>, <span class="ident">Sampler</span>, <span class="ident">SpatialDims</span>, <span class="ident">ProQue</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">async</span>::{<span class="ident">MemMap</span>, <span class="ident">FutureMemMap</span>, <span class="ident">RwVec</span>, <span class="ident">ReadGuard</span>, <span class="ident">WriteGuard</span>, <span class="ident">FutureRwGuard</span>,
<span class="ident">FutureReader</span>, <span class="ident">FutureWriter</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">error</span>::{<span class="ident">Error</span>, <span class="prelude-ty">Result</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">no_inline</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">ffi</span>;
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">no_inline</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">util</span>;
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">no_inline</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">OclPrm</span>, <span class="ident">OclScl</span>, <span class="ident">OclVec</span>, <span class="ident">DeviceType</span>, <span class="ident">CommandQueueProperties</span>, <span class="ident">MemFlags</span>, <span class="ident">MapFlags</span>};
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">prm</span> {
<span class="doccomment">//! OpenCL scalar and vector primitive types.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Rust primitives may have subtly different behaviour than OpenCL</span>
<span class="doccomment">//! primitives within kernels. Wrapping is one example of this. Scalar</span>
<span class="doccomment">//! integers within Rust may do overflow checks where in the kernel they</span>
<span class="doccomment">//! do not. Therefore OpenCL-compatible implementations of each of the</span>
<span class="doccomment">//! types are provided so that host and device side operations can be</span>
<span class="doccomment">//! perfectly consistent.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The `cl_...` (`cl_uchar`, `cl_int`, `cl_float`, etc.) types are simple</span>
<span class="doccomment">//! aliases of the Rust built-in primitive types and do **not** behave the</span>
<span class="doccomment">//! same way that the kernel-side equivalents do. The uppercase-named</span>
<span class="doccomment">//! types, on the other hand, (`Uchar`, `Int`, `Float`, etc.) are designed</span>
<span class="doccomment">//! to behave identically to their corresponding types within kernels.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Please file an issue if any of the uppercase-named kernel-mimicking</span>
<span class="doccomment">//! types deviate from what they should (as they are reasonably new this</span>
<span class="doccomment">//! is definitely something to watch out for).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Vector type fields can be accessed using index operations i.e. [0],</span>
<span class="doccomment">//! [1], [2] ... etc. Plans for other ways of accessing fields (such as</span>
<span class="doccomment">//! `.x()`, `.y()`, `.s0()`, `.s15()`, etc.) will be considered in the</span>
<span class="doccomment">//! future (pending a number of additions/stabilizations to the Rust</span>
<span class="doccomment">//! language). Create an issue if you have an opinion on the matter.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [NOTE]: This module may be renamed.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ffi</span>::{<span class="ident">cl_char</span>, <span class="ident">cl_uchar</span>, <span class="ident">cl_short</span>, <span class="ident">cl_ushort</span>, <span class="ident">cl_int</span>, <span class="ident">cl_uint</span>, <span class="ident">cl_long</span>, <span class="ident">cl_ulong</span>,
<span class="ident">cl_half</span>, <span class="ident">cl_float</span>, <span class="ident">cl_double</span>, <span class="ident">cl_bool</span>, <span class="ident">cl_bitfield</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">ffi</span>::{ <span class="ident">cl_GLuint</span>, <span class="ident">cl_GLint</span>, <span class="ident">cl_GLenum</span> };
<span class="comment">// Wrapping types. Use these to mimic in-kernel behaviour:</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{
<span class="ident">Char</span>, <span class="ident">Char2</span>, <span class="ident">Char3</span>, <span class="ident">Char4</span>, <span class="ident">Char8</span>, <span class="ident">Char16</span>,
<span class="ident">Uchar</span>, <span class="ident">Uchar2</span>, <span class="ident">Uchar3</span>, <span class="ident">Uchar4</span>, <span class="ident">Uchar8</span>, <span class="ident">Uchar16</span>,
<span class="ident">Short</span>, <span class="ident">Short2</span>, <span class="ident">Short3</span>, <span class="ident">Short4</span>, <span class="ident">Short8</span>, <span class="ident">Short16</span>,
<span class="ident">Ushort</span>, <span class="ident">Ushort2</span>, <span class="ident">Ushort3</span>, <span class="ident">Ushort4</span>, <span class="ident">Ushort8</span>, <span class="ident">Ushort16</span>,
<span class="ident">Int</span>, <span class="ident">Int2</span>, <span class="ident">Int3</span>, <span class="ident">Int4</span>, <span class="ident">Int8</span>, <span class="ident">Int16</span>,
<span class="ident">Uint</span>, <span class="ident">Uint2</span>, <span class="ident">Uint3</span>, <span class="ident">Uint4</span>, <span class="ident">Uint8</span>, <span class="ident">Uint16</span>,
<span class="ident">Long</span>, <span class="ident">Long2</span>, <span class="ident">Long3</span>, <span class="ident">Long4</span>, <span class="ident">Long8</span>, <span class="ident">Long16</span>,
<span class="ident">Ulong</span>, <span class="ident">Ulong2</span>, <span class="ident">Ulong3</span>, <span class="ident">Ulong4</span>, <span class="ident">Ulong8</span>, <span class="ident">Ulong16</span>,
<span class="ident">Float</span>, <span class="ident">Float2</span>, <span class="ident">Float3</span>, <span class="ident">Float4</span>, <span class="ident">Float8</span>, <span class="ident">Float16</span>,
<span class="ident">Double</span>, <span class="ident">Double2</span>, <span class="ident">Double3</span>, <span class="ident">Double4</span>, <span class="ident">Double8</span>, <span class="ident">Double16</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">traits</span> {
<span class="doccomment">//! Commonly used traits.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">WorkDims</span>, <span class="ident">MemLen</span>, <span class="ident">IntoMarker</span>, <span class="ident">IntoRawEventArray</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">OclPrm</span>, <span class="ident">OclScl</span>, <span class="ident">OclVec</span>};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">builders</span> {
<span class="doccomment">//! Builders and associated settings-related types.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">ContextBuilder</span>, <span class="ident">BuildOpt</span>, <span class="ident">ProgramBuilder</span>, <span class="ident">ImageBuilder</span>, <span class="ident">ProQueBuilder</span>,
<span class="ident">DeviceSpecifier</span>, <span class="ident">BufferCmdKind</span>, <span class="ident">BufferCmdDataShape</span>, <span class="ident">BufferCmd</span>, <span class="ident">BufferReadCmd</span>,
<span class="ident">BufferWriteCmd</span>, <span class="ident">BufferMapCmd</span>, <span class="ident">ImageCmdKind</span>, <span class="ident">ImageCmd</span>, <span class="ident">KernelCmd</span>, <span class="ident">BufferBuilder</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">ClNullEventPtrEnum</span>, <span class="ident">ClWaitListPtrEnum</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">ImageFormat</span>, <span class="ident">ImageDescriptor</span>, <span class="ident">ContextProperties</span>};
<span class="comment">// #[cfg(not(release))] pub use standard::BufferTest;</span>
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">flags</span> {
<span class="doccomment">//! Bitflags for various parameter types.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{
<span class="comment">// cl_device_type - bitfield</span>
<span class="ident">DeviceType</span>, <span class="ident">DEVICE_TYPE_DEFAULT</span>, <span class="ident">DEVICE_TYPE_CPU</span>, <span class="ident">DEVICE_TYPE_GPU</span>, <span class="ident">DEVICE_TYPE_ACCELERATOR</span>,
<span class="ident">DEVICE_TYPE_CUSTOM</span>, <span class="ident">DEVICE_TYPE_ALL</span>,
<span class="comment">// cl_device_fp_config - bitfield</span>
<span class="ident">DeviceFpConfig</span>, <span class="ident">FP_DENORM</span>, <span class="ident">FP_INF_NAN</span>, <span class="ident">FP_ROUND_TO_NEAREST</span>, <span class="ident">FP_ROUND_TO_ZERO</span>,
<span class="ident">FP_ROUND_TO_INF</span>, <span class="ident">FP_FMA</span>, <span class="ident">FP_SOFT_FLOAT</span>, <span class="ident">FP_CORRECTLY_ROUNDED_DIVIDE_SQRT</span>,
<span class="comment">// cl_device_exec_capabilities - bitfield</span>
<span class="ident">DeviceExecCapabilities</span>, <span class="ident">EXEC_KERNEL</span>, <span class="ident">EXEC_NATIVE_KERNEL</span>,
<span class="comment">// cl_command_queue_properties - bitfield</span>
<span class="ident">CommandQueueProperties</span>, <span class="ident">QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE</span>, <span class="ident">QUEUE_PROFILING_ENABLE</span>,
<span class="comment">// cl_device_affinity_domain</span>
<span class="ident">DeviceAffinityDomain</span>, <span class="ident">DEVICE_AFFINITY_DOMAIN_NUMA</span>, <span class="ident">DEVICE_AFFINITY_DOMAIN_L4_CACHE</span>,
<span class="ident">DEVICE_AFFINITY_DOMAIN_L3_CACHE</span>, <span class="ident">DEVICE_AFFINITY_DOMAIN_L2_CACHE</span>,
<span class="ident">DEVICE_AFFINITY_DOMAIN_L1_CACHE</span>, <span class="ident">DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE</span>,
<span class="comment">// cl_mem_flags - bitfield</span>
<span class="ident">MemFlags</span>, <span class="ident">MEM_READ_WRITE</span>, <span class="ident">MEM_WRITE_ONLY</span>, <span class="ident">MEM_READ_ONLY</span>, <span class="ident">MEM_USE_HOST_PTR</span>,
<span class="ident">MEM_ALLOC_HOST_PTR</span>, <span class="ident">MEM_COPY_HOST_PTR</span>, <span class="ident">MEM_HOST_WRITE_ONLY</span>, <span class="ident">MEM_HOST_READ_ONLY</span>,
<span class="ident">MEM_HOST_NO_ACCESS</span>,
<span class="comment">// cl_mem_migration_flags - bitfield</span>
<span class="ident">MemMigrationFlags</span>, <span class="ident">MIGRATE_MEM_OBJECT_HOST</span>, <span class="ident">MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED</span>,
<span class="comment">// cl_map_flags - bitfield</span>
<span class="ident">MapFlags</span>, <span class="ident">MAP_READ</span>, <span class="ident">MAP_WRITE</span>, <span class="ident">MAP_WRITE_INVALIDATE_REGION</span>,
<span class="comment">// cl_program_binary_type</span>
<span class="ident">ProgramBinaryType</span>, <span class="ident">PROGRAM_BINARY_TYPE_NONE</span>, <span class="ident">PROGRAM_BINARY_TYPE_COMPILED_OBJECT</span>,
<span class="ident">PROGRAM_BINARY_TYPE_LIBRARY</span>, <span class="ident">PROGRAM_BINARY_TYPE_EXECUTABLE</span>,
<span class="comment">// cl_kernel_arg_type_qualifer</span>
<span class="ident">KernelArgTypeQualifier</span>, <span class="ident">KERNEL_ARG_TYPE_NONE</span>, <span class="ident">KERNEL_ARG_TYPE_CONST</span>,
<span class="ident">KERNEL_ARG_TYPE_RESTRICT</span>, <span class="ident">KERNEL_ARG_TYPE_VOLATILE</span>,
};
}
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">enums</span> {
<span class="doccomment">//! Enumerators for settings and information requests.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">DeviceSpecifier</span>, <span class="ident">BufferCmdKind</span>, <span class="ident">BufferCmdDataShape</span>};
<span class="comment">// API enums.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">ImageChannelOrder</span>, <span class="ident">ImageChannelDataType</span>, <span class="ident">Cbool</span>, <span class="ident">Polling</span>, <span class="ident">PlatformInfo</span>,
<span class="ident">DeviceInfo</span>, <span class="ident">DeviceMemCacheType</span>, <span class="ident">DeviceLocalMemType</span>, <span class="ident">ContextInfo</span>, <span class="ident">ContextProperty</span>,
<span class="ident">ContextInfoOrPropertiesPointerType</span>, <span class="ident">DevicePartitionProperty</span>, <span class="ident">CommandQueueInfo</span>, <span class="ident">ChannelType</span>,
<span class="ident">MemObjectType</span>, <span class="ident">MemInfo</span>, <span class="ident">ImageInfo</span>, <span class="ident">AddressingMode</span>, <span class="ident">FilterMode</span>, <span class="ident">SamplerInfo</span>, <span class="ident">ProgramInfo</span>,
<span class="ident">ProgramBuildInfo</span>, <span class="ident">ProgramBuildStatus</span>, <span class="ident">KernelInfo</span>, <span class="ident">KernelArgInfo</span>, <span class="ident">KernelArgAddressQualifier</span>,
<span class="ident">KernelArgAccessQualifier</span>, <span class="ident">KernelWorkGroupInfo</span>, <span class="ident">EventInfo</span>, <span class="ident">CommandType</span>,
<span class="ident">CommandExecutionStatus</span>, <span class="ident">BufferCreateType</span>, <span class="ident">ProfilingInfo</span>};
<span class="comment">// Custom enums.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">KernelArg</span>, <span class="ident">ContextPropertyValue</span>, <span class="ident">PlatformInfoResult</span>, <span class="ident">DeviceInfoResult</span>,
<span class="ident">ContextInfoResult</span>, <span class="ident">CommandQueueInfoResult</span>, <span class="ident">MemInfoResult</span>, <span class="ident">ImageInfoResult</span>,
<span class="ident">SamplerInfoResult</span>, <span class="ident">ProgramInfoResult</span>, <span class="ident">ProgramBuildInfoResult</span>, <span class="ident">KernelInfoResult</span>,
<span class="ident">KernelArgInfoResult</span>, <span class="ident">KernelWorkGroupInfoResult</span>, <span class="ident">EventInfoResult</span>, <span class="ident">ProfilingInfoResult</span>};
<span class="comment">// Error status.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">Status</span>;
}
</pre>
</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>