aboutsummaryrefslogtreecommitdiff
path: root/doc/html/struct_n_v_g_s_d_k___highlight.html
blob: 5467def7ad1e12b455cbe5584d11ead479274e78 (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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<!-- 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.11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVIDIAGeForceExperienceSDK: NVGSDK_Highlight 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>
<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);
  $(window).load(resizeHeight);
</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>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </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('struct_n_v_g_s_d_k___highlight.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="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_n_v_g_s_d_k___highlight-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">NVGSDK_Highlight Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="highlights__types_8h_source.html">highlights_types.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1f95d7645df3e535efa830685488ae9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f95d7645df3e535efa830685488ae9b"></a>
char const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a1f95d7645df3e535efa830685488ae9b">id</a></td></tr>
<tr class="memdesc:a1f95d7645df3e535efa830685488ae9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique id for game event. Max length NVGSDK_MAX_LENGTH - 1. <br /></td></tr>
<tr class="separator:a1f95d7645df3e535efa830685488ae9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0d5a1ba9081cb7f9b549499af61927"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a9e0d5a1ba9081cb7f9b549499af61927">userInterest</a></td></tr>
<tr class="separator:a9e0d5a1ba9081cb7f9b549499af61927"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e55e8efeca6cfabc9c68583e24f410b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e55e8efeca6cfabc9c68583e24f410b"></a>
NVGSDK_HighlightType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a1e55e8efeca6cfabc9c68583e24f410b">highlightTags</a></td></tr>
<tr class="memdesc:a1e55e8efeca6cfabc9c68583e24f410b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tags for this highlight. <br /></td></tr>
<tr class="separator:a1e55e8efeca6cfabc9c68583e24f410b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ecee6a0bd80c21b630559fb8ecfc0be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ecee6a0bd80c21b630559fb8ecfc0be"></a>
NVGSDK_HighlightSignificance&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a3ecee6a0bd80c21b630559fb8ecfc0be">significance</a></td></tr>
<tr class="memdesc:a3ecee6a0bd80c21b630559fb8ecfc0be"><td class="mdescLeft">&#160;</td><td class="mdescRight">How significant the highlight is. <br /></td></tr>
<tr class="separator:a3ecee6a0bd80c21b630559fb8ecfc0be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aa8849a5921b0189c2642840c257247"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_n_v_g_s_d_k___localized_pair.html">NVGSDK_LocalizedPair</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a3aa8849a5921b0189c2642840c257247">nameTable</a></td></tr>
<tr class="separator:a3aa8849a5921b0189c2642840c257247"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5522ae0afe385ba7d17afd83d19ed729"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5522ae0afe385ba7d17afd83d19ed729"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_n_v_g_s_d_k___highlight.html#a5522ae0afe385ba7d17afd83d19ed729">nameTableSize</a></td></tr>
<tr class="memdesc:a5522ae0afe385ba7d17afd83d19ed729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of entries in the localeNameTable */. <br /></td></tr>
<tr class="separator:a5522ae0afe385ba7d17afd83d19ed729"><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>Possible highlights that can occur during gameplay </p>

<p>Definition at line <a class="el" href="highlights__types_8h_source.html#l00023">23</a> of file <a class="el" href="highlights__types_8h_source.html">highlights_types.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9e0d5a1ba9081cb7f9b549499af61927"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool NVGSDK_Highlight::userInterest</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Boolean, whether the player is interested in this event. User can change this setting. This value provides the default. </p>

<p>Definition at line <a class="el" href="highlights__types_8h_source.html#l00026">26</a> of file <a class="el" href="highlights__types_8h_source.html">highlights_types.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3aa8849a5921b0189c2642840c257247"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_n_v_g_s_d_k___localized_pair.html">NVGSDK_LocalizedPair</a>* NVGSDK_Highlight::nameTable</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>An array of locale-highlightName pairs for the user-facing highlight name. If no names are given, the highlight id will be used as the "name" </p>

<p>Definition at line <a class="el" href="highlights__types_8h_source.html#l00030">30</a> of file <a class="el" href="highlights__types_8h_source.html">highlights_types.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/u/workspace/dev/sdkwinauto/sdkclient/include/gfesdk/highlights/<a class="el" href="highlights__types_8h_source.html">highlights_types.h</a></li>
</ul>
</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="struct_n_v_g_s_d_k___highlight.html">NVGSDK_Highlight</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    doxygen</a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>