<!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">
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<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>
</nav>
<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#1441-1449' 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'>Methods</h2><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1451-1818' 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>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></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>fn <a href='#method.new' class='fnname'>new</a><'e, 'o, D, Q, En>(<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> dims: D, <br> host_data: <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">&[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, <br> fill_val: <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.tuple.html">(</a>T, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><En><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::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> 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>>,<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> En: <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/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a><'e>>, </span></code></span></h4>
<div class='docblock'><p>Creates a new buffer. <strong>[NOTE]: Use <code>::builder</code> instead now.</strong></p>
<p>See the <a href="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>
<p>[UNSTABLE]: Arguments may still be in a state of flux. It is
recommended to use <code>::builder</code> instead.</p>
</div><h4 id='method.from_gl_buffer' class="method"><span id='from_gl_buffer.v' class='invisible'><code>fn <a href='#method.from_gl_buffer' class='fnname'>from_gl_buffer</a><'o, D, 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> dims: D, <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/type.Result.html" title="type ocl::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> 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>>,<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></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="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>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></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="struct.BufferCmd">command builder documentation</a>
for more details.</p>
</div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>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></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="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>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></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="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>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></h4>
<div class='docblock'><p>Returns a command builder used to map data for reading or writing.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.BufferCmd#method.map">command builder documentation</a>
for more details.</p>
</div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><code>fn <a href='#method.copy' class='fnname'>copy</a><'c, M>(<br> &'c self, <br> dst_buffer: &'c 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></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="struct.BufferCmd#method.copy">command builder documentation</a>
for more details.</p>
</div><h4 id='method.origin' class="method"><span id='origin.v' class='invisible'><code>fn <a href='#method.origin' class='fnname'>origin</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="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>></code></span></h4>
<div class='docblock'><p>Returns the origin of the sub-buffer within its buffer if this is a
sub-buffer.</p>
</div><h4 id='method.dims' class="method"><span id='dims.v' class='invisible'><code>fn <a href='#method.dims' class='fnname'>dims</a>(&self) -> &<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span></h4>
<div class='docblock'><p>Returns the dimensions of the buffer.</p>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>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></h4>
<div class='docblock'><p>Returns the length of the buffer.</p>
<p>Equivalent to <code>::dims().to_len()</code>.</p>
</div><h4 id='method.is_sub_buffer' class="method"><span id='is_sub_buffer.v' class='invisible'><code>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></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>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="enum" href="../ocl/enums/enum.MemInfoResult.html" title="enum ocl::enums::MemInfoResult">MemInfoResult</a></code></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>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></h4>
<div class='docblock'><p>Changes the default queue used by this Buffer for reads and writes, etc.</p>
<p>Returns a mutable reference for optional chaining i.e.:</p>
<h3 id="example" class="section-header"><a href="#example">Example</a></h3>
<p><code>buffer.set_default_queue(queue).read(....);</code></p>
</div><h4 id='method.default_queue' class="method"><span id='default_queue.v' class='invisible'><code>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></h4>
<div class='docblock'><p>Returns a reference to the default queue.</p>
</div><h4 id='method.core_as_ref' class="method"><span id='core_as_ref.v' class='invisible'><code>fn <a href='#method.core_as_ref' class='fnname'>core_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></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 0.13.0<p>: Use <code>::core</code> instead.</p>
</div></div><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.core' class="method"><span id='core.v' class='invisible'><code>fn <a href='#method.core' class='fnname'>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></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>fn <a href='#method.flags' class='fnname'>flags</a>(&self) -> <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a></code></span></h4>
<div class='docblock'><p>Returns the memory flags used during the creation of this buffer.</p>
<p>Saves the cost of having to look them up using <code>::mem_info</code>.</p>
</div><h4 id='method.create_sub_buffer' class="method"><span id='create_sub_buffer.v' class='invisible'><code>fn <a href='#method.create_sub_buffer' class='fnname'>create_sub_buffer</a><Do, Ds>(<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> origin: Do, <br> dims: Ds<br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::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> Ds: <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></h4>
<div class='docblock'><p>Creates a new sub-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="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>origin</code> and <code>dims</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>origin</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>] struct.MemFlags.html#method.read_write</p>
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a><Target = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>></h2><div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>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></h4>
<div class='docblock'><p>Returns a pointer, do not store it.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1440' 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></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1440' 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></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: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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 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/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <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#1820-1826' 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/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/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></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 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/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <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#1828-1832' 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/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></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</div></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1834-1838' 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></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 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></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></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></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1846-1850' 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></h4>
</div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1858-1862' 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></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 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1864' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1865' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1866' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1867' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1868' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/buffer.rs.html#1869' 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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>