saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/c/struct_ort_1_1_env.html
Ryan Hill 87bac13f7f
Initial C API documentation push (#9089)
2021-09-16 17:09:25 -07:00

459 lines
33 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OnnxRuntime: Ort::Env Struct Reference</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>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-156955408-1"></script><script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-156955408-1'); </script> <script type="text/javascript" src="/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="/assets/js/just-the-docs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="projectlogo"><img alt="Logo" src="ONNX_Runtime_logo - Docs.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OnnxRuntime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('struct_ort_1_1_env.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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="#pub-methods">Public Member Functions</a> &#124;
<a href="struct_ort_1_1_env-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Ort::Env Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> (Environment)
<a href="struct_ort_1_1_env.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="onnxruntime__cxx__api_8h_source.html">onnxruntime_cxx_api.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="struct_ort_1_1_base.html">Ort::Base&lt; OrtEnv &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a48bab6a5fcbe8f6d6c0ceb27afae810a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a48bab6a5fcbe8f6d6c0ceb27afae810a">Env</a> (std::nullptr_t)</td></tr>
<tr class="memdesc:a48bab6a5fcbe8f6d6c0ceb27afae810a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> object, must be assigned a valid one to be used. <a href="struct_ort_1_1_env.html#a48bab6a5fcbe8f6d6c0ceb27afae810a">More...</a><br /></td></tr>
<tr class="separator:a48bab6a5fcbe8f6d6c0ceb27afae810a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d594538c1c9fd9da1a3fb0ce532fddc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a6d594538c1c9fd9da1a3fb0ce532fddc">Env</a> (<a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a> logging_level=<a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a>, const char *logid=&quot;&quot;)</td></tr>
<tr class="memdesc:a6d594538c1c9fd9da1a3fb0ce532fddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a22085f699a2d1adb52f809383f475ed1" title="Create an OrtEnv.">OrtApi::CreateEnv</a>. <a href="struct_ort_1_1_env.html#a6d594538c1c9fd9da1a3fb0ce532fddc">More...</a><br /></td></tr>
<tr class="separator:a6d594538c1c9fd9da1a3fb0ce532fddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacb1c1fec39c545a180c5c9b8fe37fb5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#aacb1c1fec39c545a180c5c9b8fe37fb5">Env</a> (<a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a> logging_level, const char *logid, <a class="el" href="group___global.html#ga2a61c1134f2f604095f32d2560630e94">OrtLoggingFunction</a> logging_function, void *logger_param)</td></tr>
<tr class="memdesc:aacb1c1fec39c545a180c5c9b8fe37fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a3c7a1993cb380a5f9eb38374245c6343" title="Create an OrtEnv.">OrtApi::CreateEnvWithCustomLogger</a>. <a href="struct_ort_1_1_env.html#aacb1c1fec39c545a180c5c9b8fe37fb5">More...</a><br /></td></tr>
<tr class="separator:aacb1c1fec39c545a180c5c9b8fe37fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8406145b6539cd0676a29a56c1efe6be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a8406145b6539cd0676a29a56c1efe6be">Env</a> (const <a class="el" href="group___global.html#ga3a8151bc1daecaae2411fb9a54c01ee9">OrtThreadingOptions</a> *tp_options, <a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a> logging_level=<a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a>, const char *logid=&quot;&quot;)</td></tr>
<tr class="memdesc:a8406145b6539cd0676a29a56c1efe6be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a43a1a757582469f88421a9ef9d63f192" title="Create an OrtEnv.">OrtApi::CreateEnvWithGlobalThreadPools</a>. <a href="struct_ort_1_1_env.html#a8406145b6539cd0676a29a56c1efe6be">More...</a><br /></td></tr>
<tr class="separator:a8406145b6539cd0676a29a56c1efe6be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b41eadfdbb6998e5d4307318bca8033"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a8b41eadfdbb6998e5d4307318bca8033">Env</a> (const <a class="el" href="group___global.html#ga3a8151bc1daecaae2411fb9a54c01ee9">OrtThreadingOptions</a> *tp_options, <a class="el" href="group___global.html#ga2a61c1134f2f604095f32d2560630e94">OrtLoggingFunction</a> logging_function, void *logger_param, <a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a> logging_level=<a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a>, const char *logid=&quot;&quot;)</td></tr>
<tr class="memdesc:a8b41eadfdbb6998e5d4307318bca8033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a71336a3b27040097136a6fb40cf056c1">OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools</a>. <a href="struct_ort_1_1_env.html#a8b41eadfdbb6998e5d4307318bca8033">More...</a><br /></td></tr>
<tr class="separator:a8b41eadfdbb6998e5d4307318bca8033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b49a5a089206ead63150b4e246bdbe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a25b49a5a089206ead63150b4e246bdbe">Env</a> (<a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a> *p)</td></tr>
<tr class="memdesc:a25b49a5a089206ead63150b4e246bdbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">C Interop Helper. <a href="struct_ort_1_1_env.html#a25b49a5a089206ead63150b4e246bdbe">More...</a><br /></td></tr>
<tr class="separator:a25b49a5a089206ead63150b4e246bdbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a251b84b1a06a0d5f3f1cfa0d2591c033"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#a251b84b1a06a0d5f3f1cfa0d2591c033">EnableTelemetryEvents</a> ()</td></tr>
<tr class="memdesc:a251b84b1a06a0d5f3f1cfa0d2591c033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a5906120ee76cca5e8f560e6e8a3fd85c" title="Enable Telemetry.">OrtApi::EnableTelemetryEvents</a>. <a href="struct_ort_1_1_env.html#a251b84b1a06a0d5f3f1cfa0d2591c033">More...</a><br /></td></tr>
<tr class="separator:a251b84b1a06a0d5f3f1cfa0d2591c033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc9b2d44c9db7812787904d5e3018f24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#afc9b2d44c9db7812787904d5e3018f24">DisableTelemetryEvents</a> ()</td></tr>
<tr class="memdesc:afc9b2d44c9db7812787904d5e3018f24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a74a22efe6571fe538e60f677654ae01f" title="Disable Telemetry.">OrtApi::DisableTelemetryEvents</a>. <a href="struct_ort_1_1_env.html#afc9b2d44c9db7812787904d5e3018f24">More...</a><br /></td></tr>
<tr class="separator:afc9b2d44c9db7812787904d5e3018f24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace62e9a1fe461a42a0b1cc79ee40f421"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_env.html#ace62e9a1fe461a42a0b1cc79ee40f421">CreateAndRegisterAllocator</a> (const <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> *mem_info, const <a class="el" href="group___global.html#gacd8d2ea2ab8f4063d8d85dc0edc461e7">OrtArenaCfg</a> *arena_cfg)</td></tr>
<tr class="memdesc:ace62e9a1fe461a42a0b1cc79ee40f421"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#a6a0ca4d136819eafea7d87e7f87a82db" title="Create an allocator and register it with the OrtEnv.">OrtApi::CreateAndRegisterAllocator</a>. <a href="struct_ort_1_1_env.html#ace62e9a1fe461a42a0b1cc79ee40f421">More...</a><br /></td></tr>
<tr class="separator:ace62e9a1fe461a42a0b1cc79ee40f421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_struct_ort_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_struct_ort_1_1_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="struct_ort_1_1_base.html">Ort::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:a66d10ddc7737be4e09ec0936f4268fef inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a66d10ddc7737be4e09ec0936f4268fef">Base</a> ()=default</td></tr>
<tr class="separator:a66d10ddc7737be4e09ec0936f4268fef inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac871a942635518ffed7ba564c6a8f52e inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#ac871a942635518ffed7ba564c6a8f52e">Base</a> (<a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a> *p)</td></tr>
<tr class="separator:ac871a942635518ffed7ba564c6a8f52e inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4596ebf9650803a86a84a1bc04cd78af inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a4596ebf9650803a86a84a1bc04cd78af">~Base</a> ()</td></tr>
<tr class="separator:a4596ebf9650803a86a84a1bc04cd78af inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b1270f1fe2a1242d89ad7ff31ea0523 inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a4b1270f1fe2a1242d89ad7ff31ea0523">operator OrtEnv *</a> ()</td></tr>
<tr class="separator:a4b1270f1fe2a1242d89ad7ff31ea0523 inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c7f161984cf2803c17ae85bbd66176 inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a82c7f161984cf2803c17ae85bbd66176">operator const OrtEnv *</a> () const</td></tr>
<tr class="separator:a82c7f161984cf2803c17ae85bbd66176 inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f4ae170cb8adebc982cb2dea39325c9 inherit pub_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a2f4ae170cb8adebc982cb2dea39325c9">release</a> ()</td></tr>
<tr class="memdesc:a2f4ae170cb8adebc982cb2dea39325c9 inherit pub_methods_struct_ort_1_1_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases ownership of the contained pointer. <a href="struct_ort_1_1_base.html#a2f4ae170cb8adebc982cb2dea39325c9">More...</a><br /></td></tr>
<tr class="separator:a2f4ae170cb8adebc982cb2dea39325c9 inherit pub_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_struct_ort_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pub_types_struct_ort_1_1_base')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="struct_ort_1_1_base.html">Ort::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:aea8ad8947b663fdcc1b81f129912e79e inherit pub_types_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#aea8ad8947b663fdcc1b81f129912e79e">contained_type</a> = <a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a></td></tr>
<tr class="separator:aea8ad8947b663fdcc1b81f129912e79e inherit pub_types_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_struct_ort_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_struct_ort_1_1_base')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="struct_ort_1_1_base.html">Ort::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:abe0c053fd682decf4149f7d788d6b9ed inherit pro_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#abe0c053fd682decf4149f7d788d6b9ed">Base</a> (const <a class="el" href="struct_ort_1_1_base.html">Base</a> &amp;)=delete</td></tr>
<tr class="separator:abe0c053fd682decf4149f7d788d6b9ed inherit pro_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da2e4fc1874f3ec50c34ec5954d7be1 inherit pro_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a9da2e4fc1874f3ec50c34ec5954d7be1">Base</a> (<a class="el" href="struct_ort_1_1_base.html">Base</a> &amp;&amp;v) noexcept</td></tr>
<tr class="separator:a9da2e4fc1874f3ec50c34ec5954d7be1 inherit pro_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2517f75e3511fd84579f99502bf39b1e inherit pro_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1_base.html">Base</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#a2517f75e3511fd84579f99502bf39b1e">operator=</a> (const <a class="el" href="struct_ort_1_1_base.html">Base</a> &amp;)=delete</td></tr>
<tr class="separator:a2517f75e3511fd84579f99502bf39b1e inherit pro_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c3f4684de3e03acecaefd82b5e516b inherit pro_methods_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#ae1c3f4684de3e03acecaefd82b5e516b">operator=</a> (<a class="el" href="struct_ort_1_1_base.html">Base</a> &amp;&amp;v) noexcept</td></tr>
<tr class="separator:ae1c3f4684de3e03acecaefd82b5e516b inherit pro_methods_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_struct_ort_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_struct_ort_1_1_base')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="struct_ort_1_1_base.html">Ort::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:ab6424ea36bd85db866473e004a6915e5 inherit pro_attribs_struct_ort_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1_base.html#ab6424ea36bd85db866473e004a6915e5">p_</a></td></tr>
<tr class="separator:ab6424ea36bd85db866473e004a6915e5 inherit pro_attribs_struct_ort_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >The <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> (Environment) </p>
<p >The <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> holds the logging state used by all other objects. <b>Note:</b> One <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> must be created before using any other Onnxruntime functionality </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a48bab6a5fcbe8f6d6c0ceb27afae810a" name="a48bab6a5fcbe8f6d6c0ceb27afae810a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48bab6a5fcbe8f6d6c0ceb27afae810a">&#9670;&nbsp;</a></span>Env() <span class="overload">[1/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype">std::nullptr_t&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an empty <a class="el" href="struct_ort_1_1_env.html" title="The Env (Environment)">Env</a> object, must be assigned a valid one to be used. </p>
</div>
</div>
<a id="a6d594538c1c9fd9da1a3fb0ce532fddc" name="a6d594538c1c9fd9da1a3fb0ce532fddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d594538c1c9fd9da1a3fb0ce532fddc">&#9670;&nbsp;</a></span>Env() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a>&#160;</td>
<td class="paramname"><em>logging_level</em> = <code><a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>logid</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a22085f699a2d1adb52f809383f475ed1" title="Create an OrtEnv.">OrtApi::CreateEnv</a>. </p>
</div>
</div>
<a id="aacb1c1fec39c545a180c5c9b8fe37fb5" name="aacb1c1fec39c545a180c5c9b8fe37fb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb1c1fec39c545a180c5c9b8fe37fb5">&#9670;&nbsp;</a></span>Env() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a>&#160;</td>
<td class="paramname"><em>logging_level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>logid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga2a61c1134f2f604095f32d2560630e94">OrtLoggingFunction</a>&#160;</td>
<td class="paramname"><em>logging_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>logger_param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a3c7a1993cb380a5f9eb38374245c6343" title="Create an OrtEnv.">OrtApi::CreateEnvWithCustomLogger</a>. </p>
</div>
</div>
<a id="a8406145b6539cd0676a29a56c1efe6be" name="a8406145b6539cd0676a29a56c1efe6be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8406145b6539cd0676a29a56c1efe6be">&#9670;&nbsp;</a></span>Env() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___global.html#ga3a8151bc1daecaae2411fb9a54c01ee9">OrtThreadingOptions</a> *&#160;</td>
<td class="paramname"><em>tp_options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a>&#160;</td>
<td class="paramname"><em>logging_level</em> = <code><a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>logid</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a43a1a757582469f88421a9ef9d63f192" title="Create an OrtEnv.">OrtApi::CreateEnvWithGlobalThreadPools</a>. </p>
</div>
</div>
<a id="a8b41eadfdbb6998e5d4307318bca8033" name="a8b41eadfdbb6998e5d4307318bca8033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b41eadfdbb6998e5d4307318bca8033">&#9670;&nbsp;</a></span>Env() <span class="overload">[5/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___global.html#ga3a8151bc1daecaae2411fb9a54c01ee9">OrtThreadingOptions</a> *&#160;</td>
<td class="paramname"><em>tp_options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga2a61c1134f2f604095f32d2560630e94">OrtLoggingFunction</a>&#160;</td>
<td class="paramname"><em>logging_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>logger_param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a>&#160;</td>
<td class="paramname"><em>logging_level</em> = <code><a class="el" href="group___global.html#gga1c0fbcf614dbd0e2c272ae1cc04c629cab150db726e3f481f0e67ae654307b1c6">ORT_LOGGING_LEVEL_WARNING</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>logid</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a71336a3b27040097136a6fb40cf056c1">OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools</a>. </p>
</div>
</div>
<a id="a25b49a5a089206ead63150b4e246bdbe" name="a25b49a5a089206ead63150b4e246bdbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b49a5a089206ead63150b4e246bdbe">&#9670;&nbsp;</a></span>Env() <span class="overload">[6/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Ort::Env::Env </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a> *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>C Interop Helper. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ace62e9a1fe461a42a0b1cc79ee40f421" name="ace62e9a1fe461a42a0b1cc79ee40f421"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace62e9a1fe461a42a0b1cc79ee40f421">&#9670;&nbsp;</a></span>CreateAndRegisterAllocator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp; Ort::Env::CreateAndRegisterAllocator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> *&#160;</td>
<td class="paramname"><em>mem_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group___global.html#gacd8d2ea2ab8f4063d8d85dc0edc461e7">OrtArenaCfg</a> *&#160;</td>
<td class="paramname"><em>arena_cfg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a6a0ca4d136819eafea7d87e7f87a82db" title="Create an allocator and register it with the OrtEnv.">OrtApi::CreateAndRegisterAllocator</a>. </p>
</div>
</div>
<a id="afc9b2d44c9db7812787904d5e3018f24" name="afc9b2d44c9db7812787904d5e3018f24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc9b2d44c9db7812787904d5e3018f24">&#9670;&nbsp;</a></span>DisableTelemetryEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp; Ort::Env::DisableTelemetryEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a74a22efe6571fe538e60f677654ae01f" title="Disable Telemetry.">OrtApi::DisableTelemetryEvents</a>. </p>
</div>
</div>
<a id="a251b84b1a06a0d5f3f1cfa0d2591c033" name="a251b84b1a06a0d5f3f1cfa0d2591c033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a251b84b1a06a0d5f3f1cfa0d2591c033">&#9670;&nbsp;</a></span>EnableTelemetryEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_ort_1_1_env.html">Env</a> &amp; Ort::Env::EnableTelemetryEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#a5906120ee76cca5e8f560e6e8a3fd85c" title="Enable Telemetry.">OrtApi::EnableTelemetryEvents</a>. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_ort.html">Ort</a></li><li class="navelem"><a class="el" href="struct_ort_1_1_env.html">Env</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink