<!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 `enqueue_map_buffer` fn in crate `ocl_core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, enqueue_map_buffer">
<title>ocl_core::enqueue_map_buffer - 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 fn">
<!--[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">☰</div>
<p class='location'><a href='index.html'>ocl_core</a></p><script>window.sidebarCurrent = {name: 'enqueue_map_buffer', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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'>Function <a href='index.html'>ocl_core</a>::<wbr><a class="fn" href=''>enqueue_map_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_core/functions.rs.html#3057-3076' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub unsafe fn enqueue_map_buffer<T, M, En, Ewl>(<br> command_queue: &<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueue</a>, <br> buffer: M, <br> block: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> map_flags: <a class="struct" href="../ocl_core/struct.MapFlags.html" title="struct ocl_core::MapFlags">MapFlags</a>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> wait_list: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Ewl>, <br> new_event: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><En><br>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="struct" href="../ocl_core/types/abs/struct.MemMap.html" title="struct ocl_core::types::abs::MemMap">MemMap</a><T>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl_core/trait.OclPrm.html" title="trait ocl_core::OclPrm">OclPrm</a>,<br> En: <a class="trait" href="../ocl_core/types/abs/trait.ClNullEventPtr.html" title="trait ocl_core::types::abs::ClNullEventPtr">ClNullEventPtr</a>,<br> Ewl: <a class="trait" href="../ocl_core/types/abs/trait.ClWaitListPtr.html" title="trait ocl_core::types::abs::ClWaitListPtr">ClWaitListPtr</a>,<br> M: <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> + <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a>, </span></pre><div class='docblock'><p>Enqueues a command to map a region of the buffer object given
by <code>buffer</code> into the host address space and returns a pointer to this
mapped region.</p>
<p><a href="https://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMapBuffer.html">SDK Docs</a></p>
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
<p>Caller must ensure that the returned pointer is not used until the map is
complete. Use <code>new_event</code> to monitor it. It also must be ensured that
memory referred to by the returned pointer is not dropped, reused, or
otherwise interfered with until <code>enqueue_unmap_mem_object</code> is called.</p>
</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><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>⏎</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_core";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>