enum.BufferCmdKind.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `BufferCmdKind` enum in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, BufferCmdKind">
  9. <title>ocl::builders::BufferCmdKind - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. </head>
  16. <body class="rustdoc enum">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Enum BufferCmdKind</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Unspecified">Unspecified</a><a href="#variant.Read">Read</a><a href="#variant.Write">Write</a><a href="#variant.Map">Map</a><a href="#variant.Copy">Copy</a><a href="#variant.Fill">Fill</a><a href="#variant.CopyToImage">CopyToImage</a><a href="#variant.GLAcquire">GLAcquire</a><a href="#variant.GLRelease">GLRelease</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'BufferCmdKind', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>builders</a>::<wbr><a class="enum" href=''>BufferCmdKind</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../../src/ocl/standard/buffer.rs.html#101-111' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust enum'>pub enum BufferCmdKind&lt;'c, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'c,&nbsp;</span> {
  51. Unspecified,
  52. Read,
  53. Write,
  54. Map,
  55. Copy {
  56. dst_buffer: &amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>,
  57. dst_offset: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;,
  58. len: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;,
  59. },
  60. Fill {
  61. pattern: T,
  62. len: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;,
  63. },
  64. CopyToImage {
  65. image: &amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>,
  66. dst_origin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>,
  67. region: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>,
  68. },
  69. GLAcquire,
  70. GLRelease,
  71. }</pre><div class='docblock'><p>The type of operation to be performed by a command.</p>
  72. </div><h2 id='variants' class='variants small-section-header'>
  73. Variants<a href='#variants' class='anchor'></a></h2>
  74. <span id="variant.Unspecified" class="variant small-section-header"><a href="#variant.Unspecified" class="anchor field"></a><span id='Unspecified.v' class='invisible'><code>Unspecified</code></span></span><span id="variant.Read" class="variant small-section-header"><a href="#variant.Read" class="anchor field"></a><span id='Read.v' class='invisible'><code>Read</code></span></span><span id="variant.Write" class="variant small-section-header"><a href="#variant.Write" class="anchor field"></a><span id='Write.v' class='invisible'><code>Write</code></span></span><span id="variant.Map" class="variant small-section-header"><a href="#variant.Map" class="anchor field"></a><span id='Map.v' class='invisible'><code>Map</code></span></span><span id="variant.Copy" class="variant small-section-header"><a href="#variant.Copy" class="anchor field"></a><span id='Copy.v' class='invisible'><code>Copy</code></span></span><span class='docblock autohide sub-variant' id='variant.Copy.fields'><h3 class='fields'>Fields of <code>Copy</code></h3>
  75. <table><tr><td id='variant.Copy.field.dst_buffer'><span id='Copy.v.dst_buffer.v' class='invisible'><code>dst_buffer:&nbsp;&amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></td><td></td></tr><tr><td id='variant.Copy.field.dst_offset'><span id='Copy.v.dst_offset.v' class='invisible'><code>dst_offset:&nbsp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td></td></tr><tr><td id='variant.Copy.field.len'><span id='Copy.v.len.v' class='invisible'><code>len:&nbsp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td></td></tr></table></span><span id="variant.Fill" class="variant small-section-header"><a href="#variant.Fill" class="anchor field"></a><span id='Fill.v' class='invisible'><code>Fill</code></span></span><span class='docblock autohide sub-variant' id='variant.Fill.fields'><h3 class='fields'>Fields of <code>Fill</code></h3>
  76. <table><tr><td id='variant.Fill.field.pattern'><span id='Fill.v.pattern.v' class='invisible'><code>pattern:&nbsp;T</code></span></td><td></td></tr><tr><td id='variant.Fill.field.len'><span id='Fill.v.len.v' class='invisible'><code>len:&nbsp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></td><td></td></tr></table></span><span id="variant.CopyToImage" class="variant small-section-header"><a href="#variant.CopyToImage" class="anchor field"></a><span id='CopyToImage.v' class='invisible'><code>CopyToImage</code></span></span><span class='docblock autohide sub-variant' id='variant.CopyToImage.fields'><h3 class='fields'>Fields of <code>CopyToImage</code></h3>
  77. <table><tr><td id='variant.CopyToImage.field.image'><span id='CopyToImage.v.image.v' class='invisible'><code>image:&nbsp;&amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></td><td></td></tr><tr><td id='variant.CopyToImage.field.dst_origin'><span id='CopyToImage.v.dst_origin.v' class='invisible'><code>dst_origin:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a></code></span></td><td></td></tr><tr><td id='variant.CopyToImage.field.region'><span id='CopyToImage.v.region.v' class='invisible'><code>region:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a></code></span></td><td></td></tr></table></span><span id="variant.GLAcquire" class="variant small-section-header"><a href="#variant.GLAcquire" class="anchor field"></a><span id='GLAcquire.v' class='invisible'><code>GLAcquire</code></span></span><span id="variant.GLRelease" class="variant small-section-header"><a href="#variant.GLRelease" class="anchor field"></a><span id='GLRelease.v' class='invisible'><code>GLRelease</code></span></span></section>
  78. <section id='search' class="content hidden"></section>
  79. <section class="footer"></section>
  80. <aside id="help" class="hidden">
  81. <div>
  82. <h1 class="hidden">Help</h1>
  83. <div class="shortcuts">
  84. <h2>Keyboard Shortcuts</h2>
  85. <dl>
  86. <dt><kbd>?</kbd></dt>
  87. <dd>Show this help dialog</dd>
  88. <dt><kbd>S</kbd></dt>
  89. <dd>Focus the search field</dd>
  90. <dt><kbd>↑</kbd></dt>
  91. <dd>Move up in search results</dd>
  92. <dt><kbd>↓</kbd></dt>
  93. <dd>Move down in search results</dd>
  94. <dt><kbd>↹</kbd></dt>
  95. <dd>Switch tab</dd>
  96. <dt><kbd>&#9166;</kbd></dt>
  97. <dd>Go to active search result</dd>
  98. <dt><kbd>+</kbd></dt>
  99. <dd>Expand all sections</dd>
  100. <dt><kbd>-</kbd></dt>
  101. <dd>Collapse all sections</dd>
  102. </dl>
  103. </div>
  104. <div class="infos">
  105. <h2>Search Tricks</h2>
  106. <p>
  107. Prefix searches with a type followed by a colon (e.g.
  108. <code>fn:</code>) to restrict the search to a given type.
  109. </p>
  110. <p>
  111. Accepted types are: <code>fn</code>, <code>mod</code>,
  112. <code>struct</code>, <code>enum</code>,
  113. <code>trait</code>, <code>type</code>, <code>macro</code>,
  114. and <code>const</code>.
  115. </p>
  116. <p>
  117. Search functions by type signature (e.g.
  118. <code>vec -> usize</code> or <code>* -> vec</code>)
  119. </p>
  120. </div>
  121. </div>
  122. </aside>
  123. <script>
  124. window.rootPath = "../../";
  125. window.currentCrate = "ocl";
  126. </script>
  127. <script src="../../main.js"></script>
  128. <script defer src="../../search-index.js"></script>
  129. </body>
  130. </html>