aboutsummaryrefslogtreecommitdiff
path: root/doc/html/isdk__cpp_8h_source.html
blob: f715b4cc71822bb9ef9d49f55844856fb1beb98c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!-- HTML header for doxygen 1.8.12-->
<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVIDIAGeForceExperienceSDK: C:/u/workspace/dev/sdkwinauto/sdkclient/include/gfesdk/bindings/cpp/isdk_cpp.h Source File</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="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>
<script type="text/javascript">
  $(document).ready(initResizable);
</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" />
<link href="customdoxygen.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">NVIDIAGeForceExperienceSDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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 -->
<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">
$(document).ready(function(){initNavTree('isdk__cpp_8h_source.html','');});
</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="headertitle">
<div class="title">isdk_cpp.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="isdk__cpp_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">* NVIDIA CORPORATION and its licensors retain all intellectual property</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">* and proprietary rights in and to this software, related documentation</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">* and any modifications thereto.  Any use, reproduction, disclosure or</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">* distribution of this software and related documentation without an express</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">* license agreement from NVIDIA CORPORATION is strictly prohibited.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#ifndef GFESDK_ISDK_CPP_H</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#define GFESDK_ISDK_CPP_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;sdk_types_cpp.h&quot;</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_gfe_s_d_k.html">GfeSDK</a></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">// Avoid polluting global namespace with C api, so put it inside namespace</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="isdk_8h.html">gfesdk/isdk.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// Static functions that don&#39;t depend on an instance of the SDK</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">// Giving an alias to these to remove the NVGSDK_ prefix in lieu of the namespace</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="isdk__cpp_8h.html#aca57904e581afc0d04f28ad2cc48fa51">   28</a></span>&#160;<span class="comment"></span><span class="keyword">inline</span> NVGSDK_RetCode <a class="code" href="isdk__cpp_8h.html#aca57904e581afc0d04f28ad2cc48fa51">SetFileLogLevel</a>(<a class="code" href="sdk__types_8h.html#a8ad6f8cbc3c4ba6587912a4a4638d857">NVGSDK_LogLevel</a> level) { <span class="keywordflow">return</span> <a class="code" href="isdk_8h.html#a823df4f563527040a016bab8298869c5">NVGSDK_SetLogLevel</a>(level); }</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="isdk__cpp_8h.html#af7f1de849500cddff35ca621325d41d9">   30</a></span>&#160;<span class="keyword">inline</span> NVGSDK_RetCode <a class="code" href="isdk__cpp_8h.html#af7f1de849500cddff35ca621325d41d9">AttachLogListener</a>(<a class="code" href="sdk__types_8h.html#afdec7c9f24e19fb84c5faf34d77e9312">NVGSDK_LoggingCallback</a> callback) { <span class="keywordflow">return</span> <a class="code" href="isdk_8h.html#afc7b2b775f0ffaf80b2b5a988c4d6d11">NVGSDK_AttachLogListener</a>(callback); }</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="isdk__cpp_8h.html#a9f469173f8579e97de20cfa4d929476d">   32</a></span>&#160;<span class="keyword">inline</span> NVGSDK_RetCode <a class="code" href="isdk__cpp_8h.html#a9f469173f8579e97de20cfa4d929476d">SetListenerLogLevel</a>(<a class="code" href="sdk__types_8h.html#a8ad6f8cbc3c4ba6587912a4a4638d857">NVGSDK_LogLevel</a> level) { <span class="keywordflow">return</span> <a class="code" href="isdk_8h.html#a742af01ab93d41b3aa9579df90c6c00f">NVGSDK_SetListenerLogLevel</a>(level); }</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="isdk__cpp_8h.html#affb721d409d4d0153c8e6b7d0fdce243">   34</a></span>&#160;<span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="isdk__cpp_8h.html#affb721d409d4d0153c8e6b7d0fdce243">RetCodeToString</a>(NVGSDK_RetCode rc) { <span class="keywordflow">return</span> NVGSDK_RetCodeToString(rc); }</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_gfe_s_d_k_1_1_core.html">   37</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_gfe_s_d_k_1_1_core.html">Core</a></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keyword">static</span> <a class="code" href="class_gfe_s_d_k_1_1_core.html">Core</a>* <a class="code" href="class_gfe_s_d_k_1_1_core.html#a0cb93acb8b273072cd37348c9b206e0d">Create</a>(<a class="code" href="struct_gfe_s_d_k_1_1_create_input_params.html">CreateInputParams</a> <span class="keyword">const</span>&amp;, <a class="code" href="struct_gfe_s_d_k_1_1_create_response.html">CreateResponse</a>&amp;);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="class_gfe_s_d_k_1_1_core.html">Core</a>() {}</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keyword">virtual</span> NVGSDK_RetCode <a class="code" href="class_gfe_s_d_k_1_1_core.html#a4804109b7488f52ce61b0b3d638d30fe">Poll</a>(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_core.html#ada940c792737e3fa2c6cc5cda81424b5">RequestPermissionsAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_request_permissions_params.html">RequestPermissionsParams</a> <span class="keyword">const</span>&amp;, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_core.html#ad8edbad0bf465ba656bb99353d4f2122">GetUILanguageAsync</a>(TGetUILanguageCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="comment">// Return the C API handle;</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keyword">virtual</span> NVGSDK_HANDLE* GetHandle() = 0;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;};</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;}</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">#endif //GFESDK_ISDK_CPP_H</span></div><div class="ttc" id="class_gfe_s_d_k_1_1_core_html_ad8edbad0bf465ba656bb99353d4f2122"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html#ad8edbad0bf465ba656bb99353d4f2122">GfeSDK::Core::GetUILanguageAsync</a></div><div class="ttdeci">virtual void GetUILanguageAsync(TGetUILanguageCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="isdk__cpp_8h_html_a9f469173f8579e97de20cfa4d929476d"><div class="ttname"><a href="isdk__cpp_8h.html#a9f469173f8579e97de20cfa4d929476d">GfeSDK::SetListenerLogLevel</a></div><div class="ttdeci">NVGSDK_RetCode SetListenerLogLevel(NVGSDK_LogLevel level)</div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00032">isdk_cpp.h:32</a></div></div>
<div class="ttc" id="isdk__cpp_8h_html_affb721d409d4d0153c8e6b7d0fdce243"><div class="ttname"><a href="isdk__cpp_8h.html#affb721d409d4d0153c8e6b7d0fdce243">GfeSDK::RetCodeToString</a></div><div class="ttdeci">const char * RetCodeToString(NVGSDK_RetCode rc)</div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00034">isdk_cpp.h:34</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_create_response_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_create_response.html">GfeSDK::CreateResponse</a></div><div class="ttdoc">C++ binding for NVGSDK_CreateResponse. </div><div class="ttdef"><b>Definition:</b> <a href="sdk__types__cpp_8h_source.html#l00060">sdk_types_cpp.h:60</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_core_html_ada940c792737e3fa2c6cc5cda81424b5"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html#ada940c792737e3fa2c6cc5cda81424b5">GfeSDK::Core::RequestPermissionsAsync</a></div><div class="ttdeci">virtual void RequestPermissionsAsync(RequestPermissionsParams const &amp;, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="isdk_8h_html_afc7b2b775f0ffaf80b2b5a988c4d6d11"><div class="ttname"><a href="isdk_8h.html#afc7b2b775f0ffaf80b2b5a988c4d6d11">NVGSDK_AttachLogListener</a></div><div class="ttdeci">NVGSDK_EXPORT NVGSDK_RetCode NVGSDKApi NVGSDK_AttachLogListener(NVGSDK_LoggingCallback callback)</div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_request_permissions_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_request_permissions_params.html">GfeSDK::RequestPermissionsParams</a></div><div class="ttdef"><b>Definition:</b> <a href="sdk__types__cpp_8h_source.html#l00051">sdk_types_cpp.h:51</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_core_html_a4804109b7488f52ce61b0b3d638d30fe"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html#a4804109b7488f52ce61b0b3d638d30fe">GfeSDK::Core::Poll</a></div><div class="ttdeci">virtual NVGSDK_RetCode Poll(void)=0</div></div>
<div class="ttc" id="isdk_8h_html"><div class="ttname"><a href="isdk_8h.html">isdk.h</a></div></div>
<div class="ttc" id="isdk__cpp_8h_html_aca57904e581afc0d04f28ad2cc48fa51"><div class="ttname"><a href="isdk__cpp_8h.html#aca57904e581afc0d04f28ad2cc48fa51">GfeSDK::SetFileLogLevel</a></div><div class="ttdeci">NVGSDK_RetCode SetFileLogLevel(NVGSDK_LogLevel level)</div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00028">isdk_cpp.h:28</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_create_input_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_create_input_params.html">GfeSDK::CreateInputParams</a></div><div class="ttdef"><b>Definition:</b> <a href="sdk__types__cpp_8h_source.html#l00037">sdk_types_cpp.h:37</a></div></div>
<div class="ttc" id="sdk__types_8h_html_afdec7c9f24e19fb84c5faf34d77e9312"><div class="ttname"><a href="sdk__types_8h.html#afdec7c9f24e19fb84c5faf34d77e9312">NVGSDK_LoggingCallback</a></div><div class="ttdeci">void(__stdcall * NVGSDK_LoggingCallback)(NVGSDK_LogLevel level, char const *message)</div><div class="ttdef"><b>Definition:</b> <a href="sdk__types_8h_source.html#l00058">sdk_types.h:58</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_core_html"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html">GfeSDK::Core</a></div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00037">isdk_cpp.h:37</a></div></div>
<div class="ttc" id="namespace_gfe_s_d_k_html"><div class="ttname"><a href="namespace_gfe_s_d_k.html">GfeSDK</a></div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00016">highlights_types_cpp.h:16</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_core_html_a0cb93acb8b273072cd37348c9b206e0d"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html#a0cb93acb8b273072cd37348c9b206e0d">GfeSDK::Core::Create</a></div><div class="ttdeci">static Core * Create(CreateInputParams const &amp;, CreateResponse &amp;)</div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp__impl_8h_source.html#l00064">isdk_cpp_impl.h:64</a></div></div>
<div class="ttc" id="isdk__cpp_8h_html_af7f1de849500cddff35ca621325d41d9"><div class="ttname"><a href="isdk__cpp_8h.html#af7f1de849500cddff35ca621325d41d9">GfeSDK::AttachLogListener</a></div><div class="ttdeci">NVGSDK_RetCode AttachLogListener(NVGSDK_LoggingCallback callback)</div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00030">isdk_cpp.h:30</a></div></div>
<div class="ttc" id="sdk__types_8h_html_a8ad6f8cbc3c4ba6587912a4a4638d857"><div class="ttname"><a href="sdk__types_8h.html#a8ad6f8cbc3c4ba6587912a4a4638d857">NVGSDK_LogLevel</a></div><div class="ttdeci">NVGSDK_LogLevel</div><div class="ttdef"><b>Definition:</b> <a href="sdk__types_8h_source.html#l00039">sdk_types.h:39</a></div></div>
<div class="ttc" id="isdk_8h_html_a823df4f563527040a016bab8298869c5"><div class="ttname"><a href="isdk_8h.html#a823df4f563527040a016bab8298869c5">NVGSDK_SetLogLevel</a></div><div class="ttdeci">NVGSDK_EXPORT NVGSDK_RetCode NVGSDKApi NVGSDK_SetLogLevel(NVGSDK_LogLevel fileLevel)</div></div>
<div class="ttc" id="isdk_8h_html_a742af01ab93d41b3aa9579df90c6c00f"><div class="ttname"><a href="isdk_8h.html#a742af01ab93d41b3aa9579df90c6c00f">NVGSDK_SetListenerLogLevel</a></div><div class="ttdeci">NVGSDK_EXPORT NVGSDK_RetCode NVGSDKApi NVGSDK_SetListenerLogLevel(NVGSDK_LogLevel level)</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_4522e853adfb3285c34ceee6be627ffe.html">sdkclient</a></li><li class="navelem"><a class="el" href="dir_37f49c9d6a230916a5077fbd270eac2a.html">include</a></li><li class="navelem"><a class="el" href="dir_eb56eea0ff74c30c2a48b22915222057.html">gfesdk</a></li><li class="navelem"><a class="el" href="dir_f78f74a3131a0cfd456c5ed856861cff.html">bindings</a></li><li class="navelem"><a class="el" href="dir_ab8ba62fc8fdaf78364406bae0a66d43.html">cpp</a></li><li class="navelem"><a class="el" href="isdk__cpp_8h.html">isdk_cpp.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    doxygen</a> 1.8.12 </li>
  </ul>
</div>
</body>
</html>