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
github-actions[bot] 864d51d4b6
[Automated]: Update C/C++ API docs (#14568) 
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Co-authored-by: natke <natke@users.noreply.github.com>
2023-02-03 17:20:27 -08:00

493 lines
34 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen -->
<!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.6"/>
<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 type="text/javascript">"use strict"; 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.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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>
<div class="dynheader">
Inheritance diagram for Ort::Env:</div>
<div class="dyncontent">
<div class="center">
<img src="struct_ort_1_1_env.png" usemap="#Ort::Env_map" alt=""/>
<map id="Ort::Env_map" name="Ort::Env_map">
<area href="struct_ort_1_1detail_1_1_base.html" alt="Ort::detail::Base&lt; OrtEnv &gt;" shape="rect" coords="0,0,164,24"/>
</map>
</div></div>
<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. <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>. <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>. <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>. <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>. <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. <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>. <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>. <br /></td></tr>
<tr class="separator:afc9b2d44c9db7812787904d5e3018f24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae86a59c3a431a31081bf62e46aa29425"><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#ae86a59c3a431a31081bf62e46aa29425">UpdateEnvWithCustomLogLevel</a> (<a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a> log_severity_level)</td></tr>
<tr class="memdesc:ae86a59c3a431a31081bf62e46aa29425"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wraps <a class="el" href="struct_ort_api.html#abef280c1bf4ef5a1627f76d929d56ada">OrtApi::UpdateEnvWithCustomLogLevel</a>. <br /></td></tr>
<tr class="separator:ae86a59c3a431a31081bf62e46aa29425"><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>. <br /></td></tr>
<tr class="separator:ace62e9a1fe461a42a0b1cc79ee40f421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_struct_ort_1_1detail_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_struct_ort_1_1detail_1_1_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="struct_ort_1_1detail_1_1_base.html">Ort::detail::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:a4e1e8b70ad961418f80b41a4c37429f6 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a4e1e8b70ad961418f80b41a4c37429f6">Base</a> ()=default</td></tr>
<tr class="separator:a4e1e8b70ad961418f80b41a4c37429f6 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8072f7970ea1835bddf9aa5038d972b4 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a8072f7970ea1835bddf9aa5038d972b4">Base</a> (<a class="el" href="struct_ort_1_1detail_1_1_base.html#adac6328b9d9b37cddd94f6b21bebee74">contained_type</a> *p) noexcept</td></tr>
<tr class="separator:a8072f7970ea1835bddf9aa5038d972b4 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f40aacd24f0ba79db2dae8165930498 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a7f40aacd24f0ba79db2dae8165930498">Base</a> (const <a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;)=delete</td></tr>
<tr class="separator:a7f40aacd24f0ba79db2dae8165930498 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36ed2c8723bd744b585c65e214156665 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a36ed2c8723bd744b585c65e214156665">Base</a> (<a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;&amp;v) noexcept</td></tr>
<tr class="separator:a36ed2c8723bd744b585c65e214156665 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd548d8facd5ee95fb8f4f4383fb8bf6 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#acd548d8facd5ee95fb8f4f4383fb8bf6">~Base</a> ()</td></tr>
<tr class="separator:acd548d8facd5ee95fb8f4f4383fb8bf6 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f197409cc84018ee2fe04844f188959 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a8f197409cc84018ee2fe04844f188959">operator=</a> (const <a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;)=delete</td></tr>
<tr class="separator:a8f197409cc84018ee2fe04844f188959 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab10471dad43b6c80043d0714ae6544c9 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#ab10471dad43b6c80043d0714ae6544c9">operator=</a> (<a class="el" href="struct_ort_1_1detail_1_1_base.html">Base</a> &amp;&amp;v) noexcept</td></tr>
<tr class="separator:ab10471dad43b6c80043d0714ae6544c9 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa04e81c6255e5907c49afc2324b80211 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#aa04e81c6255e5907c49afc2324b80211">operator contained_type *</a> () const noexcept</td></tr>
<tr class="separator:aa04e81c6255e5907c49afc2324b80211 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77e438d539c77870789686c70b031802 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1detail_1_1_base.html#adac6328b9d9b37cddd94f6b21bebee74">contained_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#a77e438d539c77870789686c70b031802">release</a> ()</td></tr>
<tr class="memdesc:a77e438d539c77870789686c70b031802 inherit pub_methods_struct_ort_1_1detail_1_1_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relinquishes ownership of the contained C object pointer The underlying object is not destroyed. <br /></td></tr>
<tr class="separator:a77e438d539c77870789686c70b031802 inherit pub_methods_struct_ort_1_1detail_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_1detail_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pub_types_struct_ort_1_1detail_1_1_base')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="struct_ort_1_1detail_1_1_base.html">Ort::detail::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:adac6328b9d9b37cddd94f6b21bebee74 inherit pub_types_struct_ort_1_1detail_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_1detail_1_1_base.html#adac6328b9d9b37cddd94f6b21bebee74">contained_type</a> = <a class="el" href="group___global.html#gaba9072a64b5081cd4d36cca5ef92bd08">OrtEnv</a></td></tr>
<tr class="separator:adac6328b9d9b37cddd94f6b21bebee74 inherit pub_types_struct_ort_1_1detail_1_1_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_struct_ort_1_1detail_1_1_base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_struct_ort_1_1detail_1_1_base')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="struct_ort_1_1detail_1_1_base.html">Ort::detail::Base&lt; OrtEnv &gt;</a></td></tr>
<tr class="memitem:ac618b65a5500fb65b7419b465cfd3d65 inherit pro_attribs_struct_ort_1_1detail_1_1_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ort_1_1detail_1_1_base.html#adac6328b9d9b37cddd94f6b21bebee74">contained_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_1_1detail_1_1_base.html#ac618b65a5500fb65b7419b465cfd3d65">p_</a></td></tr>
<tr class="separator:ac618b65a5500fb65b7419b465cfd3d65 inherit pro_attribs_struct_ort_1_1detail_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;&#160;</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;&#160;</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;&#160;</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;&#160;</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;&#160;</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;&#160;</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;&#160;</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;&#160;</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;&#160;</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>
<a id="ae86a59c3a431a31081bf62e46aa29425" name="ae86a59c3a431a31081bf62e46aa29425"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae86a59c3a431a31081bf62e46aa29425">&#9670;&#160;</a></span>UpdateEnvWithCustomLogLevel()</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::UpdateEnvWithCustomLogLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___global.html#ga1c0fbcf614dbd0e2c272ae1cc04c629c">OrtLoggingLevel</a>&#160;</td>
<td class="paramname"><em>log_severity_level</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wraps <a class="el" href="struct_ort_api.html#abef280c1bf4ef5a1627f76d929d56ada">OrtApi::UpdateEnvWithCustomLogLevel</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.6 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink