<!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 `/Users/travis/.cargo/git/checkouts/ocl-21810c0a37a638dd/c345b5b/ocl/src/standard/context.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>context.rs.html -- source</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 source">
<!--[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>
</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"><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>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
</pre><pre class="rust ">
<span class="doccomment">//! An `OpenCL` context.</span>
<span class="kw">use</span> <span class="ident">std</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Deref</span>, <span class="ident">DerefMut</span>};
<span class="kw">use</span> <span class="ident">ffi</span>::<span class="ident">cl_context</span>;
<span class="kw">use</span> <span class="ident">core</span>::{<span class="self">self</span>, <span class="ident">Context</span> <span class="kw">as</span> <span class="ident">ContextCore</span>, <span class="ident">ContextProperties</span>, <span class="ident">ContextPropertyValue</span>, <span class="ident">ContextInfo</span>,
<span class="ident">ContextInfoResult</span>, <span class="ident">DeviceInfo</span>, <span class="ident">DeviceInfoResult</span>, <span class="ident">PlatformInfo</span>, <span class="ident">PlatformInfoResult</span>,
<span class="ident">CreateContextCallbackFn</span>, <span class="ident">UserDataPtr</span>, <span class="ident">OpenclVersion</span>, <span class="ident">ClContextPtr</span>, <span class="ident">ClVersions</span>};
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">error</span>::{<span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclCoreResult</span>, <span class="ident">Error</span> <span class="kw">as</span> <span class="ident">OclCoreError</span>};
<span class="kw">use</span> <span class="ident">error</span>::{<span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclResult</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">Platform</span>, <span class="ident">Device</span>, <span class="ident">DeviceSpecifier</span>};
<span class="doccomment">/// A context for a particular platform and set of device types.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Thread safety and destruction for any enclosed pointers are all handled automatically.</span>
<span class="doccomment">/// Clone, store, and share between threads to your heart's content.</span>
<span class="doccomment">///</span>
<span class="comment">//</span>
<span class="comment">// * TODO: Remove contained copies of the device id list and platform id.</span>
<span class="comment">// Can be easily ascertained via the API. [UPDATE]: devices list removed.</span>
<span class="comment">// Need to parse the `ContextProperties` out of the</span>
<span class="comment">// `ContextInfoResult::Properties` before we can eliminate `platform`.</span>
<span class="comment">//</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Context</span>(<span class="ident">ContextCore</span>);
<span class="kw">impl</span> <span class="ident">Context</span> {
<span class="doccomment">/// Returns a [`ContextBuilder`](/ocl/ocl/struct.ContextBuilder.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is the preferred way to create a Context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">builder</span>() <span class="op">-></span> <span class="ident">ContextBuilder</span> {
<span class="ident">ContextBuilder</span>::<span class="ident">new</span>()
}
<span class="doccomment">/// Returns a newly created context.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Prefer `Context::builder()...` instead of this method unless you know</span>
<span class="doccomment">/// what you're doing. Please also immediately contact us if you do, in</span>
<span class="doccomment">/// fact, know what you're doing so that you can be added to the</span>
<span class="doccomment">/// development team as the one who does.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Defaults</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The 'NULL' platform (which is not to be relied on but is generally</span>
<span class="doccomment">/// the first avaliable).</span>
<span class="doccomment">/// * All devices associated with the 'NULL' platform</span>
<span class="doccomment">/// * No notify callback function or user data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Don't rely on these defaults, instead rely on the `ContextBuilder`</span>
<span class="doccomment">/// defaults. In other words, use: `Context::builder().build().unwrap()`</span>
<span class="doccomment">/// rather than `Context::new(None, None, None, None).unwrap()`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [TEMPORARY] Passing a `Some` variant for `pfn_notify` or `user_data` is</span>
<span class="doccomment">/// not yet supported. File an issue if you need this.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">properties</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ContextProperties</span><span class="op">></span>, <span class="ident">device_spec</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">></span>,
<span class="ident">pfn_notify</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">CreateContextCallbackFn</span><span class="op">></span>, <span class="ident">user_data</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">UserDataPtr</span><span class="op">></span>)
<span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Context</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">pfn_notify</span>.<span class="ident">is_none</span>() <span class="op">&&</span> <span class="ident">user_data</span>.<span class="ident">is_none</span>(),
<span class="string">"Context creation callbacks not yet implemented - file issue if you need this."</span>);
<span class="kw">let</span> <span class="ident">platform</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Platform</span><span class="op">></span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">properties</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">props</span>) <span class="op">=></span> <span class="ident">props</span>.<span class="ident">get_platform</span>().<span class="ident">map</span>(<span class="ident">Platform</span>::<span class="ident">new</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">None</span>,
};
<span class="kw">let</span> <span class="ident">device_spec</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">device_spec</span> {
<span class="prelude-val">Some</span>(<span class="ident">ds</span>) <span class="op">=></span> <span class="ident">ds</span>,
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">DeviceSpecifier</span>::<span class="ident">All</span>,
};
<span class="kw">let</span> <span class="ident">device_list</span> <span class="op">=</span> <span class="ident">device_spec</span>.<span class="ident">to_device_list</span>(<span class="ident">platform</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">obj_core</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_context</span>(<span class="ident">properties</span>.<span class="ident">as_ref</span>(), <span class="kw-2">&</span><span class="ident">device_list</span>, <span class="ident">pfn_notify</span>, <span class="ident">user_data</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">Context</span>(<span class="ident">obj_core</span>))
}
<span class="doccomment">/// Resolves a list of zero-based device indices into a list of Devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If any index is out of bounds it will wrap around zero (%) to the next</span>
<span class="doccomment">/// valid device index.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">resolve_wrapping_device_idxs</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">idxs</span>: <span class="kw-2">&</span>[<span class="ident">usize</span>]) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> {
<span class="ident">Device</span>::<span class="ident">resolve_idxs_wrap</span>(<span class="ident">idxs</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">devices</span>())
}
<span class="doccomment">/// Returns a device by its ordinal count within this context.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Round-robins (%) to the next valid device.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_device_by_wrapping_index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">index</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Device</span> {
<span class="self">self</span>.<span class="ident">resolve_wrapping_device_idxs</span>(<span class="kw-2">&</span>[<span class="ident">index</span>; <span class="number">1</span>])[<span class="number">0</span>]
}
<span class="doccomment">/// Returns info about the platform associated with the context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">platform_info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">info_kind</span>: <span class="ident">PlatformInfo</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">PlatformInfoResult</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">platform</span>() {
<span class="prelude-val">Ok</span>(<span class="ident">plat_opt</span>) <span class="op">=></span> <span class="kw">match</span> <span class="ident">plat_opt</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">p</span>) <span class="op">=></span> <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="ident">p</span>, <span class="ident">info_kind</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">OclCoreError</span>::<span class="ident">from</span>(<span class="string">"Context::platform_info: \
This context has no associated platform."</span>)),
},
<span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">OclCoreError</span>::<span class="ident">from</span>(<span class="ident">err</span>)),
}
}
<span class="doccomment">/// Returns info about the device indexed by `index` associated with this</span>
<span class="doccomment">/// context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">device_info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">index</span>: <span class="ident">usize</span>, <span class="ident">info_kind</span>: <span class="ident">DeviceInfo</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">DeviceInfoResult</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">devices</span>().<span class="ident">get</span>(<span class="ident">index</span>) {
<span class="prelude-val">Some</span>(<span class="ident">d</span>) <span class="op">=></span> <span class="ident">core</span>::<span class="ident">get_device_info</span>(<span class="ident">d</span>, <span class="ident">info_kind</span>),
<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">OclCoreError</span>::<span class="ident">from</span>(<span class="string">"Context::device_info: Invalid device index"</span>));
},
}
}
<span class="doccomment">/// Returns info about the context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">info_kind</span>: <span class="ident">ContextInfo</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">ContextInfoResult</span><span class="op">></span> {
<span class="ident">core</span>::<span class="ident">get_context_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">info_kind</span>)
}
<span class="doccomment">/// Returns a reference to the core pointer wrapper, usable by functions in</span>
<span class="doccomment">/// the `core` module.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_core</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">ContextCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
}
<span class="doccomment">/// Returns the list of devices associated with this context.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics upon any OpenCL error.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">devices</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> {
<span class="ident">Device</span>::<span class="ident">list_from_core</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">devices</span>().<span class="ident">unwrap</span>())
}
<span class="doccomment">/// Returns the list of device versions associated with this context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">device_versions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">OpenclVersion</span><span class="op">>></span> {
<span class="ident">Device</span>::<span class="ident">list_from_core</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">devices</span>()<span class="question-mark">?</span>).<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">d</span><span class="op">|</span> <span class="ident">d</span>.<span class="ident">version</span>()).<span class="ident">collect</span>()
}
<span class="doccomment">/// Returns the platform this context is associated with.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">platform</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">platform</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">opt</span><span class="op">|</span> <span class="ident">opt</span>.<span class="ident">map</span>(<span class="ident">Platform</span>::<span class="ident">from</span>))
}
<span class="kw">fn</span> <span class="ident">fmt_info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Context"</span>)
.<span class="ident">field</span>(<span class="string">"ReferenceCount"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ContextInfo</span>::<span class="ident">ReferenceCount</span>))
.<span class="ident">field</span>(<span class="string">"Devices"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ContextInfo</span>::<span class="ident">Devices</span>))
.<span class="ident">field</span>(<span class="string">"Properties"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ContextInfo</span>::<span class="ident">Properties</span>))
.<span class="ident">field</span>(<span class="string">"NumDevices"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ContextInfo</span>::<span class="ident">NumDevices</span>))
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ContextCore</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">c</span>: <span class="ident">ContextCore</span>) <span class="op">-></span> <span class="ident">Context</span> {
<span class="ident">Context</span>(<span class="ident">c</span>)
}
}
<span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="self">self</span>.<span class="ident">fmt_info</span>(<span class="ident">f</span>)
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Context</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">ContextCore</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">ContextCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
}
}
<span class="kw">impl</span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">deref_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ContextCore</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="number">0</span>
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">ClContextPtr</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">as_ptr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">cl_context</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_ptr</span>()
}
}
<span class="kw">impl</span> <span class="ident">ClVersions</span> <span class="kw">for</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">device_versions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">OpenclVersion</span><span class="op">>></span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">device_versions</span>() }
<span class="kw">fn</span> <span class="ident">platform_version</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">OpenclVersion</span><span class="op">></span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">platform_version</span>() }
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">ClVersions</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Context</span> {
<span class="kw">fn</span> <span class="ident">device_versions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">OpenclVersion</span><span class="op">>></span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">device_versions</span>() }
<span class="kw">fn</span> <span class="ident">platform_version</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">OpenclVersion</span><span class="op">></span> { <span class="self">self</span>.<span class="number">0</span>.<span class="ident">platform_version</span>() }
}
<span class="doccomment">/// A builder for `Context`.</span>
<span class="doccomment">///</span>
<span class="comment">// * TODO:</span>
<span class="comment">// - Handle context creation callbacks.</span>
<span class="comment">//</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"builders do nothing unless '::build' is called"</span>]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ContextBuilder</span> {
<span class="ident">properties</span>: <span class="ident">ContextProperties</span>,
<span class="ident">device_spec</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">ContextBuilder</span> {
<span class="doccomment">/// Creates a new `ContextBuilder`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `Context::builder().build().unwrap()` for defaults.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Defaults</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The first avaliable platform</span>
<span class="doccomment">/// * All devices associated with the first available platform</span>
<span class="doccomment">/// * No notify callback function or user data.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">ContextBuilder</span> {
<span class="comment">// Default platform will be set within `::build` if unspecified by that time.</span>
<span class="kw">let</span> <span class="ident">properties</span> <span class="op">=</span> <span class="ident">ContextProperties</span>::<span class="ident">new</span>();
<span class="ident">ContextBuilder</span> {
<span class="ident">properties</span>: <span class="ident">properties</span>,
<span class="ident">device_spec</span>: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Specifies all context properties directly.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Overwrites all previously specified properties.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">properties</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">properties</span>: <span class="ident">ContextProperties</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="self">self</span>.<span class="ident">properties</span> <span class="op">=</span> <span class="ident">properties</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Specifies a context property.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Overwrites any property with the same variant (i.e.: if</span>
<span class="doccomment">/// `ContextPropertyValue::Platform` was already set, it would be</span>
<span class="doccomment">/// overwritten if `prop_val` is also `ContextPropertyValue::Platform`).</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">property</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">prop_val</span>: <span class="ident">ContextPropertyValue</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="self">self</span>.<span class="ident">properties</span>.<span class="ident">set_property_value</span>(<span class="ident">prop_val</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Specifies a platform.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Overwrites any previously specified platform.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">platform</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">platform</span>: <span class="ident">Platform</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="self">self</span>.<span class="ident">properties</span>.<span class="ident">set_platform</span>(<span class="ident">platform</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Specifies an OpenGL context to associate with.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Overwrites any previously specified OpenGL context.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">gl_context</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">gl_handle</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> ::<span class="ident">ffi</span>::<span class="ident">c_void</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="self">self</span>.<span class="ident">properties</span>.<span class="ident">set_gl_context</span>(<span class="ident">gl_handle</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Specifies a Display pointer for the GLX context.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Overwrites any previously specified GLX context.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">glx_display</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">glx_display</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> ::<span class="ident">ffi</span>::<span class="ident">c_void</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="self">self</span>.<span class="ident">properties</span>.<span class="ident">set_glx_display</span>(<span class="ident">glx_display</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Specifies a list of devices with which to associate the context.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Devices may be specified in any number of ways including simply</span>
<span class="doccomment">/// passing a device or slice of devices. See the [`impl From`] section of</span>
<span class="doccomment">/// [`DeviceSpecifier`][device_specifier] for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Devices must not have already been specified.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [device_specifier_from]: enum.DeviceSpecifier.html#method.from</span>
<span class="doccomment">/// [device_specifier]: enum.DeviceSpecifier.html</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">devices</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">>></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">device_spec</span>: <span class="ident">D</span>)
<span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ContextBuilder</span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">device_spec</span>.<span class="ident">is_none</span>(), <span class="string">"ocl::ContextBuilder::devices: Devices already specified"</span>);
<span class="self">self</span>.<span class="ident">device_spec</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">device_spec</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Returns a new `Context` with the parameters hitherinforthto specified (say what?).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a newly created context with the specified platform and set of device types.</span>
<span class="doccomment">///</span>
<span class="comment">// * TODO:</span>
<span class="comment">// - Handle context creation callbacks.</span>
<span class="comment">//</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Context</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">props</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">properties</span>.<span class="ident">clone</span>();
<span class="kw">if</span> <span class="ident">props</span>.<span class="ident">get_platform</span>().<span class="ident">is_none</span>() {
<span class="ident">props</span>.<span class="ident">set_platform</span>(<span class="ident">Platform</span>::<span class="ident">default</span>());
}
<span class="ident">Context</span>::<span class="ident">new</span>(<span class="prelude-val">Some</span>(<span class="ident">props</span>), <span class="self">self</span>.<span class="ident">device_spec</span>.<span class="ident">clone</span>(), <span class="prelude-val">None</span>, <span class="prelude-val">None</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><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>