index.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. <!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 `flags` mod in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, flags"><title>ocl::flags - 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="../../light.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">&#9776;</div><p class='location'>Module flags</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></div><p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'flags', 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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></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=''>flags</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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/ocl/lib.rs.html#143-176' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Bitflags for various parameter types.</p>
  2. </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  3. <table>
  4. <tr class=' module-item'>
  5. <td><a class="struct" href="struct.CommandQueueProperties.html"
  6. title='struct ocl::flags::CommandQueueProperties'>CommandQueueProperties</a></td>
  7. <td class='docblock-short'>
  8. <p>cl_command_queue_properties - bitfield</p>
  9. </td>
  10. </tr>
  11. <tr class=' module-item'>
  12. <td><a class="struct" href="struct.DeviceAffinityDomain.html"
  13. title='struct ocl::flags::DeviceAffinityDomain'>DeviceAffinityDomain</a></td>
  14. <td class='docblock-short'>
  15. <p>cl_device_affinity_domain</p>
  16. </td>
  17. </tr>
  18. <tr class=' module-item'>
  19. <td><a class="struct" href="struct.DeviceExecCapabilities.html"
  20. title='struct ocl::flags::DeviceExecCapabilities'>DeviceExecCapabilities</a></td>
  21. <td class='docblock-short'>
  22. <p>cl_device_exec_capabilities - bitfield</p>
  23. </td>
  24. </tr>
  25. <tr class=' module-item'>
  26. <td><a class="struct" href="struct.DeviceFpConfig.html"
  27. title='struct ocl::flags::DeviceFpConfig'>DeviceFpConfig</a></td>
  28. <td class='docblock-short'>
  29. <p>cl_device_fp_config - bitfield</p>
  30. </td>
  31. </tr>
  32. <tr class=' module-item'>
  33. <td><a class="struct" href="struct.DeviceType.html"
  34. title='struct ocl::flags::DeviceType'>DeviceType</a></td>
  35. <td class='docblock-short'>
  36. <p>cl_device_type - bitfield</p>
  37. </td>
  38. </tr>
  39. <tr class=' module-item'>
  40. <td><a class="struct" href="struct.KernelArgTypeQualifier.html"
  41. title='struct ocl::flags::KernelArgTypeQualifier'>KernelArgTypeQualifier</a></td>
  42. <td class='docblock-short'>
  43. <p>cl_kernel_arg_type_qualifer</p>
  44. </td>
  45. </tr>
  46. <tr class=' module-item'>
  47. <td><a class="struct" href="struct.MapFlags.html"
  48. title='struct ocl::flags::MapFlags'>MapFlags</a></td>
  49. <td class='docblock-short'>
  50. <p>cl_map_flags - bitfield</p>
  51. </td>
  52. </tr>
  53. <tr class=' module-item'>
  54. <td><a class="struct" href="struct.MemFlags.html"
  55. title='struct ocl::flags::MemFlags'>MemFlags</a></td>
  56. <td class='docblock-short'>
  57. <p>cl_mem_flags - bitfield</p>
  58. </td>
  59. </tr>
  60. <tr class=' module-item'>
  61. <td><a class="struct" href="struct.MemMigrationFlags.html"
  62. title='struct ocl::flags::MemMigrationFlags'>MemMigrationFlags</a></td>
  63. <td class='docblock-short'>
  64. <p>cl_mem_migration_flags - bitfield</p>
  65. </td>
  66. </tr>
  67. <tr class=' module-item'>
  68. <td><a class="struct" href="struct.ProgramBinaryType.html"
  69. title='struct ocl::flags::ProgramBinaryType'>ProgramBinaryType</a></td>
  70. <td class='docblock-short'>
  71. <p>cl_program_binary_type</p>
  72. </td>
  73. </tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
  74. <table>
  75. <tr class=' module-item'>
  76. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L1_CACHE.html"
  77. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L1_CACHE'>DEVICE_AFFINITY_DOMAIN_L1_CACHE</a></td>
  78. <td class='docblock-short'>
  79. </td>
  80. </tr>
  81. <tr class=' module-item'>
  82. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L2_CACHE.html"
  83. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L2_CACHE'>DEVICE_AFFINITY_DOMAIN_L2_CACHE</a></td>
  84. <td class='docblock-short'>
  85. </td>
  86. </tr>
  87. <tr class=' module-item'>
  88. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L3_CACHE.html"
  89. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L3_CACHE'>DEVICE_AFFINITY_DOMAIN_L3_CACHE</a></td>
  90. <td class='docblock-short'>
  91. </td>
  92. </tr>
  93. <tr class=' module-item'>
  94. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L4_CACHE.html"
  95. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L4_CACHE'>DEVICE_AFFINITY_DOMAIN_L4_CACHE</a></td>
  96. <td class='docblock-short'>
  97. </td>
  98. </tr>
  99. <tr class=' module-item'>
  100. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.html"
  101. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE'>DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE</a></td>
  102. <td class='docblock-short'>
  103. </td>
  104. </tr>
  105. <tr class=' module-item'>
  106. <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_NUMA.html"
  107. title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_NUMA'>DEVICE_AFFINITY_DOMAIN_NUMA</a></td>
  108. <td class='docblock-short'>
  109. </td>
  110. </tr>
  111. <tr class=' module-item'>
  112. <td><a class="constant" href="constant.DEVICE_TYPE_ACCELERATOR.html"
  113. title='constant ocl::flags::DEVICE_TYPE_ACCELERATOR'>DEVICE_TYPE_ACCELERATOR</a></td>
  114. <td class='docblock-short'>
  115. </td>
  116. </tr>
  117. <tr class=' module-item'>
  118. <td><a class="constant" href="constant.DEVICE_TYPE_ALL.html"
  119. title='constant ocl::flags::DEVICE_TYPE_ALL'>DEVICE_TYPE_ALL</a></td>
  120. <td class='docblock-short'>
  121. </td>
  122. </tr>
  123. <tr class=' module-item'>
  124. <td><a class="constant" href="constant.DEVICE_TYPE_CPU.html"
  125. title='constant ocl::flags::DEVICE_TYPE_CPU'>DEVICE_TYPE_CPU</a></td>
  126. <td class='docblock-short'>
  127. </td>
  128. </tr>
  129. <tr class=' module-item'>
  130. <td><a class="constant" href="constant.DEVICE_TYPE_CUSTOM.html"
  131. title='constant ocl::flags::DEVICE_TYPE_CUSTOM'>DEVICE_TYPE_CUSTOM</a></td>
  132. <td class='docblock-short'>
  133. </td>
  134. </tr>
  135. <tr class=' module-item'>
  136. <td><a class="constant" href="constant.DEVICE_TYPE_DEFAULT.html"
  137. title='constant ocl::flags::DEVICE_TYPE_DEFAULT'>DEVICE_TYPE_DEFAULT</a></td>
  138. <td class='docblock-short'>
  139. </td>
  140. </tr>
  141. <tr class=' module-item'>
  142. <td><a class="constant" href="constant.DEVICE_TYPE_GPU.html"
  143. title='constant ocl::flags::DEVICE_TYPE_GPU'>DEVICE_TYPE_GPU</a></td>
  144. <td class='docblock-short'>
  145. </td>
  146. </tr>
  147. <tr class=' module-item'>
  148. <td><a class="constant" href="constant.EXEC_KERNEL.html"
  149. title='constant ocl::flags::EXEC_KERNEL'>EXEC_KERNEL</a></td>
  150. <td class='docblock-short'>
  151. </td>
  152. </tr>
  153. <tr class=' module-item'>
  154. <td><a class="constant" href="constant.EXEC_NATIVE_KERNEL.html"
  155. title='constant ocl::flags::EXEC_NATIVE_KERNEL'>EXEC_NATIVE_KERNEL</a></td>
  156. <td class='docblock-short'>
  157. </td>
  158. </tr>
  159. <tr class=' module-item'>
  160. <td><a class="constant" href="constant.FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.html"
  161. title='constant ocl::flags::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT'>FP_CORRECTLY_ROUNDED_DIVIDE_SQRT</a></td>
  162. <td class='docblock-short'>
  163. </td>
  164. </tr>
  165. <tr class=' module-item'>
  166. <td><a class="constant" href="constant.FP_DENORM.html"
  167. title='constant ocl::flags::FP_DENORM'>FP_DENORM</a></td>
  168. <td class='docblock-short'>
  169. </td>
  170. </tr>
  171. <tr class=' module-item'>
  172. <td><a class="constant" href="constant.FP_FMA.html"
  173. title='constant ocl::flags::FP_FMA'>FP_FMA</a></td>
  174. <td class='docblock-short'>
  175. </td>
  176. </tr>
  177. <tr class=' module-item'>
  178. <td><a class="constant" href="constant.FP_INF_NAN.html"
  179. title='constant ocl::flags::FP_INF_NAN'>FP_INF_NAN</a></td>
  180. <td class='docblock-short'>
  181. </td>
  182. </tr>
  183. <tr class=' module-item'>
  184. <td><a class="constant" href="constant.FP_ROUND_TO_INF.html"
  185. title='constant ocl::flags::FP_ROUND_TO_INF'>FP_ROUND_TO_INF</a></td>
  186. <td class='docblock-short'>
  187. </td>
  188. </tr>
  189. <tr class=' module-item'>
  190. <td><a class="constant" href="constant.FP_ROUND_TO_NEAREST.html"
  191. title='constant ocl::flags::FP_ROUND_TO_NEAREST'>FP_ROUND_TO_NEAREST</a></td>
  192. <td class='docblock-short'>
  193. </td>
  194. </tr>
  195. <tr class=' module-item'>
  196. <td><a class="constant" href="constant.FP_ROUND_TO_ZERO.html"
  197. title='constant ocl::flags::FP_ROUND_TO_ZERO'>FP_ROUND_TO_ZERO</a></td>
  198. <td class='docblock-short'>
  199. </td>
  200. </tr>
  201. <tr class=' module-item'>
  202. <td><a class="constant" href="constant.FP_SOFT_FLOAT.html"
  203. title='constant ocl::flags::FP_SOFT_FLOAT'>FP_SOFT_FLOAT</a></td>
  204. <td class='docblock-short'>
  205. </td>
  206. </tr>
  207. <tr class=' module-item'>
  208. <td><a class="constant" href="constant.KERNEL_ARG_TYPE_CONST.html"
  209. title='constant ocl::flags::KERNEL_ARG_TYPE_CONST'>KERNEL_ARG_TYPE_CONST</a></td>
  210. <td class='docblock-short'>
  211. </td>
  212. </tr>
  213. <tr class=' module-item'>
  214. <td><a class="constant" href="constant.KERNEL_ARG_TYPE_NONE.html"
  215. title='constant ocl::flags::KERNEL_ARG_TYPE_NONE'>KERNEL_ARG_TYPE_NONE</a></td>
  216. <td class='docblock-short'>
  217. </td>
  218. </tr>
  219. <tr class=' module-item'>
  220. <td><a class="constant" href="constant.KERNEL_ARG_TYPE_RESTRICT.html"
  221. title='constant ocl::flags::KERNEL_ARG_TYPE_RESTRICT'>KERNEL_ARG_TYPE_RESTRICT</a></td>
  222. <td class='docblock-short'>
  223. </td>
  224. </tr>
  225. <tr class=' module-item'>
  226. <td><a class="constant" href="constant.KERNEL_ARG_TYPE_VOLATILE.html"
  227. title='constant ocl::flags::KERNEL_ARG_TYPE_VOLATILE'>KERNEL_ARG_TYPE_VOLATILE</a></td>
  228. <td class='docblock-short'>
  229. </td>
  230. </tr>
  231. <tr class=' module-item'>
  232. <td><a class="constant" href="constant.MAP_READ.html"
  233. title='constant ocl::flags::MAP_READ'>MAP_READ</a></td>
  234. <td class='docblock-short'>
  235. </td>
  236. </tr>
  237. <tr class=' module-item'>
  238. <td><a class="constant" href="constant.MAP_WRITE.html"
  239. title='constant ocl::flags::MAP_WRITE'>MAP_WRITE</a></td>
  240. <td class='docblock-short'>
  241. </td>
  242. </tr>
  243. <tr class=' module-item'>
  244. <td><a class="constant" href="constant.MAP_WRITE_INVALIDATE_REGION.html"
  245. title='constant ocl::flags::MAP_WRITE_INVALIDATE_REGION'>MAP_WRITE_INVALIDATE_REGION</a></td>
  246. <td class='docblock-short'>
  247. </td>
  248. </tr>
  249. <tr class=' module-item'>
  250. <td><a class="constant" href="constant.MEM_ALLOC_HOST_PTR.html"
  251. title='constant ocl::flags::MEM_ALLOC_HOST_PTR'>MEM_ALLOC_HOST_PTR</a></td>
  252. <td class='docblock-short'>
  253. </td>
  254. </tr>
  255. <tr class=' module-item'>
  256. <td><a class="constant" href="constant.MEM_COPY_HOST_PTR.html"
  257. title='constant ocl::flags::MEM_COPY_HOST_PTR'>MEM_COPY_HOST_PTR</a></td>
  258. <td class='docblock-short'>
  259. </td>
  260. </tr>
  261. <tr class=' module-item'>
  262. <td><a class="constant" href="constant.MEM_HOST_NO_ACCESS.html"
  263. title='constant ocl::flags::MEM_HOST_NO_ACCESS'>MEM_HOST_NO_ACCESS</a></td>
  264. <td class='docblock-short'>
  265. </td>
  266. </tr>
  267. <tr class=' module-item'>
  268. <td><a class="constant" href="constant.MEM_HOST_READ_ONLY.html"
  269. title='constant ocl::flags::MEM_HOST_READ_ONLY'>MEM_HOST_READ_ONLY</a></td>
  270. <td class='docblock-short'>
  271. </td>
  272. </tr>
  273. <tr class=' module-item'>
  274. <td><a class="constant" href="constant.MEM_HOST_WRITE_ONLY.html"
  275. title='constant ocl::flags::MEM_HOST_WRITE_ONLY'>MEM_HOST_WRITE_ONLY</a></td>
  276. <td class='docblock-short'>
  277. </td>
  278. </tr>
  279. <tr class=' module-item'>
  280. <td><a class="constant" href="constant.MEM_READ_ONLY.html"
  281. title='constant ocl::flags::MEM_READ_ONLY'>MEM_READ_ONLY</a></td>
  282. <td class='docblock-short'>
  283. </td>
  284. </tr>
  285. <tr class=' module-item'>
  286. <td><a class="constant" href="constant.MEM_READ_WRITE.html"
  287. title='constant ocl::flags::MEM_READ_WRITE'>MEM_READ_WRITE</a></td>
  288. <td class='docblock-short'>
  289. </td>
  290. </tr>
  291. <tr class=' module-item'>
  292. <td><a class="constant" href="constant.MEM_USE_HOST_PTR.html"
  293. title='constant ocl::flags::MEM_USE_HOST_PTR'>MEM_USE_HOST_PTR</a></td>
  294. <td class='docblock-short'>
  295. </td>
  296. </tr>
  297. <tr class=' module-item'>
  298. <td><a class="constant" href="constant.MEM_WRITE_ONLY.html"
  299. title='constant ocl::flags::MEM_WRITE_ONLY'>MEM_WRITE_ONLY</a></td>
  300. <td class='docblock-short'>
  301. </td>
  302. </tr>
  303. <tr class=' module-item'>
  304. <td><a class="constant" href="constant.MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED.html"
  305. title='constant ocl::flags::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED'>MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED</a></td>
  306. <td class='docblock-short'>
  307. </td>
  308. </tr>
  309. <tr class=' module-item'>
  310. <td><a class="constant" href="constant.MIGRATE_MEM_OBJECT_HOST.html"
  311. title='constant ocl::flags::MIGRATE_MEM_OBJECT_HOST'>MIGRATE_MEM_OBJECT_HOST</a></td>
  312. <td class='docblock-short'>
  313. </td>
  314. </tr>
  315. <tr class=' module-item'>
  316. <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_COMPILED_OBJECT.html"
  317. title='constant ocl::flags::PROGRAM_BINARY_TYPE_COMPILED_OBJECT'>PROGRAM_BINARY_TYPE_COMPILED_OBJECT</a></td>
  318. <td class='docblock-short'>
  319. </td>
  320. </tr>
  321. <tr class=' module-item'>
  322. <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_EXECUTABLE.html"
  323. title='constant ocl::flags::PROGRAM_BINARY_TYPE_EXECUTABLE'>PROGRAM_BINARY_TYPE_EXECUTABLE</a></td>
  324. <td class='docblock-short'>
  325. </td>
  326. </tr>
  327. <tr class=' module-item'>
  328. <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_LIBRARY.html"
  329. title='constant ocl::flags::PROGRAM_BINARY_TYPE_LIBRARY'>PROGRAM_BINARY_TYPE_LIBRARY</a></td>
  330. <td class='docblock-short'>
  331. </td>
  332. </tr>
  333. <tr class=' module-item'>
  334. <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_NONE.html"
  335. title='constant ocl::flags::PROGRAM_BINARY_TYPE_NONE'>PROGRAM_BINARY_TYPE_NONE</a></td>
  336. <td class='docblock-short'>
  337. </td>
  338. </tr>
  339. <tr class=' module-item'>
  340. <td><a class="constant" href="constant.QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE.html"
  341. title='constant ocl::flags::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE'>QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE</a></td>
  342. <td class='docblock-short'>
  343. </td>
  344. </tr>
  345. <tr class=' module-item'>
  346. <td><a class="constant" href="constant.QUEUE_PROFILING_ENABLE.html"
  347. title='constant ocl::flags::QUEUE_PROFILING_ENABLE'>QUEUE_PROFILING_ENABLE</a></td>
  348. <td class='docblock-short'>
  349. </td>
  350. </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>&#9166;</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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ocl";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>