123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294 |
- <!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 `Buffer` struct in crate `ocl`.">
- <meta name="keywords" content="rust, rustlang, rust-lang, Buffer">
- <title>ocl::Buffer - 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 struct">
- <!--[if lte IE 8]>
- <div class="warning">
- This old browser is unsupported and will most likely display funky
- things.
- </div>
- <![endif]-->
-
- <nav class="sidebar">
- <div class="sidebar-menu">☰</div>
-
- <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<Target=MemCore></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<MemCore></a><a href="#impl-AsMut%3CMemCore%3E">AsMut<MemCore></a><a href="#impl-AsMem%3CT%3E">AsMem<T></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>
- </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'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Buffer</a></span><span class='out-of-band'><span id='render-detail'>
- <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
- [<span class='inner'>−</span>]
- </a>
- </span><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1659-1665' title='goto source code'>[src]</a></span></h1>
- <pre class='rust struct'>pub struct Buffer<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> { /* fields omitted */ }</pre><div class='docblock'><p>A chunk of memory physically located on a device, such as a GPU.</p>
- <p>Data is stored remotely in a memory buffer on the device associated with
- <code>queue</code>.</p>
- </div>
- <h2 id='methods' class='small-section-header'>
- Methods<a href='#methods' class='anchor'></a>
- </h2>
- <h3 id='impl' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <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><'a>() -> <a class="struct" href="../ocl/builders/struct.BufferBuilder.html" title="struct ocl::builders::BufferBuilder">BufferBuilder</a><'a, T></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>
- <div class='docblock'><p>Returns a new buffer builder.</p>
- <p>This is the preferred (and forward compatible) way to create a buffer.</p>
- </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><'e, 'o, Q, D>(<br> que_ctx: Q, <br> flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br> len: D, <br> host_slice: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a>><br>) -> <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><QueCtx<'o>>,<br> D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>, </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>
- <div class='docblock'><p>Creates a new buffer.</p>
- <p>[UNSTABLE]: Arguments may still be in a state of flux. It is
- recommended to use <code>::builder</code> instead.</p>
- <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
- details.</p>
- <h3 id="safety" class="section-header"><a href="#safety">Safety</a></h3>
- <p>Incorrectly using flags and/or host_slice is unsafe.</p>
- </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><'o, Q>(<br> que_ctx: Q, <br> flags_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>>, <br> gl_object: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -> <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><QueCtx<'o>>, </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>
- <div class='docblock'><p>Creates a buffer linked to a previously created OpenGL buffer object.</p>
- <p>[UNTESTED]</p>
- <h3 id="errors" class="section-header"><a href="#errors">Errors</a></h3>
- <p>Don't forget to <code>.cmd().gl_acquire().enq()</code> before using it and
- <code>.cmd().gl_release().enq()</code> after.</p>
- <p>See the <a href="builders/struct.BufferCmd.html"><code>BufferCmd</code> docs</a>
- for more info.</p>
- </div><h4 id='method.cmd' class="method"><span id='cmd.v' class='invisible'><code>pub fn <a href='#method.cmd' class='fnname'>cmd</a><'c>(&'c self) -> <a class="struct" href="../ocl/builders/struct.BufferCmd.html" title="struct ocl::builders::BufferCmd">BufferCmd</a><'c, T></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>
- <div class='docblock'><p>Returns a command builder used to read, write, copy, etc.</p>
- <p>Call <code>.enq()</code> to enqueue the command.</p>
- <p>See the <a href="builders/struct.BufferCmd">command builder documentation</a>
- for more details.</p>
- </div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a><'c, 'd, R>(&'c self, dst: R) -> <a class="struct" href="../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'd: 'c,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><ReadDst<'d, T>>, </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>
- <div class='docblock'><p>Returns a command builder used to read data.</p>
- <p>Call <code>.enq()</code> to enqueue the command.</p>
- <p>See the <a href="builders/struct.BufferCmd#method.read">command builder documentation</a>
- for more details.</p>
- </div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a><'c, 'd, W>(&'c self, src: W) -> <a class="struct" href="../ocl/builders/struct.BufferWriteCmd.html" title="struct ocl::builders::BufferWriteCmd">BufferWriteCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'd: 'c,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><WriteSrc<'d, T>>, </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>
- <div class='docblock'><p>Returns a command builder used to write data.</p>
- <p>Call <code>.enq()</code> to enqueue the command.</p>
- <p>See the <a href="builders/struct.BufferCmd#method.write">command builder documentation</a>
- for more details.</p>
- </div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>pub fn <a href='#method.map' class='fnname'>map</a><'c>(&'c self) -> <a class="struct" href="../ocl/builders/struct.BufferMapCmd.html" title="struct ocl::builders::BufferMapCmd">BufferMapCmd</a><'c, T></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>
- <div class='docblock'><p>Returns a command builder used to map data for reading or writing.</p>
- <p>Enqueuing a map command will map a region of a buffer into the host
- 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
- access to this mapped region. Accessing memory via a <a href="struct.MemMap.html"><code>MemMap</code></a> is
- exactly like using a <a href="https://doc.rust-lang.org/std/primitive.slice.html">slice</a>.</p>
- <p>Call <code>.enq()</code> to enqueue the command.</p>
- <h3 id="more-information" class="section-header"><a href="#more-information">More Information</a></h3>
- <p>See the <a href="builders/struct.BufferCmd#method.map">command builder
- documentation</a> or
- <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueMapBuffer.html">official SDK</a> for more details.</p>
- </div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><code>pub fn <a href='#method.copy' class='fnname'>copy</a><'c, M>(<br> &'c self, <br> dst_buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'c </a>M, <br> dst_offset: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>, <br> len: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>><br>) -> <a class="struct" href="../ocl/builders/struct.BufferCmd.html" title="struct ocl::builders::BufferCmd">BufferCmd</a><'c, T> <span class="where fmt-newline">where<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T>, </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>
- <div class='docblock'><p>Specifies that this command will be a copy operation.</p>
- <p>Call <code>.enq()</code> to enqueue the command.</p>
- <p>See the <a href="builders/struct.BufferCmd#method.copy">command builder documentation</a>
- for more details.</p>
- </div><h4 id='method.offset' class="method"><span id='offset.v' class='invisible'><code>pub fn <a href='#method.offset' class='fnname'>offset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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#1856-1866' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns the offset of the sub-buffer within its buffer if this is a
- sub-buffer.</p>
- </div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&self) -> <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>
- <div class='docblock'><p>Returns the length of the buffer.</p>
- </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>(&self) -> <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>
- <div class='docblock'><p>Returns true if this is a sub-buffer.</p>
- </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>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.MemInfo.html" title="enum ocl::enums::MemInfo">MemInfo</a>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="enum" href="../ocl/enums/enum.MemInfoResult.html" title="enum ocl::enums::MemInfoResult">MemInfoResult</a>></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>
- <div class='docblock'><p>Returns info about the underlying memory object.</p>
- </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><'a>(&'a mut self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> &'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <div class='docblock'><p>Changes the default queue used by this buffer for all subsequent
- command enqueue operations (reads, writes, etc.).</p>
- <p>The default queue is the queue which will be used when enqueuing
- commands if no queue is specified.</p>
- <p>Without a default queue:</p>
- <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">
- <span class="ident">buffer</span>.<span class="ident">read</span>(<span class="ident">data</span>).<span class="ident">queue</span>(<span class="kw-2">&</span><span class="ident">queue</span>).<span class="ident">enq</span>()<span class="question-mark">?</span>;</pre>
- <p>With a default queue:</p>
- <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">
- <span class="ident">buffer</span>.<span class="ident">set_default_queue</span>(<span class="ident">queue</span>.<span class="ident">clone</span>());
- <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>
- <p>The default queue can also be set when creating a buffer by using the
- <a href="builders/struct.BufferBuilder.html#method.queue"><code>BufferBuilder::queue</code></a> method.</p>
- <p>This method returns a mutable reference for optional chaining i.e.:</p>
- <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">
- <span class="ident">buffer</span>.<span class="ident">set_default_queue</span>(<span class="ident">queue</span>).<span class="ident">read</span>(....)...;</pre>
- </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>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>></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>
- <div class='docblock'><p>Returns a reference to the default queue.</p>
- <p>The default queue is the queue which will be used when enqueuing
- commands if no queue is specified.</p>
- </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>(&self) -> &<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>
- <div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
- the <code>core</code> module.</p>
- </div><h4 id='method.flags' class="method"><span id='flags.v' class='invisible'><code>pub fn <a href='#method.flags' class='fnname'>flags</a>(&self) -> <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>></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>
- <div class='docblock'><p>Returns the memory flags used during the creation of this buffer.</p>
- </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><Do, Dl>(<br> &self, <br> flags_opt: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>>, <br> offset: Do, <br> len: Dl<br>) -> <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T>> <span class="where fmt-newline">where<br> Do: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>,<br> Dl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>>, </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>
- <div class='docblock'><p>Creates a new sub-buffer from a region of this buffer.</p>
- <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>
- <p>[NOTE]: Flags described below can be found in the <a href="flags/index.html"><code>ocl::flags</code></a> module
- or within the <a href="flags/struct.MemFlags.html"><code>MemFlags</code></a> type (example:
- [<code>MemFlags::new().read_write()</code>]).</p>
- <p><code>flags</code>: A bit-field that is used to specify allocation and usage
- information about the sub-buffer memory object being created and is
- described in the table below. If the <code>MEM_READ_WRITE</code>, <code>MEM_READ_ONLY</code>
- or <code>MEM_WRITE_ONLY</code> values are not specified in flags, they are
- inherited from the corresponding memory access qualifers associated
- with buffer. The <code>MEM_USE_HOST_PTR</code>, <code>MEM_ALLOC_HOST_PTR</code> and
- <code>MEM_COPY_HOST_PTR</code> values cannot be specified in flags but are
- inherited from the corresponding memory access qualifiers associated
- with buffer. If <code>MEM_COPY_HOST_PTR</code> is specified in the memory access
- qualifier values associated with buffer it does not imply any
- additional copies when the sub-buffer is created from buffer. If the
- <code>MEM_HOST_WRITE_ONLY</code>, <code>MEM_HOST_READ_ONLY</code> or <code>MEM_HOST_NO_ACCESS</code>
- values are not specified in flags, they are inherited from the
- corresponding memory access qualifiers associated with buffer.</p>
- <h3 id="offset-and-dimensions" class="section-header"><a href="#offset-and-dimensions">Offset and Dimensions</a></h3>
- <p><code>offset</code> and <code>len</code> set up the region of the sub-buffer within the
- original buffer and must not fall beyond the boundaries of it.</p>
- <p><code>offset</code> must be a multiple of the <code>DeviceInfo::MemBaseAddrAlign</code>
- otherwise you will get a <code>CL_MISALIGNED_SUB_BUFFER_OFFSET</code> error. To
- determine, use <code>Device::mem_base_addr_align</code> for the device associated
- with the queue which will be use with this sub-buffer.</p>
- <p>[<code>MemFlags::new().read_write()</code>] flags/struct.MemFlags.html#method.read_write</p>
- </div></div>
- <h2 id='deref-methods' class='small-section-header'>
- 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><Target = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>><a href='#deref-methods' class='anchor'></a>
- </h2>
- <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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span><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>
- <div class='docblock'><p>Returns a pointer, do not store it.</p>
- </div></div>
- <h2 id='implementations' class='small-section-header'>
- Trait Implementations<a href='#implementations' class='anchor'></a>
- </h2>
- <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T: <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>> <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><T></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>
- <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><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>
- <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>
- </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<T: <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>> <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><T></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>
- <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
- </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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>
- <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
- </div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <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><T></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>
- <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>
- <div class='docblock'><p>The resulting type after dereferencing.</p>
- </div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<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>
- <div class='docblock'><p>Dereferences the value.</p>
- </div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <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><T></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>
- <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>(&mut self) -> &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>
- <div class='docblock'><p>Mutably dereferences the value.</p>
- </div></div><h3 id='impl-AsRef%3CMemCore%3E' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <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>(&self) -> &<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>
- <div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-AsMut%3CMemCore%3E' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <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>(&mut self) -> &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>
- <div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-AsMem%3CT%3E' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> for <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T></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>
- <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>(&self) -> &<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>
- </div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <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><T></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>
- <div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><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>
- <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
- </div></div><h3 id='impl-MemCmdRw' class='impl'><span class='in-band'><code>impl<'a, T> <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><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div><h3 id='impl-MemCmdRw-1' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &'a <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div><h3 id='impl-MemCmdRw-2' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div><h3 id='impl-MemCmdAll' class='impl'><span class='in-band'><code>impl<'a, T> <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><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div><h3 id='impl-MemCmdAll-1' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &'a <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div><h3 id='impl-MemCmdAll-2' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &'a mut <a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </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>
- <div class='impl-items'></div></section>
- <section id='search' class="content hidden"></section>
- <section class="footer"></section>
- <aside id="help" class="hidden">
- <div>
- <h1 class="hidden">Help</h1>
- <div class="shortcuts">
- <h2>Keyboard Shortcuts</h2>
- <dl>
- <dt><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>
|