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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

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

    <title>ocl::builders::ContextProperties - 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>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'ContextProperties', 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 href='index.html'>builders</a>::<wbr><a class="struct" href=''>ContextProperties</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_core/types/structs.rs.html#178' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct ContextProperties(_);</pre><div class='docblock'><p>Context properties list.</p>
<p>[MINIMALLY TESTED]</p>
<p>TODO: Check for duplicate property assignments.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#180-469' 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>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Returns an empty new list of context properties</p>
</div><h4 id='method.platform' class="method"><span id='platform.v' class='invisible'><code>fn <a href='#method.platform' class='fnname'>platform</a>&lt;P&gt;(self, platform: P) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformId</a>&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Specifies a platform (builder-style).</p>
</div><h4 id='method.interop_user_sync' class="method"><span id='interop_user_sync.v' class='invisible'><code>fn <a href='#method.interop_user_sync' class='fnname'>interop_user_sync</a>(self, sync: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Specifies whether the user is responsible for synchronization between
OpenCL and other APIs (builder-style).</p>
</div><h4 id='method.gl_context' class="method"><span id='gl_context.v' class='invisible'><code>fn <a href='#method.gl_context' class='fnname'>gl_context</a>(self, gl_ctx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Specifies an OpenGL context handle (builder-style).</p>
</div><h4 id='method.glx_display' class="method"><span id='glx_display.v' class='invisible'><code>fn <a href='#method.glx_display' class='fnname'>glx_display</a>(self, glx_disp: <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>) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Specifies a Display pointer for the GLX context (builder-style).</p>
</div><h4 id='method.cgl_sharegroup' class="method"><span id='cgl_sharegroup.v' class='invisible'><code>fn <a href='#method.cgl_sharegroup' class='fnname'>cgl_sharegroup</a>(self, gl_sharegroup: <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>) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Specifies an OpenGL context CGL share group to associate the OpenCL
context with (builder-style).</p>
</div><h4 id='method.property_value' class="method"><span id='property_value.v' class='invisible'><code>fn <a href='#method.property_value' class='fnname'>property_value</a>(self, prop: <a class="enum" href="../../ocl/enums/enum.ContextPropertyValue.html" title="enum ocl::enums::ContextPropertyValue">ContextPropertyValue</a>) -&gt; <a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span></h4>
<div class='docblock'><p>Pushes a <code>ContextPropertyValue</code> onto this list of properties
(builder-style).</p>
</div><h4 id='method.set_platform' class="method"><span id='set_platform.v' class='invisible'><code>fn <a href='#method.set_platform' class='fnname'>set_platform</a>&lt;P&gt;(&amp;mut self, platform: P) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="../../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformId</a>&gt;,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Specifies a platform.</p>
</div><h4 id='method.set_interop_user_sync' class="method"><span id='set_interop_user_sync.v' class='invisible'><code>fn <a href='#method.set_interop_user_sync' class='fnname'>set_interop_user_sync</a>(&amp;mut self, sync: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></h4>
<div class='docblock'><p>Specifies whether the user is responsible for synchronization between
OpenCL and other APIs.</p>
</div><h4 id='method.set_gl_context' class="method"><span id='set_gl_context.v' class='invisible'><code>fn <a href='#method.set_gl_context' class='fnname'>set_gl_context</a>(&amp;mut self, gl_ctx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></span></h4>
<div class='docblock'><p>Specifies an OpenGL context handle.</p>
</div><h4 id='method.set_glx_display' class="method"><span id='set_glx_display.v' class='invisible'><code>fn <a href='#method.set_glx_display' class='fnname'>set_glx_display</a>(&amp;mut self, glx_disp: <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>Specifies a Display pointer for the GLX context.</p>
</div><h4 id='method.set_cgl_sharegroup' class="method"><span id='set_cgl_sharegroup.v' class='invisible'><code>fn <a href='#method.set_cgl_sharegroup' class='fnname'>set_cgl_sharegroup</a>(&amp;mut self, gl_sharegroup: <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>Specifies an OpenGL context CGL share group to associate the OpenCL
context with.</p>
</div><h4 id='method.set_property_value' class="method"><span id='set_property_value.v' class='invisible'><code>fn <a href='#method.set_property_value' class='fnname'>set_property_value</a>(&amp;mut self, prop: <a class="enum" href="../../ocl/enums/enum.ContextPropertyValue.html" title="enum ocl::enums::ContextPropertyValue">ContextPropertyValue</a>)</code></span></h4>
<div class='docblock'><p>Pushes a <code>ContextPropertyValue</code> onto this list of properties.</p>
</div><h4 id='method.get_platform' class="method"><span id='get_platform.v' class='invisible'><code>fn <a href='#method.get_platform' class='fnname'>get_platform</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;<a class="struct" href="../../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformId</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a platform id or none.</p>
</div><h4 id='method.get_cgl_sharegroup' class="method"><span id='get_cgl_sharegroup.v' class='invisible'><code>fn <a href='#method.get_cgl_sharegroup' class='fnname'>get_cgl_sharegroup</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;<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>&gt;</code></span></h4>
<div class='docblock'><p>Returns a cgl_sharegroup id or none.</p>
</div><h4 id='method.to_raw' class="method"><span id='to_raw.v' class='invisible'><code>fn <a href='#method.to_raw' class='fnname'>to_raw</a>(&amp;self) -&gt; <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>&gt;</code></span></h4>
<div class='docblock'><p>Converts this list into a packed-word representation as specified
<a href="https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateContext.html">here</a>.</p>
</div><h4 id='method.extract_property_from_raw' class="method"><span id='extract_property_from_raw.v' class='invisible'><code>unsafe fn <a href='#method.extract_property_from_raw' class='fnname'>extract_property_from_raw</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;property: <a class="enum" href="../../ocl/enums/enum.ContextProperty.html" title="enum ocl::enums::ContextProperty">ContextProperty</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;raw_context_properties: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -&gt; <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="enum" href="../../ocl/enums/enum.ContextPropertyValue.html" title="enum ocl::enums::ContextPropertyValue">ContextPropertyValue</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a single context property value.</p>
</div><h4 id='method.from_raw' class="method"><span id='from_raw.v' class='invisible'><code>unsafe fn <a href='#method.from_raw' class='fnname'>from_raw</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;raw_context_properties: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a>, <a class="enum" href="../../ocl/enum.Error.html" title="enum ocl::Error">Error</a>&gt;</code></span></h4>
<div class='docblock'><p>Converts raw stuff into other stuff.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <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/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#177' 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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</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 <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/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/structs.rs.html#177' 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/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a></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></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>