123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185 |
- <!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 `BufferSink` struct in crate `ocl`.">
- <meta name="keywords" content="rust, rustlang, rust-lang, BufferSink">
- <title>ocl::async::BufferSink - 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 BufferSink</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.from_buffer">from_buffer</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.flush">flush</a><a href="#method.buffer">buffer</a><a href="#method.memory">memory</a><a href="#method.default_offset">default_offset</a><a href="#method.default_len">default_len</a><a href="#method.as_mut_slice">as_mut_slice</a><a href="#method.id">id</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E">From<OrderLock<Inner<T>>></a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a></p><script>window.sidebarCurrent = {name: 'BufferSink', 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 href='index.html'>async</a>::<wbr><a class="struct" href=''>BufferSink</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/async/buffer_sink.rs.html#247-249' title='goto source code'>[src]</a></span></h1>
- <pre class='rust struct'>pub struct BufferSink<T: <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> { /* fields omitted */ }</pre><div class='docblock'><p>Represents mapped memory and allows frames of data to be 'flushed'
- (written) from host-accessible mapped memory region into its associated
- device-visible buffer in a repeated fashion.</p>
- <p>This represents the fastest possible method for continuously writing
- frames of data to a device.</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/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</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/async/buffer_sink.rs.html#251-370' title='goto source code'>[src]</a></span></h3>
- <div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(queue: <a class="struct" href="../../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#256-265' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a new <code>BufferSink</code>.</p>
- <p>The current thread will be blocked while the buffer is initialized
- upon calling this function.</p>
- </div><h4 id='method.from_buffer' class="method"><span id='from_buffer.v' class='invisible'><code>pub unsafe fn <a href='#method.from_buffer' class='fnname'>from_buffer</a>(<br> buffer: <a class="struct" href="../../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a><T>, <br> queue: <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>>, <br> default_offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> default_len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><<a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#273-308' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a new <code>BufferSink</code>.</p>
- <h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
- <p><code>buffer</code> must not have the same region mapped more than once.</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>(self) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>, <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#311-314' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>ReadGuard</code>.</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>(self) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#317-319' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>WriteGuard</code>.</p>
- </div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>pub fn <a href='#method.flush' class='fnname'>flush</a><'c>(self) -> FlushCmd<'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#323-325' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a command builder which, once enqueued, will flush data from
- the mapped memory region to the device.</p>
- </div><h4 id='method.buffer' class="method"><span id='buffer.v' class='invisible'><code>pub fn <a href='#method.buffer' class='fnname'>buffer</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/async/buffer_sink.rs.html#329-331' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a reference to the internal buffer.</p>
- </div><h4 id='method.memory' class="method"><span id='memory.v' class='invisible'><code>pub fn <a href='#method.memory' class='fnname'>memory</a>(&self) -> &<a class="struct" href="../../ocl_core/types/abs/struct.MemMap.html" title="struct ocl_core::types::abs::MemMap">MemMapCore</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#335-337' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a reference to the internal memory mapping.</p>
- </div><h4 id='method.default_offset' class="method"><span id='default_offset.v' class='invisible'><code>pub fn <a href='#method.default_offset' class='fnname'>default_offset</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/async/buffer_sink.rs.html#341-343' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a reference to the internal offset.</p>
- </div><h4 id='method.default_len' class="method"><span id='default_len.v' class='invisible'><code>pub fn <a href='#method.default_len' class='fnname'>default_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/async/buffer_sink.rs.html#347-349' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns the length of the memory region.</p>
- </div><h4 id='method.as_mut_slice' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='as_mut_slice.v' class='invisible'><code>pub unsafe fn <a href='#method.as_mut_slice' class='fnname'>as_mut_slice</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#359-363' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a mutable slice into the contained memory region.</p>
- <p>Used by buffer command builders when preparing future read and write
- commands.</p>
- <p>Do not use unless you are 100% certain that there will be no other
- reads or writes for the entire access duration (only possible if
- manually manipulating the lock status).</p>
- </div><h4 id='method.id' class="method"><span id='id.v' class='invisible'><code>pub fn <a href='#method.id' class='fnname'>id</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/async/buffer_sink.rs.html#367-369' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Returns a pointer address to the internal memory region, usable as a
- unique identifier.</p>
- </div></div>
- <h2 id='implementations' class='small-section-header'>
- Trait Implementations<a href='#implementations' class='anchor'></a>
- </h2>
- <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/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</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/async/buffer_sink.rs.html#246' 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/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#246' 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-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/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</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/async/buffer_sink.rs.html#246' 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/async/buffer_sink.rs.html#246' 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-From%3COrderLock%3CInner%3CT%3E%3E%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.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>> for <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T></code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#372-376' title='goto source code'>[src]</a></span></h3>
- <div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>) -> <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#373-375' title='goto source code'>[src]</a></span></h4>
- <div class='docblock'><p>Performs the conversion.</p>
- </div></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>
|