struct.Buffer.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  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 `Buffer` struct in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Buffer">
  9. <title>ocl::Buffer - 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 struct">
  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'>Struct Buffer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.builder">builder</a><a href="#method.new">new</a><a href="#method.from_gl_buffer">from_gl_buffer</a><a href="#method.cmd">cmd</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.map">map</a><a href="#method.copy">copy</a><a href="#method.offset">offset</a><a href="#method.len">len</a><a href="#method.is_sub_buffer">is_sub_buffer</a><a href="#method.mem_info">mem_info</a><a href="#method.set_default_queue">set_default_queue</a><a href="#method.default_queue">default_queue</a><a href="#method.as_core">as_core</a><a href="#method.flags">flags</a><a href="#method.create_sub_buffer">create_sub_buffer</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=MemCore&gt;</a><div class="sidebar-links"><a href="#method.as_ptr">as_ptr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-AsRef%3CMemCore%3E">AsRef&lt;MemCore&gt;</a><a href="#impl-AsMut%3CMemCore%3E">AsMut&lt;MemCore&gt;</a><a href="#impl-AsMem%3CT%3E">AsMem&lt;T&gt;</a><a href="#impl-Display">Display</a><a href="#impl-MemCmdRw">MemCmdRw</a><a href="#impl-MemCmdAll">MemCmdAll</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Buffer', ty: 'struct', 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'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Buffer</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#1659-1665' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'>pub struct Buffer&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A chunk of memory physically located on a device, such as a GPU.</p>
  51. <p>Data is stored remotely in a memory buffer on the device associated with
  52. <code>queue</code>.</p>
  53. </div>
  54. <h2 id='methods' class='small-section-header'>
  55. Methods<a href='#methods' class='anchor'></a>
  56. </h2>
  57. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1667-2081' title='goto source code'>[src]</a></span></h3>
  58. <div class='impl-items'><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>pub fn <a href='#method.builder' class='fnname'>builder</a>&lt;'a&gt;() -&gt; <a class="struct" href="../ocl/builders/struct.BufferBuilder.html" title="struct ocl::builders::BufferBuilder">BufferBuilder</a>&lt;'a, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1671-1673' title='goto source code'>[src]</a></span></h4>
  59. <div class='docblock'><p>Returns a new buffer builder.</p>
  60. <p>This is the preferred (and forward compatible) way to create a buffer.</p>
  61. </div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub unsafe fn <a href='#method.new' class='fnname'>new</a>&lt;'e, 'o, Q, D&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;que_ctx: Q, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;len: D, <br>&nbsp;&nbsp;&nbsp;&nbsp;host_slice: <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.slice.html">&amp;[T]</a>&gt;<br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;QueCtx&lt;'o&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1690-1725' title='goto source code'>[src]</a></span></h4>
  62. <div class='docblock'><p>Creates a new buffer.</p>
  63. <p>[UNSTABLE]: Arguments may still be in a state of flux. It is
  64. recommended to use <code>::builder</code> instead.</p>
  65. <p>See the <a href="builders/struct.BufferBuilder.html"><code>BufferBuilder</code></a> and <a href="https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateBuffer.html">SDK</a> documentation for argument
  66. details.</p>
  67. <h3 id="safety" class="section-header"><a href="#safety">Safety</a></h3>
  68. <p>Incorrectly using flags and/or host_slice is unsafe.</p>
  69. </div><h4 id='method.from_gl_buffer' class="method"><span id='from_gl_buffer.v' class='invisible'><code>pub fn <a href='#method.from_gl_buffer' class='fnname'>from_gl_buffer</a>&lt;'o, Q&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;que_ctx: Q, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags_opt: <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="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;gl_object: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;QueCtx&lt;'o&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1740-1765' title='goto source code'>[src]</a></span></h4>
  70. <div class='docblock'><p>Creates a buffer linked to a previously created OpenGL buffer object.</p>
  71. <p>[UNTESTED]</p>
  72. <h3 id="errors" class="section-header"><a href="#errors">Errors</a></h3>
  73. <p>Don't forget to <code>.cmd().gl_acquire().enq()</code> before using it and
  74. <code>.cmd().gl_release().enq()</code> after.</p>
  75. <p>See the <a href="builders/struct.BufferCmd.html"><code>BufferCmd</code> docs</a>
  76. for more info.</p>
  77. </div><h4 id='method.cmd' class="method"><span id='cmd.v' class='invisible'><code>pub fn <a href='#method.cmd' class='fnname'>cmd</a>&lt;'c&gt;(&amp;'c self) -&gt; <a class="struct" href="../ocl/builders/struct.BufferCmd.html" title="struct ocl::builders::BufferCmd">BufferCmd</a>&lt;'c, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1776-1778' title='goto source code'>[src]</a></span></h4>
  78. <div class='docblock'><p>Returns a command builder used to read, write, copy, etc.</p>
  79. <p>Call <code>.enq()</code> to enqueue the command.</p>
  80. <p>See the <a href="builders/struct.BufferCmd">command builder documentation</a>
  81. for more details.</p>
  82. </div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a>&lt;'c, 'd, R&gt;(&amp;'c self, dst: R) -&gt; <a class="struct" href="../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a>&lt;'c, 'd, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'d: 'c,<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;ReadDst&lt;'d, T&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1788-1792' title='goto source code'>[src]</a></span></h4>
  83. <div class='docblock'><p>Returns a command builder used to read data.</p>
  84. <p>Call <code>.enq()</code> to enqueue the command.</p>
  85. <p>See the <a href="builders/struct.BufferCmd#method.read">command builder documentation</a>
  86. for more details.</p>
  87. </div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a>&lt;'c, 'd, W&gt;(&amp;'c self, src: W) -&gt; <a class="struct" href="../ocl/builders/struct.BufferWriteCmd.html" title="struct ocl::builders::BufferWriteCmd">BufferWriteCmd</a>&lt;'c, 'd, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'d: 'c,<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;WriteSrc&lt;'d, T&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1802-1806' title='goto source code'>[src]</a></span></h4>
  88. <div class='docblock'><p>Returns a command builder used to write data.</p>
  89. <p>Call <code>.enq()</code> to enqueue the command.</p>
  90. <p>See the <a href="builders/struct.BufferCmd#method.write">command builder documentation</a>
  91. for more details.</p>
  92. </div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>pub fn <a href='#method.map' class='fnname'>map</a>&lt;'c&gt;(&amp;'c self) -&gt; <a class="struct" href="../ocl/builders/struct.BufferMapCmd.html" title="struct ocl::builders::BufferMapCmd">BufferMapCmd</a>&lt;'c, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1828-1830' title='goto source code'>[src]</a></span></h4>
  93. <div class='docblock'><p>Returns a command builder used to map data for reading or writing.</p>
  94. <p>Enqueuing a map command will map a region of a buffer into the host
  95. address space and return a <a href="struct.MemMap.html"><code>MemMap</code></a> or <a href="async/struct.FutureMemMap.html"><code>FutureMemMap</code></a>, allowing
  96. access to this mapped region. Accessing memory via a <a href="struct.MemMap.html"><code>MemMap</code></a> is
  97. exactly like using a <a href="https://doc.rust-lang.org/std/primitive.slice.html">slice</a>.</p>
  98. <p>Call <code>.enq()</code> to enqueue the command.</p>
  99. <h3 id="more-information" class="section-header"><a href="#more-information">More Information</a></h3>
  100. <p>See the <a href="builders/struct.BufferCmd#method.map">command builder
  101. documentation</a> or
  102. <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueMapBuffer.html">official SDK</a> for more details.</p>
  103. </div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><code>pub fn <a href='#method.copy' class='fnname'>copy</a>&lt;'c, M&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'c self, <br>&nbsp;&nbsp;&nbsp;&nbsp;dst_buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'c </a>M, <br>&nbsp;&nbsp;&nbsp;&nbsp;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;, <br>&nbsp;&nbsp;&nbsp;&nbsp;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;<br>) -&gt; <a class="struct" href="../ocl/builders/struct.BufferCmd.html" title="struct ocl::builders::BufferCmd">BufferCmd</a>&lt;'c, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a>&lt;T&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1840-1844' title='goto source code'>[src]</a></span></h4>
  104. <div class='docblock'><p>Specifies that this command will be a copy operation.</p>
  105. <p>Call <code>.enq()</code> to enqueue the command.</p>
  106. <p>See the <a href="builders/struct.BufferCmd#method.copy">command builder documentation</a>
  107. for more details.</p>
  108. </div><h4 id='method.offset' class="method"><span id='offset.v' class='invisible'><code>pub fn <a href='#method.offset' class='fnname'>offset</a>(&amp;self) -&gt; <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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1856-1866' title='goto source code'>[src]</a></span></h4>
  109. <div class='docblock'><p>Returns the offset of the sub-buffer within its buffer if this is a
  110. sub-buffer.</p>
  111. </div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1870-1872' title='goto source code'>[src]</a></span></h4>
  112. <div class='docblock'><p>Returns the length of the buffer.</p>
  113. </div><h4 id='method.is_sub_buffer' class="method"><span id='is_sub_buffer.v' class='invisible'><code>pub fn <a href='#method.is_sub_buffer' class='fnname'>is_sub_buffer</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1884-1899' title='goto source code'>[src]</a></span></h4>
  114. <div class='docblock'><p>Returns true if this is a sub-buffer.</p>
  115. </div><h4 id='method.mem_info' class="method"><span id='mem_info.v' class='invisible'><code>pub fn <a href='#method.mem_info' class='fnname'>mem_info</a>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.MemInfo.html" title="enum ocl::enums::MemInfo">MemInfo</a>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.MemInfoResult.html" title="enum ocl::enums::MemInfoResult">MemInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1903-1905' title='goto source code'>[src]</a></span></h4>
  116. <div class='docblock'><p>Returns info about the underlying memory object.</p>
  117. </div><h4 id='method.set_default_queue' class="method"><span id='set_default_queue.v' class='invisible'><code>pub fn <a href='#method.set_default_queue' class='fnname'>set_default_queue</a>&lt;'a&gt;(&amp;'a mut self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -&gt; &amp;'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1940-1946' title='goto source code'>[src]</a></span></h4>
  118. <div class='docblock'><p>Changes the default queue used by this buffer for all subsequent
  119. command enqueue operations (reads, writes, etc.).</p>
  120. <p>The default queue is the queue which will be used when enqueuing
  121. commands if no queue is specified.</p>
  122. <p>Without a default queue:</p>
  123. <div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
  124. <span class="ident">buffer</span>.<span class="ident">read</span>(<span class="ident">data</span>).<span class="ident">queue</span>(<span class="kw-2">&amp;</span><span class="ident">queue</span>).<span class="ident">enq</span>()<span class="question-mark">?</span>;</pre>
  125. <p>With a default queue:</p>
  126. <div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
  127. <span class="ident">buffer</span>.<span class="ident">set_default_queue</span>(<span class="ident">queue</span>.<span class="ident">clone</span>());
  128. <span class="ident">buffer</span>.<span class="ident">read</span>(<span class="ident">data</span>).<span class="ident">enq</span>()<span class="question-mark">?</span>;</pre>
  129. <p>The default queue can also be set when creating a buffer by using the
  130. <a href="builders/struct.BufferBuilder.html#method.queue"><code>BufferBuilder::queue</code></a> method.</p>
  131. <p>This method returns a mutable reference for optional chaining i.e.:</p>
  132. <div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
  133. <span class="ident">buffer</span>.<span class="ident">set_default_queue</span>(<span class="ident">queue</span>).<span class="ident">read</span>(....)...;</pre>
  134. </div><h4 id='method.default_queue' class="method"><span id='default_queue.v' class='invisible'><code>pub fn <a href='#method.default_queue' class='fnname'>default_queue</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1953-1955' title='goto source code'>[src]</a></span></h4>
  135. <div class='docblock'><p>Returns a reference to the default queue.</p>
  136. <p>The default queue is the queue which will be used when enqueuing
  137. commands if no queue is specified.</p>
  138. </div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>pub fn <a href='#method.as_core' class='fnname'>as_core</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1961-1963' title='goto source code'>[src]</a></span></h4>
  139. <div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
  140. the <code>core</code> module.</p>
  141. </div><h4 id='method.flags' class="method"><span id='flags.v' class='invisible'><code>pub fn <a href='#method.flags' class='fnname'>flags</a>(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1968-1973' title='goto source code'>[src]</a></span></h4>
  142. <div class='docblock'><p>Returns the memory flags used during the creation of this buffer.</p>
  143. </div><h4 id='method.create_sub_buffer' class="method"><span id='create_sub_buffer.v' class='invisible'><code>pub fn <a href='#method.create_sub_buffer' class='fnname'>create_sub_buffer</a>&lt;Do, Dl&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags_opt: <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="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;offset: Do, <br>&nbsp;&nbsp;&nbsp;&nbsp;len: Dl<br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Do: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Dl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2021-2064' title='goto source code'>[src]</a></span></h4>
  144. <div class='docblock'><p>Creates a new sub-buffer from a region of this buffer.</p>
  145. <h3 id="flags-adapted-from-sdk" class="section-header"><a href="#flags-adapted-from-sdk">Flags (adapted from <a href="https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateSubBuffer.html">SDK</a>)</a></h3>
  146. <p>[NOTE]: Flags described below can be found in the <a href="flags/index.html"><code>ocl::flags</code></a> module
  147. or within the <a href="flags/struct.MemFlags.html"><code>MemFlags</code></a> type (example:
  148. [<code>MemFlags::new().read_write()</code>]).</p>
  149. <p><code>flags</code>: A bit-field that is used to specify allocation and usage
  150. information about the sub-buffer memory object being created and is
  151. described in the table below. If the <code>MEM_READ_WRITE</code>, <code>MEM_READ_ONLY</code>
  152. or <code>MEM_WRITE_ONLY</code> values are not specified in flags, they are
  153. inherited from the corresponding memory access qualifers associated
  154. with buffer. The <code>MEM_USE_HOST_PTR</code>, <code>MEM_ALLOC_HOST_PTR</code> and
  155. <code>MEM_COPY_HOST_PTR</code> values cannot be specified in flags but are
  156. inherited from the corresponding memory access qualifiers associated
  157. with buffer. If <code>MEM_COPY_HOST_PTR</code> is specified in the memory access
  158. qualifier values associated with buffer it does not imply any
  159. additional copies when the sub-buffer is created from buffer. If the
  160. <code>MEM_HOST_WRITE_ONLY</code>, <code>MEM_HOST_READ_ONLY</code> or <code>MEM_HOST_NO_ACCESS</code>
  161. values are not specified in flags, they are inherited from the
  162. corresponding memory access qualifiers associated with buffer.</p>
  163. <h3 id="offset-and-dimensions" class="section-header"><a href="#offset-and-dimensions">Offset and Dimensions</a></h3>
  164. <p><code>offset</code> and <code>len</code> set up the region of the sub-buffer within the
  165. original buffer and must not fall beyond the boundaries of it.</p>
  166. <p><code>offset</code> must be a multiple of the <code>DeviceInfo::MemBaseAddrAlign</code>
  167. otherwise you will get a <code>CL_MISALIGNED_SUB_BUFFER_OFFSET</code> error. To
  168. determine, use <code>Device::mem_base_addr_align</code> for the device associated
  169. with the queue which will be use with this sub-buffer.</p>
  170. <p>[<code>MemFlags::new().read_write()</code>] flags/struct.MemFlags.html#method.read_write</p>
  171. </div></div>
  172. <h2 id='deref-methods' class='small-section-header'>
  173. Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>&gt;<a href='#deref-methods' class='anchor'></a>
  174. </h2>
  175. <div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>pub fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&amp;self) -&gt; <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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#693-695' title='goto source code'>[src]</a></span></h4>
  176. <div class='docblock'><p>Returns a pointer, do not store it.</p>
  177. </div></div>
  178. <h2 id='implementations' class='small-section-header'>
  179. Trait Implementations<a href='#implementations' class='anchor'></a>
  180. </h2>
  181. <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1658' title='goto source code'>[src]</a></span></h3>
  182. <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>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1658' title='goto source code'>[src]</a></span></h4>
  183. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  184. </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1658' title='goto source code'>[src]</a></span></h3>
  185. <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>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1658' title='goto source code'>[src]</a></span></h4>
  186. <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>
  187. </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>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
  188. <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>
  189. </div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2083-2089' title='goto source code'>[src]</a></span></h3>
  190. <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/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></h4>
  191. <div class='docblock'><p>The resulting type after dereferencing.</p>
  192. </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/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2086-2088' title='goto source code'>[src]</a></span></h4>
  193. <div class='docblock'><p>Dereferences the value.</p>
  194. </div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2091-2095' title='goto source code'>[src]</a></span></h3>
  195. <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/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2092-2094' title='goto source code'>[src]</a></span></h4>
  196. <div class='docblock'><p>Mutably dereferences the value.</p>
  197. </div></div><h3 id='impl-AsRef%3CMemCore%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>&gt; for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-AsRef%3CMemCore%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2097-2101' title='goto source code'>[src]</a></span></h3>
  198. <div class='impl-items'><h4 id='method.as_ref' class="method"><span id='as_ref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref' class='fnname'>as_ref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2098-2100' title='goto source code'>[src]</a></span></h4>
  199. <div class='docblock'><p>Performs the conversion.</p>
  200. </div></div><h3 id='impl-AsMut%3CMemCore%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>&gt; for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-AsMut%3CMemCore%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2103-2107' title='goto source code'>[src]</a></span></h3>
  201. <div class='impl-items'><h4 id='method.as_mut' class="method"><span id='as_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html#tymethod.as_mut' class='fnname'>as_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2104-2106' title='goto source code'>[src]</a></span></h4>
  202. <div class='docblock'><p>Performs the conversion.</p>
  203. </div></div><h3 id='impl-AsMem%3CT%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a>&lt;T&gt; for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-AsMem%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2109-2113' title='goto source code'>[src]</a></span></h3>
  204. <div class='impl-items'><h4 id='method.as_mem' class="method"><span id='as_mem.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.AsMem.html#tymethod.as_mem' class='fnname'>as_mem</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2110-2112' title='goto source code'>[src]</a></span></h4>
  205. </div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;</code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2116-2120' title='goto source code'>[src]</a></span></h3>
  206. <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>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2117-2119' title='goto source code'>[src]</a></span></h4>
  207. <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>
  208. </div></div><h3 id='impl-MemCmdRw' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdRw' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2122' title='goto source code'>[src]</a></span></h3>
  209. <div class='impl-items'></div><h3 id='impl-MemCmdRw-1' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &amp;'a <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdRw-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2123' title='goto source code'>[src]</a></span></h3>
  210. <div class='impl-items'></div><h3 id='impl-MemCmdRw-2' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &amp;'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdRw-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2124' title='goto source code'>[src]</a></span></h3>
  211. <div class='impl-items'></div><h3 id='impl-MemCmdAll' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdAll' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2125' title='goto source code'>[src]</a></span></h3>
  212. <div class='impl-items'></div><h3 id='impl-MemCmdAll-1' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &amp;'a <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdAll-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2126' title='goto source code'>[src]</a></span></h3>
  213. <div class='impl-items'></div><h3 id='impl-MemCmdAll-2' class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &amp;'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code><a href='#impl-MemCmdAll-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#2127' title='goto source code'>[src]</a></span></h3>
  214. <div class='impl-items'></div></section>
  215. <section id='search' class="content hidden"></section>
  216. <section class="footer"></section>
  217. <aside id="help" class="hidden">
  218. <div>
  219. <h1 class="hidden">Help</h1>
  220. <div class="shortcuts">
  221. <h2>Keyboard Shortcuts</h2>
  222. <dl>
  223. <dt><kbd>?</kbd></dt>
  224. <dd>Show this help dialog</dd>
  225. <dt><kbd>S</kbd></dt>
  226. <dd>Focus the search field</dd>
  227. <dt><kbd>↑</kbd></dt>
  228. <dd>Move up in search results</dd>
  229. <dt><kbd>↓</kbd></dt>
  230. <dd>Move down in search results</dd>
  231. <dt><kbd>↹</kbd></dt>
  232. <dd>Switch tab</dd>
  233. <dt><kbd>&#9166;</kbd></dt>
  234. <dd>Go to active search result</dd>
  235. <dt><kbd>+</kbd></dt>
  236. <dd>Expand all sections</dd>
  237. <dt><kbd>-</kbd></dt>
  238. <dd>Collapse all sections</dd>
  239. </dl>
  240. </div>
  241. <div class="infos">
  242. <h2>Search Tricks</h2>
  243. <p>
  244. Prefix searches with a type followed by a colon (e.g.
  245. <code>fn:</code>) to restrict the search to a given type.
  246. </p>
  247. <p>
  248. Accepted types are: <code>fn</code>, <code>mod</code>,
  249. <code>struct</code>, <code>enum</code>,
  250. <code>trait</code>, <code>type</code>, <code>macro</code>,
  251. and <code>const</code>.
  252. </p>
  253. <p>
  254. Search functions by type signature (e.g.
  255. <code>vec -> usize</code> or <code>* -> vec</code>)
  256. </p>
  257. </div>
  258. </div>
  259. </aside>
  260. <script>
  261. window.rootPath = "../";
  262. window.currentCrate = "ocl";
  263. </script>
  264. <script src="../main.js"></script>
  265. <script defer src="../search-index.js"></script>
  266. </body>
  267. </html>