AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doxygen HTML

Browse Source
This commit is contained in:
Ben Sander
2016-02-18 20:43:03 -06:00
parent 5ea8543d2e
commit 129088992b
95 changed files with 2624 additions and 1544 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/RuntimeAPI/html/hip__texture_8h_source.html
+29 -25
View File
@@ -4,7 +4,7 @@
<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.6"/>
<title>HIP: Heterogenous-computing Interface for Portability: /home/fpadmin/ben/HIP6/include/hcc_detail/hip_texture.h Source File</title>
<title>HIP: Heterogenous-computing Interface for Portability: /home/bensander/HIP.public/include/hcc_detail/hip_texture.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>
@@ -89,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="title">hip_texture.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<a href="hip__texture_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">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">Copyright (c) 2015-2016 Advanced Micro Devices, Inc. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
@@ -112,7 +112,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;limits.h&gt;</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;limits.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="hcc__detail_2hip__runtime_8h.html">hip_runtime.h</a>&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
@@ -125,18 +125,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">int</span> _dummy;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;} <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> hipTextureReadMode </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94"> 41</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94">hipTextureReadMode</a></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; hipReadModeElementType, </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;} hipTextureReadMode;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94a829645801202174d052d667ffa4e1b8d"> 43</a></span>&#160; <a class="code" href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94a829645801202174d052d667ffa4e1b8d">hipReadModeElementType</a>, </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;} <a class="code" href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94">hipTextureReadMode</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> hipTextureFilterMode </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6"> 47</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6">hipTextureFilterMode</a></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; hipFilterModePoint, </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} hipTextureFilterMode;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6a56ede038ab7c805ec4b5b61d2b678dfc"> 49</a></span>&#160; <a class="code" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6a56ede038ab7c805ec4b5b61d2b678dfc">hipFilterModePoint</a>, </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} <a class="code" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6">hipTextureFilterMode</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structtextureReference.html"> 53</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structtextureReference.html">textureReference</a> {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; hipTextureFilterMode filterMode;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6">hipTextureFilterMode</a> filterMode;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">bool</span> normalized;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> channelDesc;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;};</div>
@@ -160,7 +160,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment">// These are C++ APIs - maybe belong in separate file.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"></span><span class="comment">// C API:</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="preprocessor">#if 0</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor"></span><a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset, <span class="keyword">struct</span> <a class="code" href="structtextureReference.html">textureReference</a> *tex, <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> *desc, <span class="keywordtype">size_t</span> size=UINT_MAX) </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor"></span><a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset, <span class="keyword">struct</span> <a class="code" href="structtextureReference.html">textureReference</a> *tex, <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> *desc, <span class="keywordtype">size_t</span> size=UINT_MAX)</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;{</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; tex-&gt;_dataPtr = devPtr;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;}</div>
@@ -171,7 +171,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment">// TODO</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> hipCreateChannelDesc() </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> hipCreateChannelDesc()</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;{</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> desc;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">return</span> desc;</div>
@@ -182,11 +182,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment">// TODO-doc</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keywordtype">int</span> dim, enum hipTextureReadMode readMode&gt;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<a class="code" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset, </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">struct</span> <a class="code" href="structtexture.html">texture&lt;T, dim, readMode&gt;</a> &amp;tex, </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr, </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> *desc, </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">size_t</span> size=UINT_MAX) </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<a class="code" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">struct</span> <a class="code" href="structtexture.html">texture&lt;T, dim, readMode&gt;</a> &amp;tex,</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr,</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> *desc,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">size_t</span> size=UINT_MAX)</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;{</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; tex._dataPtr = <span class="keyword">static_cast&lt;</span><span class="keyword">const </span>T*<span class="keyword">&gt;</span>(devPtr);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div>
@@ -199,10 +199,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="comment">// TODO-doc</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keywordtype">int</span> dim, enum hipTextureReadMode readMode&gt;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<a class="code" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset, </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">struct</span> <a class="code" href="structtexture.html">texture&lt;T, dim, readMode&gt;</a> &amp;tex, </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr, </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">size_t</span> size=UINT_MAX) </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<a class="code" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipBindTexture(<span class="keywordtype">size_t</span> *offset,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">struct</span> <a class="code" href="structtexture.html">texture&lt;T, dim, readMode&gt;</a> &amp;tex,</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span> *devPtr,</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">size_t</span> size=UINT_MAX)</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;{</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordflow">return</span> hipBindTexture(offset, tex, devPtr, &amp;tex.channelDesc, size);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;}</div>
@@ -224,16 +224,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment">// doxygen end Texture</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment"></span><span class="comment">// End doxygen API:</span></div>
<div class="ttc" id="group__GlobalDefs_html_ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063"><div class="ttname"><a href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063">hipSuccess</a></div><div class="ttdoc">Successful completion. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:113</div></div>
<div class="ttc" id="hip__texture_8h_html_a442e950774f7306dc33692e358c92c94a829645801202174d052d667ffa4e1b8d"><div class="ttname"><a href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94a829645801202174d052d667ffa4e1b8d">hipReadModeElementType</a></div><div class="ttdef"><b>Definition:</b> hip_texture.h:43</div></div>
<div class="ttc" id="group__GlobalDefs_html_ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063"><div class="ttname"><a href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063">hipSuccess</a></div><div class="ttdoc">Successful completion. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:115</div></div>
<div class="ttc" id="hip__texture_8h_html_aa2f0b6002b81d0a43a808cb880bb21e6a56ede038ab7c805ec4b5b61d2b678dfc"><div class="ttname"><a href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6a56ede038ab7c805ec4b5b61d2b678dfc">hipFilterModePoint</a></div><div class="ttdef"><b>Definition:</b> hip_texture.h:49</div></div>
<div class="ttc" id="structtextureReference_html"><div class="ttname"><a href="structtextureReference.html">textureReference</a></div><div class="ttdef"><b>Definition:</b> hip_texture.h:53</div></div>
<div class="ttc" id="hcc__detail_2hip__runtime_8h_html"><div class="ttname"><a href="hcc__detail_2hip__runtime_8h.html">hip_runtime.h</a></div></div>
<div class="ttc" id="group__GlobalDefs_html_gadf5010f6e140a53ecbdf949e73e87594"><div class="ttname"><a href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a></div><div class="ttdeci">hipError_t</div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:112</div></div>
<div class="ttc" id="hcc__detail_2hip__runtime_8h_html"><div class="ttname"><a href="hcc__detail_2hip__runtime_8h.html">hip_runtime.h</a></div><div class="ttdoc">Contains definitions of APIs for HIP runtime. </div></div>
<div class="ttc" id="group__GlobalDefs_html_gadf5010f6e140a53ecbdf949e73e87594"><div class="ttname"><a href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a></div><div class="ttdeci">hipError_t</div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:114</div></div>
<div class="ttc" id="hip__texture_8h_html_a442e950774f7306dc33692e358c92c94"><div class="ttname"><a href="hip__texture_8h.html#a442e950774f7306dc33692e358c92c94">hipTextureReadMode</a></div><div class="ttdeci">hipTextureReadMode</div><div class="ttdef"><b>Definition:</b> hip_texture.h:41</div></div>
<div class="ttc" id="hip__texture_8h_html_aa2f0b6002b81d0a43a808cb880bb21e6"><div class="ttname"><a href="hip__texture_8h.html#aa2f0b6002b81d0a43a808cb880bb21e6">hipTextureFilterMode</a></div><div class="ttdeci">hipTextureFilterMode</div><div class="ttdef"><b>Definition:</b> hip_texture.h:47</div></div>
<div class="ttc" id="structhipChannelFormatDesc_html"><div class="ttname"><a href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a></div><div class="ttdef"><b>Definition:</b> hip_texture.h:36</div></div>
<div class="ttc" id="structtexture_html"><div class="ttname"><a href="structtexture.html">texture</a></div><div class="ttdef"><b>Definition:</b> hip_texture.h:60</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 25 2016 16:05:53 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>