RONCC
/
HPC-Tools-for-Quantum-Computing


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

    <title>ocl::flags - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
    
    <link rel="stylesheet" type="text/css" href="../../dark.css">
    <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
    <script src="../../storage.js"></script>
    

    
    
</head>
<body class="rustdoc mod">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <div class="sidebar-menu">&#9776;</div>
        
        <p class='location'>Module flags</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></div><p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'flags', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
    </nav>

    <div class="theme-picker">
        <button id="theme-picker" aria-label="Pick another theme!">
            <img src="../../brush.svg" width="18" alt="Pick another theme!">
        </button>
        <div id="theme-choices"></div>
    </div>
    <script src="../../theme.js"></script>
    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ocl</a>::<wbr><a class="mod" href=''>flags</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/lib.rs.html#143-176' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Bitflags for various parameter types.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.CommandQueueProperties.html"
                                  title='struct ocl::flags::CommandQueueProperties'>CommandQueueProperties</a></td>
                           <td class='docblock-short'>
                                <p>cl_command_queue_properties - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DeviceAffinityDomain.html"
                                  title='struct ocl::flags::DeviceAffinityDomain'>DeviceAffinityDomain</a></td>
                           <td class='docblock-short'>
                                <p>cl_device_affinity_domain</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DeviceExecCapabilities.html"
                                  title='struct ocl::flags::DeviceExecCapabilities'>DeviceExecCapabilities</a></td>
                           <td class='docblock-short'>
                                <p>cl_device_exec_capabilities - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DeviceFpConfig.html"
                                  title='struct ocl::flags::DeviceFpConfig'>DeviceFpConfig</a></td>
                           <td class='docblock-short'>
                                <p>cl_device_fp_config - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DeviceType.html"
                                  title='struct ocl::flags::DeviceType'>DeviceType</a></td>
                           <td class='docblock-short'>
                                <p>cl_device_type - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.KernelArgTypeQualifier.html"
                                  title='struct ocl::flags::KernelArgTypeQualifier'>KernelArgTypeQualifier</a></td>
                           <td class='docblock-short'>
                                <p>cl_kernel_arg_type_qualifer</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.MapFlags.html"
                                  title='struct ocl::flags::MapFlags'>MapFlags</a></td>
                           <td class='docblock-short'>
                                <p>cl_map_flags - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.MemFlags.html"
                                  title='struct ocl::flags::MemFlags'>MemFlags</a></td>
                           <td class='docblock-short'>
                                <p>cl_mem_flags - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.MemMigrationFlags.html"
                                  title='struct ocl::flags::MemMigrationFlags'>MemMigrationFlags</a></td>
                           <td class='docblock-short'>
                                <p>cl_mem_migration_flags - bitfield</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.ProgramBinaryType.html"
                                  title='struct ocl::flags::ProgramBinaryType'>ProgramBinaryType</a></td>
                           <td class='docblock-short'>
                                <p>cl_program_binary_type</p>

                           </td>
                       </tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L1_CACHE.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L1_CACHE'>DEVICE_AFFINITY_DOMAIN_L1_CACHE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L2_CACHE.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L2_CACHE'>DEVICE_AFFINITY_DOMAIN_L2_CACHE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L3_CACHE.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L3_CACHE'>DEVICE_AFFINITY_DOMAIN_L3_CACHE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_L4_CACHE.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_L4_CACHE'>DEVICE_AFFINITY_DOMAIN_L4_CACHE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE'>DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_AFFINITY_DOMAIN_NUMA.html"
                                  title='constant ocl::flags::DEVICE_AFFINITY_DOMAIN_NUMA'>DEVICE_AFFINITY_DOMAIN_NUMA</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_ACCELERATOR.html"
                                  title='constant ocl::flags::DEVICE_TYPE_ACCELERATOR'>DEVICE_TYPE_ACCELERATOR</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_ALL.html"
                                  title='constant ocl::flags::DEVICE_TYPE_ALL'>DEVICE_TYPE_ALL</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_CPU.html"
                                  title='constant ocl::flags::DEVICE_TYPE_CPU'>DEVICE_TYPE_CPU</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_CUSTOM.html"
                                  title='constant ocl::flags::DEVICE_TYPE_CUSTOM'>DEVICE_TYPE_CUSTOM</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_DEFAULT.html"
                                  title='constant ocl::flags::DEVICE_TYPE_DEFAULT'>DEVICE_TYPE_DEFAULT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.DEVICE_TYPE_GPU.html"
                                  title='constant ocl::flags::DEVICE_TYPE_GPU'>DEVICE_TYPE_GPU</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.EXEC_KERNEL.html"
                                  title='constant ocl::flags::EXEC_KERNEL'>EXEC_KERNEL</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.EXEC_NATIVE_KERNEL.html"
                                  title='constant ocl::flags::EXEC_NATIVE_KERNEL'>EXEC_NATIVE_KERNEL</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_CORRECTLY_ROUNDED_DIVIDE_SQRT.html"
                                  title='constant ocl::flags::FP_CORRECTLY_ROUNDED_DIVIDE_SQRT'>FP_CORRECTLY_ROUNDED_DIVIDE_SQRT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_DENORM.html"
                                  title='constant ocl::flags::FP_DENORM'>FP_DENORM</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_FMA.html"
                                  title='constant ocl::flags::FP_FMA'>FP_FMA</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_INF_NAN.html"
                                  title='constant ocl::flags::FP_INF_NAN'>FP_INF_NAN</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_ROUND_TO_INF.html"
                                  title='constant ocl::flags::FP_ROUND_TO_INF'>FP_ROUND_TO_INF</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_ROUND_TO_NEAREST.html"
                                  title='constant ocl::flags::FP_ROUND_TO_NEAREST'>FP_ROUND_TO_NEAREST</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_ROUND_TO_ZERO.html"
                                  title='constant ocl::flags::FP_ROUND_TO_ZERO'>FP_ROUND_TO_ZERO</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.FP_SOFT_FLOAT.html"
                                  title='constant ocl::flags::FP_SOFT_FLOAT'>FP_SOFT_FLOAT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.KERNEL_ARG_TYPE_CONST.html"
                                  title='constant ocl::flags::KERNEL_ARG_TYPE_CONST'>KERNEL_ARG_TYPE_CONST</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.KERNEL_ARG_TYPE_NONE.html"
                                  title='constant ocl::flags::KERNEL_ARG_TYPE_NONE'>KERNEL_ARG_TYPE_NONE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.KERNEL_ARG_TYPE_RESTRICT.html"
                                  title='constant ocl::flags::KERNEL_ARG_TYPE_RESTRICT'>KERNEL_ARG_TYPE_RESTRICT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.KERNEL_ARG_TYPE_VOLATILE.html"
                                  title='constant ocl::flags::KERNEL_ARG_TYPE_VOLATILE'>KERNEL_ARG_TYPE_VOLATILE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MAP_READ.html"
                                  title='constant ocl::flags::MAP_READ'>MAP_READ</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MAP_WRITE.html"
                                  title='constant ocl::flags::MAP_WRITE'>MAP_WRITE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MAP_WRITE_INVALIDATE_REGION.html"
                                  title='constant ocl::flags::MAP_WRITE_INVALIDATE_REGION'>MAP_WRITE_INVALIDATE_REGION</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_ALLOC_HOST_PTR.html"
                                  title='constant ocl::flags::MEM_ALLOC_HOST_PTR'>MEM_ALLOC_HOST_PTR</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_COPY_HOST_PTR.html"
                                  title='constant ocl::flags::MEM_COPY_HOST_PTR'>MEM_COPY_HOST_PTR</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_HOST_NO_ACCESS.html"
                                  title='constant ocl::flags::MEM_HOST_NO_ACCESS'>MEM_HOST_NO_ACCESS</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_HOST_READ_ONLY.html"
                                  title='constant ocl::flags::MEM_HOST_READ_ONLY'>MEM_HOST_READ_ONLY</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_HOST_WRITE_ONLY.html"
                                  title='constant ocl::flags::MEM_HOST_WRITE_ONLY'>MEM_HOST_WRITE_ONLY</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_READ_ONLY.html"
                                  title='constant ocl::flags::MEM_READ_ONLY'>MEM_READ_ONLY</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_READ_WRITE.html"
                                  title='constant ocl::flags::MEM_READ_WRITE'>MEM_READ_WRITE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_USE_HOST_PTR.html"
                                  title='constant ocl::flags::MEM_USE_HOST_PTR'>MEM_USE_HOST_PTR</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MEM_WRITE_ONLY.html"
                                  title='constant ocl::flags::MEM_WRITE_ONLY'>MEM_WRITE_ONLY</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED.html"
                                  title='constant ocl::flags::MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED'>MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.MIGRATE_MEM_OBJECT_HOST.html"
                                  title='constant ocl::flags::MIGRATE_MEM_OBJECT_HOST'>MIGRATE_MEM_OBJECT_HOST</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_COMPILED_OBJECT.html"
                                  title='constant ocl::flags::PROGRAM_BINARY_TYPE_COMPILED_OBJECT'>PROGRAM_BINARY_TYPE_COMPILED_OBJECT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_EXECUTABLE.html"
                                  title='constant ocl::flags::PROGRAM_BINARY_TYPE_EXECUTABLE'>PROGRAM_BINARY_TYPE_EXECUTABLE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_LIBRARY.html"
                                  title='constant ocl::flags::PROGRAM_BINARY_TYPE_LIBRARY'>PROGRAM_BINARY_TYPE_LIBRARY</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.PROGRAM_BINARY_TYPE_NONE.html"
                                  title='constant ocl::flags::PROGRAM_BINARY_TYPE_NONE'>PROGRAM_BINARY_TYPE_NONE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE.html"
                                  title='constant ocl::flags::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE'>QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.QUEUE_PROFILING_ENABLE.html"
                                  title='constant ocl::flags::QUEUE_PROFILING_ENABLE'>QUEUE_PROFILING_ENABLE</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr></table></section>
    <section id='search' class="content hidden"></section>

    <section class="footer"></section>

    <aside id="help" class="hidden">
        <div>
            <h1 class="hidden">Help</h1>

            <div class="shortcuts">
                <h2>Keyboard Shortcuts</h2>

                <dl>
                    <dt><kbd>?</kbd></dt>
                    <dd>Show this help dialog</dd>
                    <dt><kbd>S</kbd></dt>
                    <dd>Focus the search field</dd>
                    <dt><kbd>↑</kbd></dt>
                    <dd>Move up in search results</dd>
                    <dt><kbd>↓</kbd></dt>
                    <dd>Move down in search results</dd>
                    <dt><kbd>↹</kbd></dt>
                    <dd>Switch tab</dd>
                    <dt><kbd>&#9166;</kbd></dt>
                    <dd>Go to active search result</dd>
                    <dt><kbd>+</kbd></dt>
                    <dd>Expand all sections</dd>
                    <dt><kbd>-</kbd></dt>
                    <dd>Collapse all sections</dd>
                </dl>
            </div>

            <div class="infos">
                <h2>Search Tricks</h2>

                <p>
                    Prefix searches with a type followed by a colon (e.g.
                    <code>fn:</code>) to restrict the search to a given type.
                </p>

                <p>
                    Accepted types are: <code>fn</code>, <code>mod</code>,
                    <code>struct</code>, <code>enum</code>,
                    <code>trait</code>, <code>type</code>, <code>macro</code>,
                    and <code>const</code>.
                </p>

                <p>
                    Search functions by type signature (e.g.
                    <code>vec -> usize</code> or <code>* -> vec</code>)
                </p>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../";
        window.currentCrate = "ocl";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>