<!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 `Platform` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Platform">
<title>ocl::Platform - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Platform', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Platform</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../src/ocl/standard/platform.rs.html#18' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[repr(C)]
</div>pub struct Platform(_);</pre><div class='docblock'><p>A platform identifier.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#20-159' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.list' class="method"><span id='list.v' class='invisible'><code>fn <a href='#method.list' class='fnname'>list</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a>></code></span></h4>
<div class='docblock'><p>Returns a list of all platforms avaliable on the host machine.</p>
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(id_core: <a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a>) -> <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span></h4>
<div class='docblock'><p>Creates a new <code>Platform</code> from a <code>PlatformIdCore</code>.</p>
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
<p>Not meant to be called unless you know what you're doing.</p>
<p>Use list to get a list of platforms.</p>
</div><h4 id='method.list_from_core' class="method"><span id='list_from_core.v' class='invisible'><code>fn <a href='#method.list_from_core' class='fnname'>list_from_core</a>(platforms: <a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a>></code></span></h4>
<div class='docblock'><p>Returns a list of <code>Platform</code>s from a list of <code>PlatformIdCore</code>s</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>fn <a href='#method.info' class='fnname'>info</a>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.PlatformInfo.html" title="enum ocl::enums::PlatformInfo">PlatformInfo</a>) -> <a class="enum" href="../ocl/enums/enum.PlatformInfoResult.html" title="enum ocl::enums::PlatformInfoResult">PlatformInfoResult</a></code></span></h4>
<div class='docblock'><p>Returns info about the platform.</p>
</div><h4 id='method.profile' class="method"><span id='profile.v' class='invisible'><code>fn <a href='#method.profile' class='fnname'>profile</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the platform profile as a string.</p>
<p>Returns the profile name supported by the implementation. The profile
name returned can be one of the following strings:</p>
<ul>
<li>
<p>FULL_PROFILE - if the implementation supports the OpenCL
specification (functionality defined as part of the core
specification and does not require any extensions to be supported).</p>
</li>
<li>
<p>EMBEDDED_PROFILE - if the implementation supports the OpenCL
embedded profile. The embedded profile is defined to be a subset for
each version of OpenCL.</p>
</li>
</ul>
</div><h4 id='method.version' class="method"><span id='version.v' class='invisible'><code>fn <a href='#method.version' class='fnname'>version</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the platform driver version as a string.</p>
<p>Returns the OpenCL version supported by the implementation. This
version string has the following format:</p>
<ul>
<li>
<p>OpenCL<space><major_version.minor_version><space><platform-specific
information></p>
</li>
<li>
<p>The major_version.minor_version value returned will be '1.2'.</p>
</li>
<li>
<p>TODO: Convert this to new version system returning an <code>OpenclVersion</code>.</p>
</li>
</ul>
</div><h4 id='method.name' class="method"><span id='name.v' class='invisible'><code>fn <a href='#method.name' class='fnname'>name</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the platform name as a string.</p>
</div><h4 id='method.vendor' class="method"><span id='vendor.v' class='invisible'><code>fn <a href='#method.vendor' class='fnname'>vendor</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the platform vendor as a string.</p>
</div><h4 id='method.extensions' class="method"><span id='extensions.v' class='invisible'><code>fn <a href='#method.extensions' class='fnname'>extensions</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h4>
<div class='docblock'><p>Returns the list of platform extensions as a string.</p>
<p>Returns a space-separated list of extension names (the extension names
themselves do not contain any spaces) supported by the platform.
Extensions defined here must be supported by all devices associated
with this platform.</p>
</div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>fn <a href='#method.as_core' class='fnname'>as_core</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a></code></span></h4>
<div class='docblock'><p>Returns a reference to the underlying <code>PlatformIdCore</code>.</p>
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a><Target = <a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a>></h2><div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span></h4>
<div class='docblock'><p>Returns a pointer.</p>
</div><h4 id='method.version-1' class="method"><span id='version.v-1' class='invisible'><code>fn <a href='#method.version-1' class='fnname'>version</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Returns the queried and parsed OpenCL version for this platform.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#17' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#17' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#17' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../ocl_core/types/abs/trait.ClPlatformIdPtr.html" title="trait ocl_core::types::abs::ClPlatformIdPtr">ClPlatformIdPtr</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#161-165' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_ptr-1' class="method"><span id='as_ptr.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClPlatformIdPtr.html#tymethod.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="type" href="../cl_sys/cl_h/type.cl_platform_id.html" title="type cl_sys::cl_h::cl_platform_id">cl_platform_id</a></code></span></h4>
</div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#168-179' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span></h4>
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a>> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#181-185' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(core: <a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a>) -> <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#205-209' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#212-218' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a></code></span></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/platform.rs.html#220-224' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformIdCore</a></code></span></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "ocl";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>