| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: Dnnl_api_ocl_interop</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Dnnl_api_ocl_interop<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> » <a class="el" href="group__dnnl__api__interop.html">Dnnl_api_interop</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Collaboration diagram for Dnnl_api_ocl_interop:</div> |
| <div class="dyncontent"> |
| <center><table><tr><td><img src="group__dnnl__api__ocl__interop.png" border="0" alt="" usemap="#group____dnnl____api____ocl____interop"/> |
| <map name="group____dnnl____api____ocl____interop" id="group____dnnl____api____ocl____interop"> |
| <area shape="rect" id="node1" href="group__dnnl__api__interop.html" title="Dnnl_api_interop" alt="" coords="5,5,137,32"/> |
| </map> |
| </td></tr></table></center> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ga5cafdbf17fcfad7154d773994b4390f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga5cafdbf17fcfad7154d773994b4390f0">dnnl_ocl_interop_memory_create</a> (<a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> *memory, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *memory_desc, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, dnnl_ocl_interop_memory_kind_t memory_kind, void *handle)</td></tr> |
| <tr class="separator:ga5cafdbf17fcfad7154d773994b4390f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa6c00a54ba3ca30d00d9e1c43e9b4bc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#gaa6c00a54ba3ca30d00d9e1c43e9b4bc2">dnnl_ocl_interop_memory_get_memory_kind</a> (<a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> memory, dnnl_ocl_interop_memory_kind_t *memory_kind)</td></tr> |
| <tr class="separator:gaa6c00a54ba3ca30d00d9e1c43e9b4bc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga383b09734d764bb45872b2c65f7dad70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga383b09734d764bb45872b2c65f7dad70">dnnl_ocl_interop_memory_get_mem_object</a> (<a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> memory, cl_mem *mem_object)</td></tr> |
| <tr class="separator:ga383b09734d764bb45872b2c65f7dad70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga493946609c6bae83329241c4950edbce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga493946609c6bae83329241c4950edbce">dnnl_ocl_interop_memory_set_mem_object</a> (<a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> memory, cl_mem mem_object)</td></tr> |
| <tr class="separator:ga493946609c6bae83329241c4950edbce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga52edd1810d72a2a08a881b122c7ada70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga52edd1810d72a2a08a881b122c7ada70">dnnl_ocl_interop_engine_create</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> *engine, cl_device_id device, cl_context context)</td></tr> |
| <tr class="separator:ga52edd1810d72a2a08a881b122c7ada70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6be452e1d11ad63d1f20a072258547c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga6be452e1d11ad63d1f20a072258547c8">dnnl_ocl_interop_engine_get_context</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, cl_context *context)</td></tr> |
| <tr class="separator:ga6be452e1d11ad63d1f20a072258547c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafd0a653afb5a16d4d1fc71cd0615e44a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#gafd0a653afb5a16d4d1fc71cd0615e44a">dnnl_ocl_interop_get_device</a> (<a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, cl_device_id *device)</td></tr> |
| <tr class="separator:gafd0a653afb5a16d4d1fc71cd0615e44a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9a9007c6661472d701b2bbfb43ddf07c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga9a9007c6661472d701b2bbfb43ddf07c">dnnl_ocl_interop_stream_create</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> *stream, <a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> engine, cl_command_queue queue)</td></tr> |
| <tr class="separator:ga9a9007c6661472d701b2bbfb43ddf07c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0290e83f9217e83eba910454348c0819"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__ocl__interop.html#ga0290e83f9217e83eba910454348c0819">dnnl_ocl_interop_stream_get_command_queue</a> (<a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> stream, cl_command_queue *queue)</td></tr> |
| <tr class="separator:ga0290e83f9217e83eba910454348c0819"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ga52edd1810d72a2a08a881b122c7ada70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga52edd1810d72a2a08a881b122c7ada70">◆ </a></span>dnnl_ocl_interop_engine_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_engine_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> * </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_device_id </td> |
| <td class="paramname"><em>device</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_context </td> |
| <td class="paramname"><em>context</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an engine associated with an OpenCL device and an OpenCL context.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Output engine. </td></tr> |
| <tr><td class="paramname">device</td><td>Underlying OpenCL device to use for the engine. </td></tr> |
| <tr><td class="paramname">context</td><td>Underlying OpenCL context to use for the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6be452e1d11ad63d1f20a072258547c8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6be452e1d11ad63d1f20a072258547c8">◆ </a></span>dnnl_ocl_interop_engine_get_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_engine_get_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_context * </td> |
| <td class="paramname"><em>context</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the OpenCL context associated with an engine.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Engine to query. </td></tr> |
| <tr><td class="paramname">context</td><td>Output underlying OpenCL context of the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gafd0a653afb5a16d4d1fc71cd0615e44a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gafd0a653afb5a16d4d1fc71cd0615e44a">◆ </a></span>dnnl_ocl_interop_get_device()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_get_device </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_device_id * </td> |
| <td class="paramname"><em>device</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the OpenCL device associated with an engine.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>Engine to query. </td></tr> |
| <tr><td class="paramname">device</td><td>Output underlying OpenCL device of the engine. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga5cafdbf17fcfad7154d773994b4390f0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga5cafdbf17fcfad7154d773994b4390f0">◆ </a></span>dnnl_ocl_interop_memory_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_memory_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> * </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td> |
| <td class="paramname"><em>memory_desc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">dnnl_ocl_interop_memory_kind_t </td> |
| <td class="paramname"><em>memory_kind</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>handle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates a memory object.</p> |
| <p>Unless <code>handle</code> is equal to DNNL_MEMORY_NONE or DNNL_MEMORY_ALLOCATE, the constructed memory object will have the underlying buffer set. In this case, the buffer will be initialized as if:</p><ul> |
| <li><a class="el" href="group__dnnl__api__memory.html#ga6888f8c17f272d6729c9bc258ed41fcf">dnnl_memory_set_data_handle()</a> has been called, if <code>memory_kind</code> is equal to dnnl_ocl_interop_usm, or</li> |
| <li><a class="el" href="group__dnnl__api__ocl__interop.html#ga493946609c6bae83329241c4950edbce">dnnl_ocl_interop_memory_set_mem_object()</a> has been called, if <code>memory_kind</code> is equal to dnnl_ocl_interop_buffer.</li> |
| </ul> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Output memory object. </td></tr> |
| <tr><td class="paramname">memory_desc</td><td>Memory descriptor. </td></tr> |
| <tr><td class="paramname">engine</td><td>Engine to use. </td></tr> |
| <tr><td class="paramname">memory_kind</td><td>Memory allocation kind to specify the type of handle. </td></tr> |
| <tr><td class="paramname">handle</td><td>Handle of the memory buffer to use as an underlying storage.<ul> |
| <li>A USM pointer to the user-allocated buffer. In this case the library doesn't own the buffer. Requires <code>memory_kind</code> to be equal to dnnl_ocl_interop_usm.</li> |
| <li>An OpenCL buffer. In this case the library doesn't own the buffer. Requires <code>memory_kind</code> be equal to be equal to dnnl_ocl_interop_buffer.</li> |
| <li>The DNNL_MEMORY_ALLOCATE special value. Instructs the library to allocate the buffer that corresponds to the memory allocation kind <code>memory_kind</code> for the memory object. In this case the library owns the buffer.</li> |
| <li>The DNNL_MEMORY_NONE specific value. Instructs the library to create memory object without an underlying buffer. </li> |
| </ul> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga383b09734d764bb45872b2c65f7dad70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga383b09734d764bb45872b2c65f7dad70">◆ </a></span>dnnl_ocl_interop_memory_get_mem_object()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_memory_get_mem_object </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_mem * </td> |
| <td class="paramname"><em>mem_object</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns an OpenCL memory object associated with a memory object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Memory object. </td></tr> |
| <tr><td class="paramname">mem_object</td><td>Output OpenCL memory object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gaa6c00a54ba3ca30d00d9e1c43e9b4bc2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa6c00a54ba3ca30d00d9e1c43e9b4bc2">◆ </a></span>dnnl_ocl_interop_memory_get_memory_kind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_memory_get_memory_kind </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga0f89ee8e9b55b302b3f5277d11302f7e">const_dnnl_memory_t</a> </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">dnnl_ocl_interop_memory_kind_t * </td> |
| <td class="paramname"><em>memory_kind</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the memory allocation kind associated with a memory object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Memory to query. </td></tr> |
| <tr><td class="paramname">memory_kind</td><td>Output underlying memory allocation kind of the memory object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga493946609c6bae83329241c4950edbce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga493946609c6bae83329241c4950edbce">◆ </a></span>dnnl_ocl_interop_memory_set_mem_object()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_memory_set_mem_object </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__memory.html#ga2b79954bd7bb293e766a89189e8440fd">dnnl_memory_t</a> </td> |
| <td class="paramname"><em>memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_mem </td> |
| <td class="paramname"><em>mem_object</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Sets OpenCL memory object associated with a memory object.</p> |
| <p>For behavioral details, see <a class="el" href="group__dnnl__api__memory.html#ga6888f8c17f272d6729c9bc258ed41fcf">dnnl_memory_set_data_handle()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory</td><td>Memory object. </td></tr> |
| <tr><td class="paramname">mem_object</td><td>OpenCL memory object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga9a9007c6661472d701b2bbfb43ddf07c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9a9007c6661472d701b2bbfb43ddf07c">◆ </a></span>dnnl_ocl_interop_stream_create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_stream_create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__engine.html#ga1ce7843660e8203ed6e1af9bfd23e14f">dnnl_engine_t</a> </td> |
| <td class="paramname"><em>engine</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_command_queue </td> |
| <td class="paramname"><em>queue</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an execution stream for a given engine associated with an OpenCL command queue.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Output execution stream. </td></tr> |
| <tr><td class="paramname">engine</td><td>Engine to create the execution stream on. </td></tr> |
| <tr><td class="paramname">queue</td><td>OpenCL command queue to use. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga0290e83f9217e83eba910454348c0819"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0290e83f9217e83eba910454348c0819">◆ </a></span>dnnl_ocl_interop_stream_get_command_queue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_ocl_interop_stream_get_command_queue </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__dnnl__api__stream.html#ga735eb19cfd205c108c468b5657de4eca">dnnl_stream_t</a> </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl_command_queue * </td> |
| <td class="paramname"><em>queue</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the OpenCL command queue associated with an execution stream.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>Execution stream to query. </td></tr> |
| <tr><td class="paramname">queue</td><td>Output OpenCL command queue. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
