clfft 0.3.2

Bindings for clFFT, a FFT library for OpenCL.
Documentation
<!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 `Image` struct in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, Image">

    <title>ocl::Image - 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: 'Image', 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=''>Image</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'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../src/ocl/standard/image.rs.html#598-604' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Image&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A section of device memory which represents one or many images.</p>
<p>Use <code>::builder</code> for an easy way to create. [UNIMPLEMENTED]</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#606-913' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.supported_formats' class="method"><span id='supported_formats.v' class='invisible'><code>fn <a href='#method.supported_formats' class='fnname'>supported_formats</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;context: &amp;<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;mem_obj_type: <a class="enum" href="../ocl/enums/enum.MemObjectType.html" title="enum ocl::enums::MemObjectType">MemObjectType</a><br>) -&gt; <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a>&lt;<a class="type" href="../ocl_core/types/structs/type.ImageFormatParseResult.html" title="type ocl_core::types::structs::ImageFormatParseResult">ImageFormatParseResult</a>&gt;&gt;</code></span></h4>
<div class='docblock'><p>Returns a list of supported image formats.</p>
</div><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>fn <a href='#method.builder' class='fnname'>builder</a>&lt;'a&gt;() -&gt; <a class="struct" href="../ocl/builders/struct.ImageBuilder.html" title="struct ocl::builders::ImageBuilder">ImageBuilder</a>&lt;'a, T&gt;</code></span></h4>
<div class='docblock'><p>Returns an <code>ImageBuilder</code>. This is the recommended method to create
a new <code>Image</code>.</p>
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>&lt;'o, Q&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;que_ctx: Q, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;image_format: <a class="struct" href="../ocl/builders/struct.ImageFormat.html" title="struct ocl::builders::ImageFormat">ImageFormat</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;host_data: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt;<br>) -&gt; <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;QueCtx&lt;'o&gt;&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code>.</p>
<p>Prefer <code>::builder</code> to create a new image.</p>
</div><h4 id='method.from_gl_texture' class="method"><span id='from_gl_texture.v' class='invisible'><code>fn <a href='#method.from_gl_texture' class='fnname'>from_gl_texture</a>&lt;'o, Q&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;que_ctx: Q, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;texture_target: <a class="enum" href="../ocl_core/enum.GlTextureTarget.html" title="enum ocl_core::GlTextureTarget">GlTextureTarget</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;miplevel: <a class="type" href="../ocl/prm/type.cl_GLint.html" title="type ocl::prm::cl_GLint">cl_GLint</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;texture: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -&gt; <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;QueCtx&lt;'o&gt;&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code> from an existant GL texture2D/3D.</p>
</div><h4 id='method.from_gl_renderbuffer' class="method"><span id='from_gl_renderbuffer.v' class='invisible'><code>fn <a href='#method.from_gl_renderbuffer' class='fnname'>from_gl_renderbuffer</a>&lt;'o, Q&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;que_ctx: Q, <br>&nbsp;&nbsp;&nbsp;&nbsp;flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;renderbuffer: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -&gt; <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;QueCtx&lt;'o&gt;&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code> from an existant renderbuffer.</p>
</div><h4 id='method.cmd' class="method"><span id='cmd.v' class='invisible'><code>fn <a href='#method.cmd' class='fnname'>cmd</a>(&amp;self) -&gt; <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a>&lt;T&gt;</code></span></h4>
<div class='docblock'><p>Returns an image 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.ImageCmd">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>&lt;'c, 'd&gt;(&amp;'c self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'d mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a>&lt;'c, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'d: 'c,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an image command builder set to read.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.ImageCmd#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>&lt;'c, 'd&gt;(&amp;'c self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'d [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a>&lt;'c, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;'d: 'c,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an image command builder set to write.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.ImageCmd#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>&lt;'c&gt;(&amp;'c self) -&gt; ImageMapCmd&lt;'c, T&gt;</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.ImageCmd#method.map">command builder documentation</a>
for more details.</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>&lt;'a&gt;(&amp;'a mut self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -&gt; &amp;'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span></h4>
<div class='docblock'><p>Changes the default queue.</p>
<p>Returns a ref for chaining i.e.:</p>
<p><code>image.set_default_queue(queue).write(....);</code></p>
<p>[NOTE]: Even when used as above, the queue is changed permanently,
not just for the one call. Changing the queue is cheap so feel free
to change as often as needed.</p>
<p>The new queue must be associated with a valid device.</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>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a reference to the default queue.</p>
</div><h4 id='method.dims' class="method"><span id='dims.v' class='invisible'><code>fn <a href='#method.dims' class='fnname'>dims</a>(&amp;self) -&gt; &amp;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span></h4>
<div class='docblock'><p>Returns this image's dimensions.</p>
</div><h4 id='method.pixel_count' class="method"><span id='pixel_count.v' class='invisible'><code>fn <a href='#method.pixel_count' class='fnname'>pixel_count</a>(&amp;self) -&gt; <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 total number of pixels in this image.</p>
</div><h4 id='method.pixel_element_len' class="method"><span id='pixel_element_len.v' class='invisible'><code>fn <a href='#method.pixel_element_len' class='fnname'>pixel_element_len</a>(&amp;self) -&gt; <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 each pixel element.</p>
</div><h4 id='method.element_count' class="method"><span id='element_count.v' class='invisible'><code>fn <a href='#method.element_count' class='fnname'>element_count</a>(&amp;self) -&gt; <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 total number of pixel elements in this image. Equivalent to its length.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>fn <a href='#method.info' class='fnname'>info</a>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.ImageInfo.html" title="enum ocl::enums::ImageInfo">ImageInfo</a>) -&gt; <a class="enum" href="../ocl/enums/enum.ImageInfoResult.html" title="enum ocl::enums::ImageInfoResult">ImageInfoResult</a></code></span></h4>
<div class='docblock'><p>Get information about this image.</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>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.MemInfo.html" title="enum ocl::enums::MemInfo">MemInfo</a>) -&gt; <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 this image's memory.</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>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></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>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></h4>
<div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</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>&lt;Target = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>&gt;</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>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span></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&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#597' 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>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</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>(&amp;mut self, source: &amp;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&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#597' 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>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#915-921' 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>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></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&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#923-929' 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>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#931-935' 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>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></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&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a>&lt;T&gt; for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#937-941' 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>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></h4>
</div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#949' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &amp;'a <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#950' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &amp;'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#951' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#952' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &amp;'a <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#953' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a, T&gt; <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &amp;'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#954' 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>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</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>