<!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 `verify_context` fn in crate `ocl_core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, verify_context">
<title>ocl_core::verify_context - 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 fn">
<!--[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_core</a></p><script>window.sidebarCurrent = {name: 'verify_context', ty: 'fn', 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'>Function <a href='index.html'>ocl_core</a>::<wbr><a class="fn" href=''>verify_context</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/functions.rs.html#3371-3383' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn verify_context<C>(context: C) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>> <span class="where fmt-newline">where<br> C: <a class="trait" href="../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>, </span></pre><div class='docblock'><p>Verifies that the <code>context</code> is in fact a context object pointer.</p>
<h1 id="assumptions" class="section-header"><a href="#assumptions">Assumptions</a></h1>
<p>Some (most?/all?) OpenCL implementations do not correctly error if non-
context pointers are passed. This function relies on the fact that passing
the <code>CL_CONTEXT_DEVICES</code> as the <code>param_name</code> to <code>clGetContextInfo</code> will
(at least on my AMD implementation) often return a huge result size if
<code>context</code> is not actually a <code>cl_context</code> pointer due to the fact that it's
reading from some random memory location on non-context structs. Also
checks for zero because a context must have at least one device (true?).
Should probably choose a value lower than 10kB because it seems unlikely
any result would be that big but w/e.</p>
<p>[UPDATE]: This function may no longer be necessary now that the core
pointers have wrappers but it still prevents a hard to track down bug so
it will stay intact for now.</p>
</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_core";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>