clfft 0.3.2

Bindings for clFFT, a FFT library for OpenCL.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

<!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 `ImageCmdKind` enum in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, ImageCmdKind">

    <title>ocl::builders::ImageCmdKind - 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 enum">
    <!--[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>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'ImageCmdKind', ty: 'enum', 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'>Enum <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>builders</a>::<wbr><a class="enum" href=''>ImageCmdKind</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#27-37' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum ImageCmdKind&lt;'c, T:&nbsp;'c&gt; {
    Unspecified,
    Read {
        data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'c mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>,
    },
    Write {
        data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'c [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>,
    },
    Map,
    Fill {
        color: T,
    },
    Copy {
        dst_image: &amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>,
        dst_origin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>,
    },
    CopyToBuffer {
        buffer: &amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>,
        dst_origin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
    },
    GLAcquire,
    GLRelease,
}</pre><div class='docblock'><p>The type of operation to be performed by a command.</p>
</div><h2 class='variants'>Variants</h2>
<span id='variant.Unspecified' class='variant'><span id='Unspecified.v' class='invisible'><code>Unspecified</code></span></span><span id='variant.Read' class='variant'><span id='Read.v' class='invisible'><code>Read</code></span></span><span class='docblock autohide sub-variant' id='variant.Read.fields'><h3 class='fields'>Fields of <code>Read</code></h3>

                           <table><tr><td id='variant.Read.field.data'><span id='Read.v.data.v' class='invisible'><code>data:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'c mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td></td></tr></table></span><span id='variant.Write' class='variant'><span id='Write.v' class='invisible'><code>Write</code></span></span><span class='docblock autohide sub-variant' id='variant.Write.fields'><h3 class='fields'>Fields of <code>Write</code></h3>

                           <table><tr><td id='variant.Write.field.data'><span id='Write.v.data.v' class='invisible'><code>data:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'c [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td></td></tr></table></span><span id='variant.Map' class='variant'><span id='Map.v' class='invisible'><code>Map</code></span></span><span id='variant.Fill' class='variant'><span id='Fill.v' class='invisible'><code>Fill</code></span></span><span class='docblock autohide sub-variant' id='variant.Fill.fields'><h3 class='fields'>Fields of <code>Fill</code></h3>

                           <table><tr><td id='variant.Fill.field.color'><span id='Fill.v.color.v' class='invisible'><code>color:&nbsp;T</code></span></td><td></td></tr></table></span><span id='variant.Copy' class='variant'><span id='Copy.v' class='invisible'><code>Copy</code></span></span><span class='docblock autohide sub-variant' id='variant.Copy.fields'><h3 class='fields'>Fields of <code>Copy</code></h3>

                           <table><tr><td id='variant.Copy.field.dst_image'><span id='Copy.v.dst_image.v' class='invisible'><code>dst_image:&nbsp;&amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></td><td></td></tr><tr><td id='variant.Copy.field.dst_origin'><span id='Copy.v.dst_origin.v' class='invisible'><code>dst_origin:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a></code></span></td><td></td></tr></table></span><span id='variant.CopyToBuffer' class='variant'><span id='CopyToBuffer.v' class='invisible'><code>CopyToBuffer</code></span></span><span class='docblock autohide sub-variant' id='variant.CopyToBuffer.fields'><h3 class='fields'>Fields of <code>CopyToBuffer</code></h3>

                           <table><tr><td id='variant.CopyToBuffer.field.buffer'><span id='CopyToBuffer.v.buffer.v' class='invisible'><code>buffer:&nbsp;&amp;'c <a class="struct" href="../../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></td><td></td></tr><tr><td id='variant.CopyToBuffer.field.dst_origin'><span id='CopyToBuffer.v.dst_origin.v' class='invisible'><code>dst_origin:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td></td></tr></table></span><span id='variant.GLAcquire' class='variant'><span id='GLAcquire.v' class='invisible'><code>GLAcquire</code></span></span><span id='variant.GLRelease' class='variant'><span id='GLRelease.v' class='invisible'><code>GLRelease</code></span></span><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'c, T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + 'c&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="enum" href="../../ocl/builders/enum.ImageCmdKind.html" title="enum ocl::builders::ImageCmdKind">ImageCmdKind</a>&lt;'c, T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/image.rs.html#26' 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></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>