<!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 `enums` mod in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, enums">
<title>ocl::enums - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<p class='location'>Module enums</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'enums', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ocl</a>::<wbr><a class="mod" href=''>enums</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/lib.rs.html#178-200' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Enumerators for settings and information requests.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.ArgVal.html"
title='struct ocl::enums::ArgVal'>ArgVal</a></td>
<td class='docblock-short'>
<p>A reference to a kernel argument value.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.AddressingMode.html"
title='enum ocl::enums::AddressingMode'>AddressingMode</a></td>
<td class='docblock-short'>
<p>cl_addressing_mode</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.BufferCmdDataShape.html"
title='enum ocl::enums::BufferCmdDataShape'>BufferCmdDataShape</a></td>
<td class='docblock-short'>
<p>The 'shape' of the data to be processed, whether one or multi-dimensional.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.BufferCmdKind.html"
title='enum ocl::enums::BufferCmdKind'>BufferCmdKind</a></td>
<td class='docblock-short'>
<p>The type of operation to be performed by a command.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.BufferCreateType.html"
title='enum ocl::enums::BufferCreateType'>BufferCreateType</a></td>
<td class='docblock-short'>
<p>cl_buffer_create_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Cbool.html"
title='enum ocl::enums::Cbool'>Cbool</a></td>
<td class='docblock-short'>
<p>cl_bool</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ChannelType.html"
title='enum ocl::enums::ChannelType'>ChannelType</a></td>
<td class='docblock-short'>
<p>cl_channel_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.CommandExecutionStatus.html"
title='enum ocl::enums::CommandExecutionStatus'>CommandExecutionStatus</a></td>
<td class='docblock-short'>
<p>command execution status</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.CommandQueueInfo.html"
title='enum ocl::enums::CommandQueueInfo'>CommandQueueInfo</a></td>
<td class='docblock-short'>
<p>cl_command_queue_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.CommandQueueInfoResult.html"
title='enum ocl::enums::CommandQueueInfoResult'>CommandQueueInfoResult</a></td>
<td class='docblock-short'>
<p>A command queue info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.CommandType.html"
title='enum ocl::enums::CommandType'>CommandType</a></td>
<td class='docblock-short'>
<p>cl_command_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContextInfo.html"
title='enum ocl::enums::ContextInfo'>ContextInfo</a></td>
<td class='docblock-short'>
<p>cl_context_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContextInfoOrPropertiesPointerType.html"
title='enum ocl::enums::ContextInfoOrPropertiesPointerType'>ContextInfoOrPropertiesPointerType</a></td>
<td class='docblock-short'>
<p>cl_context_info + cl_context_properties</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContextInfoResult.html"
title='enum ocl::enums::ContextInfoResult'>ContextInfoResult</a></td>
<td class='docblock-short'>
<p>A context info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContextProperty.html"
title='enum ocl::enums::ContextProperty'>ContextProperty</a></td>
<td class='docblock-short'>
<p>cl_context_info + cl_context_properties</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContextPropertyValue.html"
title='enum ocl::enums::ContextPropertyValue'>ContextPropertyValue</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DeviceInfo.html"
title='enum ocl::enums::DeviceInfo'>DeviceInfo</a></td>
<td class='docblock-short'>
<p>cl_device_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DeviceInfoResult.html"
title='enum ocl::enums::DeviceInfoResult'>DeviceInfoResult</a></td>
<td class='docblock-short'>
<p>A device info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DeviceLocalMemType.html"
title='enum ocl::enums::DeviceLocalMemType'>DeviceLocalMemType</a></td>
<td class='docblock-short'>
<p>cl_device_local_mem_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DeviceMemCacheType.html"
title='enum ocl::enums::DeviceMemCacheType'>DeviceMemCacheType</a></td>
<td class='docblock-short'>
<p>cl_mem_cache_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DevicePartitionProperty.html"
title='enum ocl::enums::DevicePartitionProperty'>DevicePartitionProperty</a></td>
<td class='docblock-short'>
<p>[INCOMPLETE] cl_device_partition_property</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DeviceSpecifier.html"
title='enum ocl::enums::DeviceSpecifier'>DeviceSpecifier</a></td>
<td class='docblock-short'>
<p>Specifies [what boils down to] a list of devices.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.EventInfo.html"
title='enum ocl::enums::EventInfo'>EventInfo</a></td>
<td class='docblock-short'>
<p>cl_event_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.EventInfoResult.html"
title='enum ocl::enums::EventInfoResult'>EventInfoResult</a></td>
<td class='docblock-short'>
<p>An event info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.FilterMode.html"
title='enum ocl::enums::FilterMode'>FilterMode</a></td>
<td class='docblock-short'>
<p>cl_filter_mode</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageChannelDataType.html"
title='enum ocl::enums::ImageChannelDataType'>ImageChannelDataType</a></td>
<td class='docblock-short'>
<p>Describes the size of the channel data type. The number of bits per element determined by the image_channel_data_type and image_channel_order must be a power of two. The list of supported values is described in the table below. (from SDK)</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageChannelOrder.html"
title='enum ocl::enums::ImageChannelOrder'>ImageChannelOrder</a></td>
<td class='docblock-short'>
<p>Specifies the number of channels and the channel layout i.e. the memory layout in which channels are stored in the image. Valid values are described in the table below. (from SDK)</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageInfo.html"
title='enum ocl::enums::ImageInfo'>ImageInfo</a></td>
<td class='docblock-short'>
<p>cl_image_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageInfoResult.html"
title='enum ocl::enums::ImageInfoResult'>ImageInfoResult</a></td>
<td class='docblock-short'>
<p>An image info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelArgAccessQualifier.html"
title='enum ocl::enums::KernelArgAccessQualifier'>KernelArgAccessQualifier</a></td>
<td class='docblock-short'>
<p>cl_kernel_arg_access_qualifier</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelArgAddressQualifier.html"
title='enum ocl::enums::KernelArgAddressQualifier'>KernelArgAddressQualifier</a></td>
<td class='docblock-short'>
<p>cl_kernel_arg_address_qualifier</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelArgInfo.html"
title='enum ocl::enums::KernelArgInfo'>KernelArgInfo</a></td>
<td class='docblock-short'>
<p>cl_kernel_arg_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelArgInfoResult.html"
title='enum ocl::enums::KernelArgInfoResult'>KernelArgInfoResult</a></td>
<td class='docblock-short'>
<p>A kernel arg info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelInfo.html"
title='enum ocl::enums::KernelInfo'>KernelInfo</a></td>
<td class='docblock-short'>
<p>cl_kernel_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelInfoResult.html"
title='enum ocl::enums::KernelInfoResult'>KernelInfoResult</a></td>
<td class='docblock-short'>
<p>A kernel info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelWorkGroupInfo.html"
title='enum ocl::enums::KernelWorkGroupInfo'>KernelWorkGroupInfo</a></td>
<td class='docblock-short'>
<p>cl_kernel_work_group_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.KernelWorkGroupInfoResult.html"
title='enum ocl::enums::KernelWorkGroupInfoResult'>KernelWorkGroupInfoResult</a></td>
<td class='docblock-short'>
<p>A kernel work group info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.MemInfo.html"
title='enum ocl::enums::MemInfo'>MemInfo</a></td>
<td class='docblock-short'>
<p>cl_mem_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.MemInfoResult.html"
title='enum ocl::enums::MemInfoResult'>MemInfoResult</a></td>
<td class='docblock-short'>
<p>A mem info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.MemObjectType.html"
title='enum ocl::enums::MemObjectType'>MemObjectType</a></td>
<td class='docblock-short'>
<p>cl_mem_object_type</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PlatformInfo.html"
title='enum ocl::enums::PlatformInfo'>PlatformInfo</a></td>
<td class='docblock-short'>
<p>cl_platform_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PlatformInfoResult.html"
title='enum ocl::enums::PlatformInfoResult'>PlatformInfoResult</a></td>
<td class='docblock-short'>
<p>Platform info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Polling.html"
title='enum ocl::enums::Polling'>Polling</a></td>
<td class='docblock-short'>
<p>cl_bool: Polling</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProfilingInfo.html"
title='enum ocl::enums::ProfilingInfo'>ProfilingInfo</a></td>
<td class='docblock-short'>
<p>cl_profiling_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProfilingInfoResult.html"
title='enum ocl::enums::ProfilingInfoResult'>ProfilingInfoResult</a></td>
<td class='docblock-short'>
<p>A profiling info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProgramBuildInfo.html"
title='enum ocl::enums::ProgramBuildInfo'>ProgramBuildInfo</a></td>
<td class='docblock-short'>
<p>cl_program_build_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProgramBuildInfoResult.html"
title='enum ocl::enums::ProgramBuildInfoResult'>ProgramBuildInfoResult</a></td>
<td class='docblock-short'>
<p>A program build info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProgramBuildStatus.html"
title='enum ocl::enums::ProgramBuildStatus'>ProgramBuildStatus</a></td>
<td class='docblock-short'>
<p>cl_build_status</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProgramInfo.html"
title='enum ocl::enums::ProgramInfo'>ProgramInfo</a></td>
<td class='docblock-short'>
<p>cl_program_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ProgramInfoResult.html"
title='enum ocl::enums::ProgramInfoResult'>ProgramInfoResult</a></td>
<td class='docblock-short'>
<p>A program info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.SamplerInfo.html"
title='enum ocl::enums::SamplerInfo'>SamplerInfo</a></td>
<td class='docblock-short'>
<p>cl_sampler_info</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.SamplerInfoResult.html"
title='enum ocl::enums::SamplerInfoResult'>SamplerInfoResult</a></td>
<td class='docblock-short'>
<p>A sampler info result.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Status.html"
title='enum ocl::enums::Status'>Status</a></td>
<td class='docblock-short'>
<p>The status of an OpenCL API call. Used for returning success/error codes.</p>
</td>
</tr></table></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>